@pioneer-platform/swapkit-client 0.0.2

package/docs/docs.md

@@ -0,0 +1,1508 @@
+# Introduction
+
+Our API aggregates several key providers and protocols, offering access to an extensive range of chains and tokens without the complexity of managing multiple integrations. It is designed to integrate cross-chain swaps into your application with ease in addition to in-chain dex aggregation for single-chain swaps.
+
+### How to use SwapKit's API
+
+To get the most out of SwapKit's API we recommend going through the endpoints in the following order:
+
+1. **`/providers`** – Retrieve a list of available providers and their supported chains.
+2. **`/tokens`** – Fetch a list of supported tokens across different chains and providers.
+3. **`/quote`** – Request a swap quote to estimate the cost and parameters for a transaction.
+4. **`/track`** – Track the status of a swap to monitor its progress and completion.
+
+However, `/providers` and `/tokens` don't change often, and you can directly request a quote once you have everything set up.\
+Additionally, the `/screen` endpoint can be used to validate AML compliance of the involved addresses. If it is something you need, use it before the transaction is offered for signing and not with every `/quote`.\
+You can try the API yourself at <https://api.swapkit.dev/docs/> . \
+You can also check out our transaction tracking interface at <https://track.swapkit.dev/>.\
+Please read over our recommended [quote implementation flow](https://docs.swapkit.dev/swapkit-api/quote-implementation-flow) to understand how to create a better performing integration.
+
+
+# Swap Types
+
+SwapKit supports three distinct swap mechanisms, each serving different use cases and offering unique advantages.
+
+### Cross-Chain Swaps
+
+Cross-chain swaps enable direct asset exchanges between different blockchain networks in a single transaction. These swaps are powered by specialized cross-chain protocols that act as bridges between otherwise isolated blockchains and cover the major tokens on those chains.
+
+#### Available Providers
+
+SwapKit integrates with four major cross-chain swap providers:
+
+* THORChain
+* NEAR
+* Chainflip
+* Maya Chain
+
+Each provider offers different chain coverage, you can see more information on this [here](https://docs.swapkit.dev/swapkits-trade-offerings).
+
+### Single-Chain Swaps
+
+Single-chain swaps occur within a single blockchain ecosystem, leveraging decentralized exchanges (DEXs) and aggregators to find the best rates for token swaps on that specific chain.
+
+#### Current Provider
+
+* 1inch, available on:
+    * Ethereum (ETH)
+    * Avalanche (AVAX)
+    * Arbitrum (ARB)
+    * BNB Smart Chain (BSC)
+* Jupiter, available on Solana (SOL)
+
+For a complete list of supported tokens on each chain, query the `/tokens` endpoint.
+
+### Cross-Chain DEX Aggregation
+
+Some tokens other than the gas assets like ETH, BNB or AVAX are available through our cross-chain providers, but others like most alt-coins are not. Cross-chain DEX aggregation combines single-chain DEX aggregators with cross-chain protocols to access any token on supported chains. This is achieved through two mechanisms:
+
+#### Swap Ins
+
+Swap ins perform a single-chain swap followed by a cross-chain transfer. This allows users to swap from any token in the source chain into the major tokens in other supported chains.
+
+Swap Ins are currently supported with the combination of 1inch + THORChain (with support for other providers coming soon).
+
+**Supported Networks:** available for swaps initiated on networks where THORChain and 1inch overlap:
+
+* Ethereum (ETH)
+* Avalanche (AVAX)
+* BNB Smart Chain (BSC)
+
+Into any chain supported by THORChain.
+
+#### Swap Outs
+
+Swap outs perform the reverse operation, a cross-chain swap first followed by a single-chain swap on the destination chain.
+
+**Current Status:** **Temporarily Disabled**
+
+### Using the /quote Endpoint
+
+The `/quote` endpoint intelligently routes your swaps through the appropriate providers based on the assets and chains involved.\
+As you delve into our documentation, come back here to understand more about the logic behind integrating Cross-Chain DEX Aggregation.
+
+#### Provider Selection
+
+The `providers` parameter is **optional**. When not specified, the API will:
+
+* Search all available routing paths
+* Return the routes found
+* Include the utilized providers in the response
+
+If you specify the `providers` parameter but it's more restrictive than the available options, you'll receive an error:
+
+```json
+{
+  "error": "noRoutesFound",
+  "message": "No routes found for ETH.CRV-0xD533a949740bb3306d119CC777fa900bA034cd52 -> BTC.BTC",
+  "data": {
+    "sellAsset": "ETH.CRV-0xD533a949740bb3306d119CC777fa900bA034cd52",
+    "buyAsset": "BTC.BTC"
+  }
+}
+```
+
+#### Transaction Data
+
+Include `"includeTx": true` in your request to receive the transaction object needed to execute the swap. The response will include a `legs` array showing each step of the swap process. This example shows a swap-in transaction where:
+
+1. First leg: 1inch converts CRV to ETH on Ethereum
+2. Second leg: THORChain swaps ETH for Bitcoin
+
+{% code overflow="wrap" %}
+
+```json
+"legs": [
+  {
+    "provider": "ONEINCH",
+    "sellAsset": "ETH.CRV-0xD533a949740bb3306d119CC777fa900bA034cd52",
+    "sellAmount": "2000",
+    "buyAsset": "ETH.ETH",
+    "buyAmount": "0.500852152196543104",
+    "buyAmountMaxSlippage": "0.490835109152612241",
+    "fees": [
+      {
+        "type": "inbound",
+        "amount": "0.000251000795472595",
+        "asset": "ETH.ETH",
+        "chain": "ETH",
+        "protocol": "ONEINCH"
+      }
+    ]
+  },
+  {
+    "provider": "THORCHAIN",
+    "sellAsset": "ETH.ETH",
+    "sellAmount": "0.500852152196543104",
+    "buyAsset": "BTC.BTC",
+    "buyAmount": "0.01564204",
+    "buyAmountMaxSlippage": "0.01532919",
+    "fees": [
+      {
+        "type": "liquidity",
+        "amount": "0.00001569",
+        "asset": "BTC.BTC",
+        "chain": "THOR",
+        "protocol": "THORCHAIN"
+      },
+      {
+        "type": "outbound",
+        "amount": "0.00000918",
+        "asset": "BTC.BTC",
+        "chain": "THOR",
+        "protocol": "THORCHAIN"
+      },
+      {
+        "type": "affiliate",
+        "amount": "0",
+        "asset": "BTC.BTC",
+        "chain": "THOR",
+        "protocol": "THORCHAIN"
+      },
+      {
+        "type": "service",
+        "amount": "0.00003137",
+        "asset": "BTC.BTC",
+        "chain": "THOR",
+        "protocol": "THORCHAIN"
+      }
+    ]
+  }
+],
+```
+
+{% endcode %}
+
+# /providers - Request supported chains by a swap provider
+
+The `/providers` endpoint allows users to retrieve a comprehensive list of all available swap providers integrated by SwapKit and their supported chains and metadata. This endpoint does not require any parameters and always returns the full list of providers and their information.
+
+**Method:** `GET`\
+**URL:** `https://api.swapkit.dev/providers`
+
+**Request example:**
+
+```bash
+curl -X 'GET' \
+  'https://api.swapkit.dev/providers' \
+  -H 'accept: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" 
+```
+
+***
+
+### Response structure
+
+The response contains an array of provider objects. Each object includes the following fields:
+
+* `name` and `provider`: The name of the provider, used by SwapKit to reference it.
+* `keywords`: Relevant keywords for the provider.
+* `count`: Number of supported tokens.
+* `logoURI`: URL to the provider’s logo.
+* `url`: URL to the provider’s token list.
+* `supportedChainIds`: List of supported chain IDs for the provider.
+
+#### Sample provider information
+
+```json
+[
+  {
+    "name": "CHAINFLIP_STREAMING",
+    "provider": "CHAINFLIP_STREAMING",
+    "keywords": [],
+    "count": 10,
+    "logoURI": "https://storage.googleapis.com/token-list-swapkit/images/eth.flip-0x826180541412d574cf1336d22c0c0a287822678a.png",
+    "url": "https://storage.googleapis.com/token-list-swapkit/chainflip_streaming.json",
+    "supportedActions": [
+      "swap"
+    ],
+    "supportedChainIds": [
+      "42161",
+      "bitcoin",
+      "1",
+      "solana"
+    ]
+  },
+  ...
+]
+```
+
+***
+
+### Supported providers
+
+Below is the list of all providers available in the `/providers` response:
+
+```json
+[
+  "THORCHAIN",
+  "THORCHAIN_STREAMING",
+  "CHAINFLIP",
+  "CHAINFLIP_STREAMING",
+  "MAYACHAIN",
+  "MAYACHAIN_STREAMING",
+  "NEAR",
+  "ONEINCH",
+  "PANCAKESWAP",
+  "TRADERJOE_V2",
+  "UNISWAP_V2",
+  "UNISWAP_V3",
+  "CAVIAR_V1",
+  "JUPITER",
+  "CAMELOT_V3"
+]
+```
+
+{% hint style="info" %}
+The Streaming providers split the transaction over time. Transactions take longer to execute but have better pricing, so they offer an overall better trade for larger swaps where slippage may be an issue.
+{% endhint %}
+
+***
+
+### Chain IDs and corresponding names
+
+The `supportedChainIds` field includes a list of chain IDs that each provider supports. The Chain IDs are standard among the crypto space so you may see the chains referenced by them elsewhere too.\
+Below is a table with the chain IDs integrated by SwapKit and their corresponding regular names:
+
+| Chain ID               | Chain Name                |
+| ---------------------- | ------------------------- |
+| `1`                    | Ethereum Mainnet          |
+| `42161`                | Arbitrum One              |
+| `43114`                | Avalanche C-Chain         |
+| `8453`                 | Base                      |
+| `56`                   | Binance Smart Chain (BSC) |
+| `137`                  | Polygon                   |
+| `10`                   | Optimism                  |
+| `100`                  | Gnosis                    |
+| `80094`                | BeraChain                 |
+| `728126428`            | Tron - TRX                |
+| `solana`               | Solana                    |
+| `bitcoin`              | Bitcoin                   |
+| `bitcoincash`          | Bitcoin Cash              |
+| `litecoin`             | Litecoin                  |
+| `ripple`               | XRP - Ripple              |
+| `cosmoshub-4`          | Cosmos Hub                |
+| `near`                 | Near Chain                |
+| `dash`                 | Dash                      |
+| `zcash`                | ZCash                     |
+| `dogecoin`             | Dogecoin                  |
+| `kaiyo-1`              | Kujira                    |
+| `mayachain-mainnet-v1` | MayaChain                 |
+| `radix-mainnet`        | Radix                     |
+| `thorchain-1`          | THORChain                 |
+
+
+
+# /tokens - Request supported tokens by a swap provider
+
+The `/tokens` endpoint provides a list of tokens for a specified provider. This endpoint requires a query parameter to determine which provider's tokens you want to retrieve.
+
+**Method:** `GET`\
+**URL:** `https://api.swapkit.dev/tokens`
+
+#### Example Request
+
+```bash
+curl -X 'GET' \
+  'https://api.swapkit.dev/tokens?provider=CHAINFLIP' \
+  -H 'accept: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE"
+```
+
+***
+
+### Example shortened response
+
+```json
+{
+  "provider": "CHAINFLIP",
+  "name": "CHAINFLIP",
+  "timestamp": "2025-01-11T16:31:04.355Z",
+  "version": {
+    "major": 1,
+    "minor": 0,
+    "patch": 0
+  },
+  "keywords": [],
+  "count": 10,
+  "tokens": [
+    {
+      "chain": "BTC",
+      "chainId": "bitcoin",
+      "ticker": "BTC",
+      "identifier": "BTC.BTC",
+      "symbol": "BTC",
+      "name": "Bitcoin",
+      "decimals": 8,
+      "logoURI": "https://storage.googleapis.com/token-list-swapkit/images/btc.btc.png",
+      "coingeckoId": "bitcoin"
+    },
+    {
+      "chain": "ARB",
+      "chainId": "42161",
+      "ticker": "ETH",
+      "identifier": "ARB.ETH",
+      "symbol": "ETH",
+      "name": "Arbitrum Ether",
+      "decimals": 18,
+      "logoURI": "https://storage.googleapis.com/token-list-swapkit/images/arb.eth.png",
+      "coingeckoId": "ethereum"
+    },
+    {
+      "chain": "SOL",
+      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
+      "chainId": "solana",
+      "ticker": "USDC",
+      "identifier": "SOL.USDC-EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
+      "symbol": "USDC-EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
+      "name": "Solana USDC",
+      "decimals": 6,
+      "logoURI": "https://storage.googleapis.com/token-list-swapkit/images/sol.usdc-epjfwdd5aufqssqem2qn1xzybapc8g4weggkzwytdt1v.png"
+    },
+    ...
+  ]
+}
+```
+
+***
+
+### Response fields
+
+The relevant response fields are:
+
+<table><thead><tr><th width="257">Field</th><th width="102">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>provider</code> and <code>name</code></td><td><code>string</code></td><td>The name of the provider specified in the query.</td></tr><tr><td><code>timestamp</code></td><td><code>string</code></td><td>The timestamp of when the response was generated.</td></tr><tr><td><code>count</code></td><td><code>number</code></td><td>The number of tokens included in the response.</td></tr><tr><td><code>tokens</code></td><td><code>array</code></td><td>An array of token objects, each representing a token available for the specified provider.</td></tr></tbody></table>
+
+#### For each token, information is provided to properly differentiate it from others:
+
+<table><thead><tr><th width="257">Field</th><th width="102">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>chain</code></td><td><code>string</code></td><td>The blockchain the token is associated with (e.g., <code>ETH</code>, <code>BTC</code>, <code>SOL</code>).</td></tr><tr><td><code>address</code></td><td><code>string</code></td><td>The contract address of the token (only provided if it is not the gas token of the network).</td></tr><tr><td><code>chainId</code></td><td><code>string</code></td><td>The ID of the chain. It could be a numeric ID (e.g., <code>42161</code> for Arbitrum) or a name like <code>solana</code>.</td></tr><tr><td><code>ticker</code></td><td><code>string</code></td><td>The ticker symbol of the token (e.g., <code>ETH</code>, <code>BTC</code>).</td></tr><tr><td><code>identifier</code></td><td><code>string</code></td><td>An identifier for the token that combines chain and token address, used to identify the token in SwapKit API.</td></tr><tr><td><code>symbol</code></td><td><code>string</code></td><td>The token symbol, which includes address information.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>The full name of the token.</td></tr><tr><td><code>decimals</code></td><td><code>number</code></td><td>The number of decimal places the token supports.</td></tr><tr><td><code>logoURI</code></td><td><code>string</code></td><td>A URL pointing to the token's logo image.</td></tr><tr><td><code>coingeckoId</code></td><td><code>string</code></td><td>The identifier of the token on CoinGecko (if available).</td></tr></tbody></table>
+
+***
+
+### Notes
+
+* The `identifier` is what SwapKit uses to uniquely identify a token in all its requests and responses. It includes the chain, the name and the token address. It is how the token should be named when using the `/quote`endpoint.
+    * The identifier is built by putting together Chain.Ticker-ContractAddress (e.g., `"ETH.USDC-0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"`).
+    * Gas assets like BTC, ETH or SOL don't require a contract address, so their identifier is just `BTC.BTC`for example.&#x20;
+* Tokens with an `address` field are specific instances of a token on a given chain (e.g., `USDC` on Ethereum or Solana). While the `coingeckoId`could be shared, we provide the relevant contract address for the token in the specific chain.
+
+
+# /quote  - Request a trade quote
+
+### Endpoint
+
+**Method:** `POST`\
+**URL:** `https://api.swapkit.dev/quote`
+
+***
+
+### Request parameters
+
+```json
+{
+  "sellAsset": "string",
+  "buyAsset": "string",
+  "sellAmount": "string",
+  "providers": [
+    "string"
+  ],
+  "sourceAddress": "string",
+  "destinationAddress": "string",
+  "slippage": 100,
+  "affiliate": "string",
+  "affiliateFee": 1000,
+  "allowSmartContractSender": true,
+  "allowSmartContractReceiver": true,
+  "disableSecurityChecks": true,
+  "includeTx": true,
+  "cfBoost": true
+}
+```
+
+Here's a detailed description of the different parameters:
+
+<table data-full-width="false"><thead><tr><th width="230">Parameter</th><th width="110">Type</th><th width="99">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>sellAsset</code></td><td><code>string</code></td><td>✅ Yes</td><td>The asset being sold (e.g. <code>"ETH.ETH"</code>).</td></tr><tr><td><code>buyAsset</code></td><td><code>string</code></td><td>✅ Yes</td><td>The asset being bought (e.g. <code>"BTC.BTC"</code>).</td></tr><tr><td><code>sellAmount</code></td><td><code>string</code></td><td>✅ Yes</td><td>Amount in basic units (decimals separated with a dot).</td></tr><tr><td><code>providers</code></td><td><code>array</code></td><td>❌ No</td><td>Limits the possible liquidity providers.</td></tr><tr><td><code>sourceAddress</code></td><td><code>string</code></td><td>✅ Yes</td><td>Address of the sender.</td></tr><tr><td><code>destinationAddress</code></td><td><code>string</code></td><td>✅ Yes</td><td>Address of the recipient.</td></tr><tr><td><code>slippage</code></td><td><code>number</code></td><td>❌ No</td><td>Max slippage in percentage (5 = 5%).</td></tr><tr><td><code>affiliate</code></td><td><code>string</code></td><td>❌ No</td><td>Affiliate address for revenue sharing.</td></tr><tr><td><code>affiliateFee</code></td><td><code>number</code></td><td>❌ No</td><td>Fee percentage in basis points (50= 0.5%).</td></tr><tr><td><code>allowSmartContractSender</code></td><td><code>boolean</code></td><td>❌ No</td><td>Allow smart contract as sender.</td></tr><tr><td><code>allowSmartContractReceiver</code></td><td><code>boolean</code></td><td>❌ No</td><td>Allow smart contract as receiver.</td></tr><tr><td><code>disableSecurityChecks</code></td><td><code>boolean</code></td><td>❌ No</td><td>Bypass security checks.</td></tr><tr><td><code>includeTx</code></td><td><code>boolean</code></td><td>❌ No</td><td>Include transaction details in the response. Read more about it <a href="quote-implementation-flow">here</a>.</td></tr><tr><td><code>cfBoost</code></td><td><code>boolean</code></td><td>❌ No</td><td>Enables Chainflip boost for better rates.</td></tr></tbody></table>
+
+**Note:** Asset names for `sellAsset` and `buyAsset` should follow the following nomenclature:
+
+* Chain.Asset (e.g., `"BTC.BTC"` or `"ARB.ETH"`)
+* Chain.Asset-ContractAddress (e.g., `"ETH.USDC-0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"`)
+
+This is the `identifier`as provided in the [`/tokens`](https://docs.swapkit.dev/swapkit-api/tokens-request-supported-tokens-by-a-swap-provider) endpoint.
+
+{% hint style="warning" %}
+When you test your integration, use an address with enough `sellAsset` balance to cover the trade. This will ensure you receive complete responses.
+{% endhint %}
+
+***
+
+### Example request
+
+A simple request to trade `ETH.ETH`to `BTC.BTC`may omit the `providers`list if you can manage them in the response, but should include the amount, the involved addresses and slippage settings.
+
+The expiration time returned by the endpoint is an estimation. We recommend requesting a new quote at least every minute if the trade has not been executed yet.
+
+{% hint style="info" %}
+Using the header `x-api-key`in your `/quote`request automatically applies your affiliate addresses and fee values set up through our [partners dashboard](https://docs.swapkit.dev/monetization#step-3-set-affiliate-fee-tiers) in the response parameters.
+{% endhint %}
+
+{% tabs %}
+{% tab title="cURL" %}
+
+```sh
+curl -X POST "https://api.swapkit.dev/quote" \
+  -H "Content-Type: application/json" \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "sellAsset": "ETH.ETH",
+    "buyAsset": "BTC.BTC",
+    "sellAmount": "0.1",
+    "sourceAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
+    "destinationAddress": "357a3So9CbsNfBBgFYACGvxxS6tMaDoa1P",
+    "slippage": 10,
+    "includeTx": true
+  }'
+```
+
+{% endtab %}
+{% endtabs %}
+
+
+# /quote - Implementation flow
+
+An important part of our service is the possibility of including transaction data in a `/quote` response.\
+This option is activated when the "`includeTx": true` request parameter is used, but it is important to keep a proper quote request flow for a better performing integration.
+
+### 1. Initial Quote Request
+
+First, fetch quotes with "`includeTx": false` (or unset, as false is the default). For this step, you may leave out `"sourceAddress"` and `"destinationAddress"` since they are not needed to process a quote:
+
+```bash
+curl -X POST "https://api.swapkit.dev/quote" \
+  -H "Content-Type: application/json" \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "sellAsset": "BTC.BTC",
+    "buyAsset": "ETH.ETH",
+    "sellAmount": "0.1",
+    "slippage": 3,
+    "includeTx": false
+  }'
+```
+
+You can filter for the providers you have integrated using the `"providers"` argument if you want to limit the options shown.
+
+This returns a regular quote response including pricing information, estimated timing and fees, and route details with the available providers, but without transaction data.
+
+### 2. Identify the Provider route you want to use
+
+After offering a price to the user of your application, the user would then accept it. This identifies what provider offers the best match for the route you quoted for.
+
+Before the user gets offered a transaction to sign though, you will request a new quote filtering with this specific provider and requesting a transaction object.
+
+### 3. Transaction Building
+
+When the user is ready to execute the swap, request a new quote with "`includeTx": true` and filtering by provider:
+
+```bash
+curl -X POST "https://api.swapkit.dev/quote" \
+  -H "Content-Type: application/json" \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "sellAsset": "BTC.BTC",
+    "buyAsset": "ETH.ETH",
+    "sellAmount": "0.1",
+    "sourceAddress": "357a3So9CbsNfBBgFYACGvxxS6tMaDoa1P",
+    "destinationAddress": "0x0a4c79cE84202b03e95B7a692E5D728d83C44c76",
+    "providers": ["NEAR"],
+    "slippage": 3,
+    "includeTx": true
+  }'
+```
+
+Setting `includeTx: true` results in slightly slower response times as the system performs additional validations and transaction building. This is why it is also best to now filter the providers used, so only the specific best quote is returned.
+
+The quote response will now include additional transaction related fields, different for each provider. You can show the price to the user again for signing or compare internally to the previous value before offering it:
+
+```json
+{
+  // ... all fields from above, plus:
+  "targetAddress": "1FSHYruFaYjm5FQrzB3LmF15FMC3QwUFmy",
+  "inboundAddress": "1FSHYruFaYjm5FQrzB3LmF15FMC3QwUFmy",
+  "tx": "cHNidP8BAHUCAAAAAc86GvpcKcJoCV1YpX9orAcE/ZckHbLzuTXOPl0McccZAAAAAAD/////AoCWmAAAAAAAGXapFJ5Z+YVfu2g/WM/XGmu9FBGSeS5wiKx/LhEm4wAAABepFFKL8plEPOVGF9/52YVT+SKl3opehwAAAAAAAQEg/8SpJuMAAAAXqRRSi/KZRDzlRhff+dmFU/kipd6KXocAAAA=",
+  "meta": {
+    // ... existing meta fields, plus:
+    "txType": "PSBT"
+  }
+}
+```
+
+***
+
+### Transaction Building Process
+
+When `includeTx: true` is set, the system performs the following validations:
+
+#### 1. Balance Verification
+
+The system first checks if the source address has sufficient balance to cover the `sellAmount`. If insufficient funds are detected, an `insufficientBalance` error is thrown for the entire request.
+
+#### 2. Transaction Building
+
+If the balance check passes, the system attempts to build the transaction. In certain edge cases, the wallet may have enough balance to match the `sellAmount` but insufficient funds to cover network fees. Since different providers have varying transaction sizes, some may return valid transaction data while others might fail with an `unableToBuildTransaction` error.
+
+#### 3. Successful Response
+
+If all validations pass, you'll receive a complete route with transaction data that can be directly signed and broadcast.
+
+### Key Fields
+
+* `targetAddress` The deposit address where funds should be sent, or the address of the contract that should be called.
+* `inboundAddress` The address monitoring for incoming transactions.
+* `tx` The transaction data ready for signing.
+* `txType` The format of the transaction data (e.g., "PSBT" for Bitcoin or "EVM" for EVM chains).
+
+### Error Handling
+
+Be prepared to handle the following errors when using `includeTx: true`:
+
+* `insufficientBalance` The source address doesn't have enough tokens for the swap.
+* `insufficientAllowance`: The source address doesn't have enough tokens approved for the contract interaction. Relevant for tokens in EVM networks.
+* `unableToBuildTransaction` The wallet has sufficient tokens but insufficient funds for network fees.
+
+This is an example error for a wallet without enough balance:
+
+```json
+{
+  "message": "Cannot build transaction. Insufficient balance for asset ETH.USDC-0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 amount 700 address 0x...",
+  "error": "insufficientBalance",
+  "data": {
+    "chain": "ETH.USDC-0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+    "amount": "700",
+    "address": "0x..."
+  }
+}
+```
+
+
+# /quote - Understanding the response
+
+### Response structure
+
+The response lists the available providers for the route, limited by the list used to quote it. If the parameter was not included the response lists all possible providers.\
+Estimated output, expected slippage and estimated time are some of the information listed for each swap provider so you can choose the best routes. Additionally, SwapKit provides tags to aid you in the process and identify what we would consider ourselves.
+
+{% hint style="warning" %}
+When you test your integration, use an address with enough `sellAsset` balance to cover the trade. This will ensure you receive complete responses.
+{% endhint %}
+
+#### **`quoteId`**
+
+A unique identifier for the quote request. You can optionally store it to reference the quote provided by SwapKit at a later date.
+
+***
+
+### `routes` Object
+
+The `routes` array contains possible swap options, each identified by the `providers`object at the start.
+
+<table><thead><tr><th width="304">Field</th><th width="107">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>providers</code></td><td><code>array</code></td><td>List of providers available for this route (<code>CHAINFLIP</code>, <code>THORHCAIN</code>etc.).</td></tr><tr><td><code>sellAsset</code></td><td><code>string</code></td><td>The asset being sold (e.g., <code>"ETH.ETH"</code>).</td></tr><tr><td><code>buyAsset</code></td><td><code>string</code></td><td>The asset being bought (e.g., <code>"BTC.BTC"</code>).</td></tr><tr><td><code>sellAmount</code></td><td><code>string</code></td><td>Amount of the sell asset in smallest units.</td></tr><tr><td><code>expectedBuyAmount</code></td><td><code>string</code></td><td>Estimated amount of the buy asset to be received.</td></tr><tr><td><code>expectedBuyAmountMaxSlippage</code></td><td><code>string</code></td><td>Worst-case buy amount considering max slippage.</td></tr><tr><td><code>sourceAddress</code></td><td><code>string</code></td><td>Source address.</td></tr><tr><td><code>destinationAddress</code></td><td><code>string</code></td><td>Destination address.</td></tr><tr><td><code>targetAdddress</code></td><td><code>string</code></td><td>Address to send the initial transaction to.</td></tr><tr><td><code>approvalAddress</code></td><td><code>string</code></td><td>Address to approve spending to (when swapping tokens on EVM)</td></tr><tr><td><code>memo</code></td><td><code>string</code></td><td>Transaction memo, which can be used in UTXO chains directly.</td></tr><tr><td><code>fees</code></td><td><code>array</code></td><td>List of fees applied to the swap (inbound, network, affiliate).</td></tr><tr><td><code>tx</code></td><td><code>array</code></td><td>Transaction object for EVM chains, a <a href="https://en.bitcoin.it/wiki/BIP_0174">PSBT</a> object for BTC etc.</td></tr><tr><td><code>estimatedTime</code></td><td><code>object</code></td><td>Estimated time for different phases of the swap.</td></tr><tr><td><code>totalSlippageBps</code></td><td><code>number</code></td><td>Expected total slippage.</td></tr><tr><td><code>legs</code></td><td><code>array</code></td><td>The different involved steps in the swap.</td></tr><tr><td><code>warnings</code></td><td><code>array</code></td><td>Potential warnings about this swap provider.</td></tr><tr><td><code>meta</code></td><td><code>array</code></td><td>Other information about the transaction.</td></tr><tr><td><code>priceImpact</code></td><td><code>number</code></td><td>Price impact percentage in USD terms.</td></tr></tbody></table>
+
+* The `tx`object is only provided if the `"includeTx":true`parameter was included. It can be used as the transaction data for EVM chains. It won't be provided if the token to swap is not approved for the `approvalAddress` . It is explained in more detail [here](https://docs.swapkit.dev/swapkit-api/quote-implementation-flow).
+* `targetAddress` is the address to send the transaction to, but Chainflip transactions need to use a [deposit channel](https://docs.swapkit.dev/swapkit-api/chainflip-broker-channel-opening-a-chainflip-deposit-channel) instead and don't require approval.&#x20;
+
+{% hint style="info" %}
+It is necessary to approve `approvalAddress` as an spender if you are swapping tokens on an EVM chain.
+{% endhint %}
+
+In many cases `targetAddress` and `approvalAddress` will be the same but they will differ when using dex aggregation for a cross chain swap (swapping an ERC20 into BTC.BTC for example).
+
+#### **Example `routes` Object:**
+
+```json
+{
+    "providers": ["MAYACHAIN"],
+    "sellAsset": "ETH.ETH",
+    "sellAmount": "0.1",
+    "buyAsset": "BTC.BTC",
+    "expectedBuyAmount": "0.00275103",
+    "expectedBuyAmountMaxSlippage": "0.00247592",
+    "sourceAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
+    "destinationAddress": "357a3So9CbsNfBBgFYACGvxxS6tMaDoa1P",
+    "targetAddress": "0xe3985E6b61b814F7Cdb188766562ba71b446B46d",
+    "inboundAddress": "0x62b54578b77d0ccfe74b4a009d9ecbc82777c9ff",
+    "expiration": "1738931194",
+    "memo": "=:b:357a3So9CbsNfBBgFYACGvxxS6tMaDoa1P:247592:_/sk:20/100",
+    "fees": [{
+        ...
+    }],
+    "tx": {
+        "to": "0xe3985E6b61b814F7Cdb188766562ba71b446B46d",
+        "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
+        "gas": "0x9714",
+        "gasPrice": "0x5be199fd",
+        "value": "100000000000000000",
+        "data": "0x44bc937b00000000000000000000000062b54578b77d0ccfe74b4a009d9ecbc82777c9ff0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000016345785d8a000000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000067a5fbfa00000000000000000000000000000000000000000000000000000000000000393d3a623a3335376133536f394362734e6642426746594143477678785336744d61446f6131503a3234373539323a5f2f736b3a32302f31303000000000000000"
+    },
+    "estimatedTime": {
+        ...
+    },
+    "totalSlippageBps": 246,
+    "legs": [{
+        ...
+    }],
+    "warnings": [],
+    "meta": {
+        ...
+    }
+    "priceImpact": -0.38,
+    "approvalAddress": "0xe3985E6b61b814F7Cdb188766562ba71b446B46d",
+    }
+```
+
+***
+
+### Fees breakdown
+
+Fees are categorized into different types based on their role in the swap process.
+
+<table><thead><tr><th width="297">Fee Type</th><th>Description</th></tr></thead><tbody><tr><td><strong>Inbound</strong></td><td>Fee for transferring the sell asset, paid from the user's wallet.</td></tr><tr><td><strong>Network</strong></td><td>Blockchain transaction fee for processing the swap.</td></tr><tr><td><strong>Affiliate</strong></td><td>Fee paid to the specified affiliate.</td></tr><tr><td><strong>Service</strong></td><td>SwapKit's service fee.</td></tr><tr><td><strong>Outbound</strong></td><td>Fee for transferring the buy asset to the destination address.</td></tr><tr><td><strong>Liquidity</strong></td><td>Fee applied by the liquidity provider to facilitate the swap.</td></tr></tbody></table>
+
+Only the inbound fee will be paid from the source wallet. The other fees are deducted from the output, and the output values provided by the endpoint already take this into consideration.
+
+***
+
+### Transaction details
+
+Transaction details are only included if the option `"includeTx": true` was used in the `/quote`request. It provides an object valid to initiate a transaction in the source chain. These objects can be used so sing and send the transaction using the main libraries for each blockchain.
+
+***
+
+### Estimated time
+
+The estimated time in seconds for the swap is divided into the following phases:
+
+* **Inbound:** Time taken to receive the sell asset.
+* **Swap:** Time taken for the swap process.
+* **Outbound:** Time taken to transfer the bought asset to the destination. This includes the provider outbound time, not only the transaction time.
+* **Total:** The sum of all time estimates.
+
+#### **Example estimated time:**
+
+```json
+"estimatedTime": {
+    "inbound": 30,
+    "swap": 6,
+    "outbound": 624,
+    "total": 660
+}
+```
+
+***
+
+### Transaction metadata
+
+The `meta` section provides additional information about the swap.
+
+| **priceImpact**              | The expected impact on market rates.                                         |
+| ---------------------------- | ---------------------------------------------------------------------------- |
+| **affiliate - affiliateFee** | Details of affiliate commissions.                                            |
+| **tags**                     | \["FASTEST", "RECOMMENDED", "CHEAPEST"]                                      |
+| **approvalAddress**          | The contract address for ERC-20 approvals.                                   |
+| **chainflip**                | Information necessary to open a deposit channel for the Chainflip providers. |
+
+#### **Example `meta` Object:**
+
+```json
+"meta": {
+    "priceImpact": -1.69,
+    "assets": [{
+        "asset": "ETH.ETH",
+        "price": 2752.14,
+        "image": "https://storage.googleapis.com/token-list-swapkit/images/eth.eth.png"
+    }, {
+        "asset": "BTC.BTC",
+        "price": 97648,
+        "image": "https://storage.googleapis.com/token-list-swapkit/images/btc.btc.png"
+    }],
+    "approvalAddress": "0xD37BbE5744D730a1d98d8DC97c42F0Ca46aD7146",
+    "tags": ["FASTEST"],
+    "affiliate": "sk",
+    "affiliateFee": "100",
+    "txType": "EVM"
+}
+```
+
+The `"tags"`can help recognize what SwapKit considers the best routes by filtering through the `["FASTEST", "RECOMMENDED", "CHEAPEST"]` identification.<br>
+
+<table><thead><tr><th width="283">Tag</th><th>Description</th></tr></thead><tbody><tr><td><strong>RECOMMENDED</strong></td><td>Best overall route based on output and speed.</td></tr><tr><td><strong>CHEAPEST</strong></td><td>The route with the maximum output.</td></tr><tr><td><strong>FASTEST</strong></td><td>The route with the shortest total estimated time.</td></tr></tbody></table>
+
+Additionally the `"chainflip"`object is added for `CHAINFLIP` and `CHAINFLIP_STREAMING`swaps. This is used to [open a deposit channel](https://docs.swapkit.dev/swapkit-api/chainflip-broker-channel-opening-a-chainflip-deposit-channel), a necessary step to initiate a trade.
+
+```json
+"chainflip": {
+    "sellAsset": {
+        "chain": "Ethereum",
+        "asset": "ETH"
+    },
+    "buyAsset": {
+        "chain": "Bitcoin",
+        "asset": "BTC"
+    },
+    "destinationAddress": "357a3So9CbsNfBBgFYACGvxxS6tMaDoa1P",
+    "affiliateFees": [{
+        "brokerAddress": "cFNwtr2mPhpUEB5AyJq38DqMKMkSdzaL9548hajN2DRTwh7Mq",
+        "feeBps": 100
+    }],
+    "refundParameters": {
+        "minPrice": "0x2c166186363d48000000000",
+        "refundAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
+        "retryDuration": 150
+    }
+}
+```
+
+***
+
+### Warnings
+
+Warnings highlight potential issues such as high price impact or insufficient liquidity.
+
+#### **Example warning:**
+
+```json
+"warnings": [
+      {
+        "code": "highPriceImpact",
+        "display": "-10%",
+        "tooltip": "This swap has a high value impact given the current liquidity and network fees. There may be a large difference between the amount of your input token and what you will receive in the output token."
+      }
+]
+```
+
+***
+
+### Provider errors
+
+If certain providers cannot facilitate the swap, the response may include error messages under `providerErrors`.
+
+#### **Example provider error:**
+
+```json
+"providerErrors": [{
+    "provider": "CHAINFLIP_STREAMING",
+    "errorCode": "swapAmountTooSmall"
+}]
+```
+
+# /chainflip/broker/channel - Opening a Chainflip deposit channel
+
+To initiate a swap through the `CHAINFLIP`or `CHAINFLIP_STREAMING`providers, a deposit channel must be opened first.
+
+**Method:** `POST`\
+**URL:** `https://api.swapkit.dev/chainflip/broker/channel`
+
+The information needed to open a channel is included inside the `meta.chainflip`object of the `/quote`response, as in the example below. The object needs to be passed to the `/chainflip/broker/channel`endpoint, which creates a deposit channel.\
+It contains a deposit address for the chain initiating the swap, where the tokens can be sent to.
+
+```json
+"meta": {
+    ...
+    "chainflip": {
+        "sellAsset": {
+            "chain": "Ethereum",
+            "asset": "ETH"
+        },
+        "buyAsset": {
+            "chain": "Bitcoin",
+            "asset": "BTC"
+        },
+        "destinationAddress": "357a3So9CbsNfBBgFYACGvxxS6tMaDoa1P",
+        "affiliateFees": [{
+            "brokerAddress": "cFNwtr2mPhpUEB5AyJq38DqMKMkSdzaL9548hajN2DRTwh7Mq",
+            "feeBps": 100
+        }],
+        "refundParameters": {
+            "minPrice": "0x2c166186363d48000000000",
+            "refundAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
+            "retryDuration": 150
+        }
+    }
+}
+```
+
+As an example a channel can be requested as:
+
+{% tabs %}
+{% tab title="cURL" %}
+
+<pre class="language-sh"><code class="lang-sh"><strong>curl -X 'POST' \
+</strong>  'https://api.swapkit.dev/chainflip/broker/channel' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+        "sellAsset": {
+            "chain": "Ethereum",
+            "asset": "ETH"
+        },
+        "buyAsset": {
+            "chain": "Bitcoin",
+            "asset": "BTC"
+        },
+        "destinationAddress": "357a3So9CbsNfBBgFYACGvxxS6tMaDoa1P",
+        "affiliateFees": [{
+            "brokerAddress": "cFNwtr2mPhpUEB5AyJq38DqMKMkSdzaL9548hajN2DRTwh7Mq",
+            "feeBps": 100
+        }],
+        "refundParameters": {
+            "minPrice": "0x2c166186363d48000000000",
+            "refundAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
+            "retryDuration": 150
+        }
+    }'
+</code></pre>
+
+{% endtab %}
+{% endtabs %}
+
+The response contains a `depositAddress`which funds can be sent to.\
+No approval is needed for this address in the case of ERC-20 tokens, and a memo is not needed either.
+
+```json
+{
+    "depositAddress": "0xd3f189d1cab37e5dc1f920639ed13bf61132ab16",
+    "channelId": "6543210-Ethereum-1933",
+    "explorerUrl": "https://scan.chainflip.io/channels/6543210-Ethereum-1984"
+}
+```
+
+***
+
+Here is an example integrating a `/quote`request with opening a channel:
+
+```javascript
+async function swapThroughChainflip () {
+    const request = {
+      sellAsset: "SOL.SOL",
+      buyAsset: "BTC.BTC",
+      sellAmount: "1",
+      providers: ["CHAINFLIP", "CHAINFLIP_STREAMING"],
+      sourceAddress: "sol_address",
+      destinationAddress: "btc_address",
+      slippage: 1.5,
+    };
+
+    const quoteResponse = await fetch('https://api.swapkit.dev/quote', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'x-api-key': apiKey,
+        },
+        body: JSON.stringify(request),
+    });
+
+    const [chainflipRoute, chainflipStreamingRoute] = await quoteResponse.json();
+
+    // Pick deposit channel info from quote response
+
+    const chainflipDepositChannelParams = chainflipRoute.meta.chainflip;
+
+    // Use params to open deposit channel
+
+    const depositChannelResponse = await fetch('https://api.swapkit.dev/chainflip/broker/channel', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'x-api-key': apiKey,
+        },
+        body: JSON.stringify(chainflipDepositChannelParams),
+    });
+
+    const depositChannel = await depositChannelResponse.json();
+
+    
+    const { depositAddress, explorerUrl } = depositChannel;
+    // Send funds to deposit address
+    ...
+
+}
+```
+
+
+# /track - Request the status of a swap
+
+The `/track` endpoint provides real-time status information for a specific transaction. It is particularly useful for tracking the progress and details of swaps, transfers, and other operations. To use this endpoint, you normally provide the **chain ID** and **transaction hash**.\
+For NEAR Intents swaps, you can also call the endpoint with **depositAddress**, which is the address the deposit transaction was sent to.\
+\
+For a complete list of chain IDs used by SwapKit you can [check the table here](https://docs.swapkit.dev/providers-request-supported-chains-by-a-swap-provider#chain-ids-and-corresponding-names).
+
+**Method:** `POST`\
+**URL:** `https://api.swapkit.dev/track`&#x20;
+
+SwapKit has it's own transaction tracking interface here: <https://track.swapkit.dev/>. You can also directly fill the fields by directing users to `https://track.swapkit.dev/?hash={{hash}}` by populating it with the respective transaction hash.
+
+#### Request Body:
+
+<table><thead><tr><th>Field</th><th width="172">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>hash</code></td><td><code>string</code></td><td>Transaction hash (required if using <code>chainId</code>)</td></tr><tr><td><code>chainId</code></td><td><code>string</code></td><td>Chain ID of the transaction (required if using <code>hash</code>)</td></tr><tr><td><code>depositAddress</code></td><td><code>string</code></td><td>Deposit address used to swap with NEAR Intents, can be used instead of <code>hash</code> and <code>chainId</code></td></tr></tbody></table>
+
+NEAR Intents swaps can still be tracked normally indicating the transaction hash of the deposit and the respective chain id. Using `depositAddress` is an additional option but observing executed hashes is easier if users are connected to your application.
+
+#### Example Requests:
+
+<details>
+
+<summary><strong><code>hash</code> and <code>chainId</code></strong></summary>
+
+```bash
+curl -X 'POST' \
+  'https://api.swapkit.dev/track' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_API_KEY_HERE" \
+  -d '{
+  "hash": "0x1890aba1c0b25126892af2ab09f5c1bba75adefc47918a96ea498764ab643ce9",
+  "chainId": "1"
+}'
+```
+
+</details>
+
+<details>
+
+<summary><strong><code>depositAddress</code></strong></summary>
+
+```bash
+curl -X 'POST' \
+  'https://api.swapkit.dev/track' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+  "depositAddress": "0x6f2B69c522031A7640b432172Ac84e57Dc0a3A63"
+}'
+```
+
+</details>
+
+***
+
+### Response
+
+The response contains detailed information about the transaction status, type, and associated metadata. It also includes the array `"legs"` which represent the different stages or components of the transaction.
+
+#### Response Fields:
+
+<table><thead><tr><th width="219">Field</th><th width="119">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>chainId</code></td><td><code>string</code></td><td>The chain ID where the transaction occurred.</td></tr><tr><td><code>hash</code></td><td><code>string</code></td><td>The transaction hash.</td></tr><tr><td><code>block</code></td><td><code>number</code></td><td>The block number where the transaction was included.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>The type of the transaction (e.g., <code>swap</code>, <code>token_transfer</code>).</td></tr><tr><td><code>status</code></td><td><code>string</code></td><td>The transaction status (e.g., <code>completed</code>).<br>We will expand on it <a href="#transaction-status">later</a>.</td></tr><tr><td><code>trackingStatus</code></td><td><code>string</code></td><td>The current tracking status (using <code>status</code> is enough and this field should not be necessary).</td></tr><tr><td><code>fromAsset</code></td><td><code>string</code></td><td>The asset being sent.</td></tr><tr><td><code>fromAmount</code></td><td><code>string</code></td><td>The amount of <code>fromAsset</code>.</td></tr><tr><td><code>fromAddress</code></td><td><code>string</code></td><td>The address sending the asset.</td></tr><tr><td><code>toAsset</code></td><td><code>string</code></td><td>The asset being received.</td></tr><tr><td><code>toAmount</code></td><td><code>string</code></td><td>The amount of <code>toAsset</code>.</td></tr><tr><td><code>toAddress</code></td><td><code>string</code></td><td>The recipient address.</td></tr><tr><td><code>finalisedAt</code></td><td><code>number</code></td><td>UNIX timestamp indicating when the transaction finalized.</td></tr><tr><td><code>meta</code></td><td><code>object</code></td><td>Metadata including images and provider info.</td></tr><tr><td><code>payload</code></td><td><code>object</code></td><td>Additional transaction specific data.</td></tr><tr><td><code>legs</code></td><td><code>array</code></td><td>Detailed breakdown of each transaction leg.</td></tr></tbody></table>
+
+***
+
+#### Example response:
+
+```json
+{
+  "chainId": "43114",
+  "hash": "0x18f6d7b91ceffcc6d70b5d73f324198d9847531b7fe53d9446b7e60a64fa44b9",
+  "block": 57181100,
+  "type": "swap",
+  "status": "completed",
+  "trackingStatus": "completed",
+  "fromAsset": "AVAX.AVAX",
+  "fromAmount": "9.58",
+  "fromAddress": "0xC935B2397f0c6f85235ceFba2Eb714fb5F919Ca0",
+  "toAsset": "THOR.RUNE",
+  "toAmount": "0",
+  "toAddress": "thor1mse4ysqpru6s7f6twlskt2yz963xz630mwtxqn",
+  "finalisedAt": 1739313043,
+  "meta": {
+    "provider": "THORCHAIN",
+    "providerAction": "swap",
+    "images": {
+      "from": "https://storage.googleapis.com/token-list-swapkit/images/avax.avax.png",
+      "to": "https://storage.googleapis.com/token-list-swapkit/images/thor.rune.png",
+      "provider": "https://storage.googleapis.com/token-list-swapkit/images/thor.rune.png",
+      "chain": "https://storage.googleapis.com/token-list-swapkit/avax.avax.png"
+    }
+  },
+  "payload": {
+    "memo": "=:r:thor1mse4ysqpru6s7f6twlskt2yz963xz630mwtxqn:0:-_/t:5/50"
+  },
+  "legs": [
+    {
+      "chainId": "43114",
+      "hash": "0x18f6d7b91ceffcc6d70b5d73f324198d9847531b7fe53d9446b7e60a64fa44b9",
+      "block": 57181100,
+      "type": "swap",
+      "status": "completed",
+      "trackingStatus": "completed",
+      "fromAsset": "AVAX.AVAX",
+      "fromAmount": "9.58",
+      "fromAddress": "0xC935B2397f0c6f85235ceFba2Eb714fb5F919Ca0",
+      "toAsset": "AVAX.AVAX",
+      "toAmount": "9.58",
+      "toAddress": "0x8F66c4AE756BEbC49Ec8B81966DD8bba9f127549",
+      "finalisedAt": 1739313038,
+      "meta": {
+        "images": {
+          "from": "https://storage.googleapis.com/token-list-swapkit/images/avax.avax.png",
+          "to": "https://storage.googleapis.com/token-list-swapkit/images/avax.avax.png",
+          "chain": "https://storage.googleapis.com/token-list-swapkit/avax.avax.png"
+        }
+      },
+      "payload": {
+        "memo": "=:r:thor1mse4ysqpru6s7f6twlskt2yz963xz630mwtxqn:0:-_/t:5/50"
+      }
+    },
+    {
+      "chainId": "thorchain-1",
+      "hash": "18f6d7b91ceffcc6d70b5d73f324198d9847531b7fe53d9446b7e60a64fa44b9",
+      "block": 19828318,
+      "type": "swap",
+      "status": "completed",
+      "trackingStatus": "completed",
+      "fromAsset": "AVAX.AVAX",
+      "fromAmount": "9.58",
+      "fromAddress": "0xc935b2397f0c6f85235cefba2eb714fb5f919ca0",
+      "toAsset": "THOR.RUNE",
+      "toAmount": "0",
+      "toAddress": "thor1mse4ysqpru6s7f6twlskt2yz963xz630mwtxqn",
+      "finalisedAt": 1739313043,
+      "meta": {
+        "provider": "THORCHAIN",
+        "providerAction": "swap",
+        "images": {
+          "from": "https://storage.googleapis.com/token-list-swapkit/images/avax.avax.png",
+          "to": "https://storage.googleapis.com/token-list-swapkit/images/thor.rune.png",
+          "provider": "https://storage.googleapis.com/token-list-swapkit/images/thor.rune.png",
+          "chain": "https://storage.googleapis.com/token-list-swapkit/thor.rune.png"
+        }
+      },
+      "payload": {
+        "memo": "=:r:thor1mse4ysqpru6s7f6twlskt2yz963xz630mwtxqn:0:-_/t:5/50",
+        "thorname": ""
+      }
+    }
+  ]
+}
+```
+
+***
+
+#### Notes:
+
+* The `legs` array provides a detailed view of each step in the transaction process.
+* `meta` contains additional information, including images and the swap provider details.
+* The `payload` may include data like `evmCalldata` or `memo` for more complex transactions.
+
+### Transaction status
+
+An important part of the response is the transaction status from the `status` field, which can have multiple values:
+
+<table><thead><tr><th width="154">Status value</th><th>Explanation</th></tr></thead><tbody><tr><td><code>not_started</code></td><td>The swap has not happened yet.</td></tr><tr><td><code>pending</code></td><td>Intermediate state. The transaction has been detected by the mempool but is pending block confirmation.</td></tr><tr><td><code>swapping</code></td><td>The swap is happening.</td></tr><tr><td><code>completed</code></td><td>The swap is finished.</td></tr><tr><td><code>refunded</code></td><td>The swap was refunded because of the slippage settings.</td></tr><tr><td><code>unknown</code></td><td>Catch all for other situations.</td></tr><tr><td><code>failed</code></td><td>The transaction failed in an inbound EVM contract.</td></tr></tbody></table>
+
+# /screen - Check AML compliance
+
+### Endpoint
+
+**Method:** `POST` \
+**URL:** `https://api.swapkit.dev/screen`
+
+The `/screen` endpoint is used to check the Anti-Money Laundering (AML) compliance status of cryptocurrency addresses. It evaluates the risk level of the provided addresses across different blockchain networks using external compliance providers.
+
+We periodically update our own database of blacklisted addresses sourced from trusted providers, and any `/quote` request that involves addresses previously identified as non-compliant will not receive quotes. Despite that, you can choose to screen addresses after a quote to see if their status has changed.
+
+The endpoint provides a compliance confirmation. Our own database is updated with the result if the address is considered risky and it won't receive further quotes.\
+As an integrator, you can use this endpoint to check the addresses that interact with you.&#x20;
+
+***
+
+#### Request parameters
+
+The request body should be a JSON object containing:
+
+* `"addresses"`: A single address (string) or multiple addresses (array of strings).
+* `"chains"`: The blockchain chain ID relevant to each address. You can [see them here](https://docs.swapkit.dev/providers-request-supported-chains-by-a-swap-provider#chain-ids-and-corresponding-names), where we listed them before. They are standard identification for each chain.
+
+{% tabs %}
+{% tab title="One address" %}
+
+```json
+{
+  "addresses": "0x2e1c9b2670802fDE14A789071b6703fe29bfbbFF",
+  "chains": "1"
+}
+```
+
+{% endtab %}
+
+{% tab title="Multiple addresses" %}
+
+```json
+{
+  "addresses": [
+    "0x2e1c9b2670802fDE14A789071b6703fe29bfbbFF",
+    "bc1qh56gtgsp3j088cwpzdezcg5lptnv869vh8jjf2"
+  ],
+  "chains": ["1", "bitcoin"]
+}
+```
+
+{% endtab %}
+{% endtabs %}
+
+### Response
+
+The response contains a boolean field named `"isRisky"` that indicates whether the provided addresses are flagged for anti-money laundering (AML) concerns.
+
+* If the value is `"isRisky": false`, the addresses have passed the compliance check.
+* If the value is `"isRisky": true`, at least one of the addresses has been flagged for AML concerns.
+
+The response includes other parameters that internally help provide the source of the flag, but `"isRisky"` aggregates them.
+
+### Important Considerations
+
+1. Screening criteria:
+    * The endpoint evaluates all addresses together and returns a single decision.
+    * Even if one address is compliant, if any other address in the request is flagged the entire request may receive a `true` response.
+2. Dynamic compliance checking:
+    * Passing a compliance check at one point does not guarantee future compliance.
+    * If an address was screened while it had no funds, it should be re-screened after receiving funds, as they may originate from tainted sources.
+3. Decision responsibility:
+    * SwapKit does not make the final decision on whether a trade is executed.
+    * The integrator using this API is responsible for enforcing compliance policies based on the response.
+
+\
+This endpoint is not meant to be called on every `/quote`. Instead, you should only screen the addresses involved when the user has indicated intent to swap, before they sign the transaction. \
+\
+All addresses involved in the trade should be included in the request, and they should be re-checked if a new trade is offered or if the balances of the addresses have changed since they last passed AML compliance.
+
+***
+
+Here is an example request:
+
+```sh
+curl -X 'POST' \
+  'https://api.swapkit.dev/screen' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "addresses": [
+      "0x2e1c9b2670802fDE14A789071b6703fe29bfbbFF",
+      "bc1qh56gtgsp3j088cwpzdezcg5lptnv869vh8jjf2"
+    ],
+    "chains": ["1", "bitcoin"]
+}'
+```
+
+# /price - Lookup token prices
+
+### Endpoint
+
+**Method:** `POST`\
+**URL:** `https://api.swapkit.dev/price`&#x20;
+
+***
+
+### &#x20;Request parameters
+
+<table><thead><tr><th width="103">Parameter</th><th width="95">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>tokens</code></td><td><code>array</code></td><td>List of token identifiers to fetch price for. Each item is an object with an <code>identifier</code> field (e.g., <code>{ "identifier": "ETH.ETH" }</code>).</td></tr><tr><td><code>metadata</code></td><td><code>boolean</code></td><td>If <code>true</code>, includes extended CoinGecko metadata (currently always included, even if set to <code>false</code>).</td></tr></tbody></table>
+
+{% hint style="info" %}
+Identifiers follow the format `Chain.Asset`, such as `ETH.ETH`, `BTC.BTC` or `SOL.SOL`, with the contract address added at the end when necessary, such as `ARB.PENDLE-0x0c880f6761F1af8d9Aa9C466984b80DAb9a8c9e8`.\
+This is the same formatting used in our `/quote` endpoint.
+{% endhint %}
+
+***
+
+### Example requests
+
+{% tabs %}
+{% tab title="Multiple Tokens (cURL)" %}
+
+```sh
+curl -X POST \
+  'https://api.swapkit.dev/price' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "tokens": [
+      { "identifier": "ETH.ETH" },
+      { "identifier": "BTC.BTC" },
+      { "identifier": "SOL.SOL" },
+      {"identifier": "BSC.CAKE-0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82"}
+    ],
+    "metadata": true
+  }'
+```
+
+{% endtab %}
+
+{% tab title="Single Token (cURL)" %}
+
+```sh
+curl -X POST \
+  'https://api.swapkit.dev/price' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "tokens": [
+      { "identifier": "ETH.ETH" }
+    ],
+    "metadata": true
+  }'
+```
+
+{% endtab %}
+{% endtabs %}
+
+***
+
+### Response format
+
+The endpoint returns an array of token price objects.
+
+```json
+[
+  {
+    "identifier": "ETH.ETH",
+    "provider": "",
+    "cg": {
+      "id": "ethereum",
+      "name": "Ethereum",
+      "market_cap": 197138665861,
+      "total_volume": 12560864823,
+      "price_change_24h_usd": -39.89,
+      "price_change_percentage_24h_usd": -2.38,
+      "sparkline_in_7d": [...],
+      "timestamp": "2025-04-15T12:30:44.643Z"
+    },
+    "price_usd": 1653.61,
+    "timestamp": 1744720254562
+  }
+]
+```
+
+For each token, it includes the following fields:
+
+<table><thead><tr><th width="309">Field</th><th width="94">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>identifier</code></td><td><code>string</code></td><td>The token identifier you queried (e.g., <code>ETH.ETH</code>).</td></tr><tr><td><code>price_usd</code></td><td><code>number</code></td><td>The current price of the token in USD.</td></tr><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Millisecond timestamp of the price fetch.</td></tr><tr><td><code>cg</code></td><td><code>object</code></td><td><em>(If <code>metadata: true</code> — currently always present)</em> CoinGecko metadata.</td></tr><tr><td>└─ <code>id</code></td><td><code>string</code></td><td>CoinGecko’s internal ID.</td></tr><tr><td>└─ <code>name</code></td><td><code>string</code></td><td>Full name of the token.</td></tr><tr><td>└─ <code>market_cap</code></td><td><code>number</code></td><td>Total market capitalization in USD.</td></tr><tr><td>└─ <code>total_volume</code></td><td><code>number</code></td><td>24-hour trading volume in USD.</td></tr><tr><td>└─ <code>price_change_24h_usd</code></td><td><code>number</code></td><td>Price change in absolute USD over the last 24 hours.</td></tr><tr><td>└─ <code>price_change_percentage_24h_usd</code></td><td><code>number</code></td><td>Percentage price change over the last 24 hours.</td></tr><tr><td>└─ <code>sparkline_in_7d</code></td><td><code>array</code></td><td>7-day price history (useful for drawing sparkline charts).</td></tr><tr><td>└─ <code>timestamp</code></td><td><code>string</code></td><td>Timestamp of the CoinGecko data.</td></tr></tbody></table>
+
+When a token's price is not found, or the token name is not correctly specified, the endpoint will return a price of 0 USD for that token. Not how `ETH.HTE` is not a correct identifier so the example response here fails to return a correct price:
+
+```json
+[
+  {
+    "identifier": "ETH.EHT",
+    "provider": "",
+    "price_usd": 0,
+    "timestamp": 0
+  }
+]
+```
+
+
+# /price - Lookup token prices
+
+### Endpoint
+
+**Method:** `POST`\
+**URL:** `https://api.swapkit.dev/price`&#x20;
+
+***
+
+### &#x20;Request parameters
+
+<table><thead><tr><th width="103">Parameter</th><th width="95">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>tokens</code></td><td><code>array</code></td><td>List of token identifiers to fetch price for. Each item is an object with an <code>identifier</code> field (e.g., <code>{ "identifier": "ETH.ETH" }</code>).</td></tr><tr><td><code>metadata</code></td><td><code>boolean</code></td><td>If <code>true</code>, includes extended CoinGecko metadata (currently always included, even if set to <code>false</code>).</td></tr></tbody></table>
+
+{% hint style="info" %}
+Identifiers follow the format `Chain.Asset`, such as `ETH.ETH`, `BTC.BTC` or `SOL.SOL`, with the contract address added at the end when necessary, such as `ARB.PENDLE-0x0c880f6761F1af8d9Aa9C466984b80DAb9a8c9e8`.\
+This is the same formatting used in our `/quote` endpoint.
+{% endhint %}
+
+***
+
+### Example requests
+
+{% tabs %}
+{% tab title="Multiple Tokens (cURL)" %}
+
+```sh
+curl -X POST \
+  'https://api.swapkit.dev/price' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "tokens": [
+      { "identifier": "ETH.ETH" },
+      { "identifier": "BTC.BTC" },
+      { "identifier": "SOL.SOL" },
+      {"identifier": "BSC.CAKE-0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82"}
+    ],
+    "metadata": true
+  }'
+```
+
+{% endtab %}
+
+{% tab title="Single Token (cURL)" %}
+
+```sh
+curl -X POST \
+  'https://api.swapkit.dev/price' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "tokens": [
+      { "identifier": "ETH.ETH" }
+    ],
+    "metadata": true
+  }'
+```
+
+{% endtab %}
+{% endtabs %}
+
+***
+
+### Response format
+
+The endpoint returns an array of token price objects.
+
+```json
+[
+  {
+    "identifier": "ETH.ETH",
+    "provider": "",
+    "cg": {
+      "id": "ethereum",
+      "name": "Ethereum",
+      "market_cap": 197138665861,
+      "total_volume": 12560864823,
+      "price_change_24h_usd": -39.89,
+      "price_change_percentage_24h_usd": -2.38,
+      "sparkline_in_7d": [...],
+      "timestamp": "2025-04-15T12:30:44.643Z"
+    },
+    "price_usd": 1653.61,
+    "timestamp": 1744720254562
+  }
+]
+```
+
+For each token, it includes the following fields:
+
+<table><thead><tr><th width="309">Field</th><th width="94">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>identifier</code></td><td><code>string</code></td><td>The token identifier you queried (e.g., <code>ETH.ETH</code>).</td></tr><tr><td><code>price_usd</code></td><td><code>number</code></td><td>The current price of the token in USD.</td></tr><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Millisecond timestamp of the price fetch.</td></tr><tr><td><code>cg</code></td><td><code>object</code></td><td><em>(If <code>metadata: true</code> — currently always present)</em> CoinGecko metadata.</td></tr><tr><td>└─ <code>id</code></td><td><code>string</code></td><td>CoinGecko’s internal ID.</td></tr><tr><td>└─ <code>name</code></td><td><code>string</code></td><td>Full name of the token.</td></tr><tr><td>└─ <code>market_cap</code></td><td><code>number</code></td><td>Total market capitalization in USD.</td></tr><tr><td>└─ <code>total_volume</code></td><td><code>number</code></td><td>24-hour trading volume in USD.</td></tr><tr><td>└─ <code>price_change_24h_usd</code></td><td><code>number</code></td><td>Price change in absolute USD over the last 24 hours.</td></tr><tr><td>└─ <code>price_change_percentage_24h_usd</code></td><td><code>number</code></td><td>Percentage price change over the last 24 hours.</td></tr><tr><td>└─ <code>sparkline_in_7d</code></td><td><code>array</code></td><td>7-day price history (useful for drawing sparkline charts).</td></tr><tr><td>└─ <code>timestamp</code></td><td><code>string</code></td><td>Timestamp of the CoinGecko data.</td></tr></tbody></table>
+
+When a token's price is not found, or the token name is not correctly specified, the endpoint will return a price of 0 USD for that token. Not how `ETH.HTE` is not a correct identifier so the example response here fails to return a correct price:
+
+```json
+[
+  {
+    "identifier": "ETH.EHT",
+    "provider": "",
+    "price_usd": 0,
+    "timestamp": 0
+  }
+]
+```
+
+
+# /price - Lookup token prices
+
+### Endpoint
+
+**Method:** `POST`\
+**URL:** `https://api.swapkit.dev/price`&#x20;
+
+***
+
+### &#x20;Request parameters
+
+<table><thead><tr><th width="103">Parameter</th><th width="95">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>tokens</code></td><td><code>array</code></td><td>List of token identifiers to fetch price for. Each item is an object with an <code>identifier</code> field (e.g., <code>{ "identifier": "ETH.ETH" }</code>).</td></tr><tr><td><code>metadata</code></td><td><code>boolean</code></td><td>If <code>true</code>, includes extended CoinGecko metadata (currently always included, even if set to <code>false</code>).</td></tr></tbody></table>
+
+{% hint style="info" %}
+Identifiers follow the format `Chain.Asset`, such as `ETH.ETH`, `BTC.BTC` or `SOL.SOL`, with the contract address added at the end when necessary, such as `ARB.PENDLE-0x0c880f6761F1af8d9Aa9C466984b80DAb9a8c9e8`.\
+This is the same formatting used in our `/quote` endpoint.
+{% endhint %}
+
+***
+
+### Example requests
+
+{% tabs %}
+{% tab title="Multiple Tokens (cURL)" %}
+
+```sh
+curl -X POST \
+  'https://api.swapkit.dev/price' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "tokens": [
+      { "identifier": "ETH.ETH" },
+      { "identifier": "BTC.BTC" },
+      { "identifier": "SOL.SOL" },
+      {"identifier": "BSC.CAKE-0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82"}
+    ],
+    "metadata": true
+  }'
+```
+
+{% endtab %}
+
+{% tab title="Single Token (cURL)" %}
+
+```sh
+curl -X POST \
+  'https://api.swapkit.dev/price' \
+  -H 'Content-Type: application/json' \
+  -H "x-api-key: YOUR_VARIABLE_HERE" \
+  -d '{
+    "tokens": [
+      { "identifier": "ETH.ETH" }
+    ],
+    "metadata": true
+  }'
+```
+
+{% endtab %}
+{% endtabs %}
+
+***
+
+### Response format
+
+The endpoint returns an array of token price objects.
+
+```json
+[
+  {
+    "identifier": "ETH.ETH",
+    "provider": "",
+    "cg": {
+      "id": "ethereum",
+      "name": "Ethereum",
+      "market_cap": 197138665861,
+      "total_volume": 12560864823,
+      "price_change_24h_usd": -39.89,
+      "price_change_percentage_24h_usd": -2.38,
+      "sparkline_in_7d": [...],
+      "timestamp": "2025-04-15T12:30:44.643Z"
+    },
+    "price_usd": 1653.61,
+    "timestamp": 1744720254562
+  }
+]
+```
+
+For each token, it includes the following fields:
+
+<table><thead><tr><th width="309">Field</th><th width="94">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>identifier</code></td><td><code>string</code></td><td>The token identifier you queried (e.g., <code>ETH.ETH</code>).</td></tr><tr><td><code>price_usd</code></td><td><code>number</code></td><td>The current price of the token in USD.</td></tr><tr><td><code>timestamp</code></td><td><code>number</code></td><td>Millisecond timestamp of the price fetch.</td></tr><tr><td><code>cg</code></td><td><code>object</code></td><td><em>(If <code>metadata: true</code> — currently always present)</em> CoinGecko metadata.</td></tr><tr><td>└─ <code>id</code></td><td><code>string</code></td><td>CoinGecko’s internal ID.</td></tr><tr><td>└─ <code>name</code></td><td><code>string</code></td><td>Full name of the token.</td></tr><tr><td>└─ <code>market_cap</code></td><td><code>number</code></td><td>Total market capitalization in USD.</td></tr><tr><td>└─ <code>total_volume</code></td><td><code>number</code></td><td>24-hour trading volume in USD.</td></tr><tr><td>└─ <code>price_change_24h_usd</code></td><td><code>number</code></td><td>Price change in absolute USD over the last 24 hours.</td></tr><tr><td>└─ <code>price_change_percentage_24h_usd</code></td><td><code>number</code></td><td>Percentage price change over the last 24 hours.</td></tr><tr><td>└─ <code>sparkline_in_7d</code></td><td><code>array</code></td><td>7-day price history (useful for drawing sparkline charts).</td></tr><tr><td>└─ <code>timestamp</code></td><td><code>string</code></td><td>Timestamp of the CoinGecko data.</td></tr></tbody></table>
+
+When a token's price is not found, or the token name is not correctly specified, the endpoint will return a price of 0 USD for that token. Not how `ETH.HTE` is not a correct identifier so the example response here fails to return a correct price:
+
+```json
+[
+  {
+    "identifier": "ETH.EHT",
+    "provider": "",
+    "price_usd": 0,
+    "timestamp": 0
+  }
+]
+```