TorrentSwap

List assets TorrentSwap can swap, with the id to use in get_quote, ticker, network and decimals. Any two different assets can be swapped. Optional query/network filters.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Optional filter by ticker or name, e.g. \"usdt\" or \"bitcoin\"."
    },
    "network": {
      "type": "string",
      "description": "Optional filter by network id or name, e.g. \"tron\" or \"solana\"."
    }
  },
  "additionalProperties": false
}

List the cross-chain protocols TorrentSwap routes through (NEAR Intents, Chainflip, Flashnet, THORChain, Pact Swap and more), with how each executes and how it holds funds. Use the ids to filter get_quote.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Get live quotes for swapping one asset to another (cross-chain or same-chain). Returns routes ranked by amount received, each with a quoteToken, the executing protocol, expectedReceive, minimumReceived and estimated time. All fees (network, protocol and platform) are included.

{
  "type": "object",
  "properties": {
    "sellAssetId": {
      "type": "string",
      "description": "Asset to send, e.g. \"bitcoin-btc\". From list_assets."
    },
    "buyAssetId": {
      "type": "string",
      "description": "Asset to receive, e.g. \"ethereum-eth\". From list_assets."
    },
    "sellAmount": {
      "type": "string",
      "description": "Amount to send as a decimal string in the sell asset's units, e.g. \"0.05\"."
    },
    "slippage": {
      "type": "number",
      "minimum": 0.1,
      "maximum": 5,
      "description": "Maximum slippage in percent. Default 1.5."
    },
    "providers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 20,
      "description": "Optional: only return routes from these provider ids, e.g. [\"NEAR\", \"FLASHNET\"]. From list_providers."
    }
  },
  "required": [
    "sellAssetId",
    "buyAssetId",
    "sellAmount"
  ],
  "additionalProperties": false
}

Check that an address is valid for the network of an asset before creating a swap (checksums included). Returns the canonical form.

{
  "type": "object",
  "properties": {
    "assetId": {
      "type": "string",
      "description": "Asset the address will receive, e.g. \"tron-usdt\". Determines the network."
    },
    "address": {
      "type": "string",
      "description": "Address to check."
    }
  },
  "required": [
    "assetId",
    "address"
  ],
  "additionalProperties": false
}

Create a swap from a quoteToken returned by get_quote. Returns a one-time depositAddress, the exact amount to send, expiresAt and a swapId for tracking. Only call after the user confirmed the route and both addresses. The swap only happens when the user sends the funds. Repeating the call with the same quoteToken and addresses returns the same deposit address.

{
  "type": "object",
  "properties": {
    "quoteToken": {
      "type": "string",
      "description": "quoteToken of the chosen route (valid for about 2 minutes)."
    },
    "destinationAddress": {
      "type": "string",
      "description": "Address that receives the bought asset, on the buy asset's network."
    },
    "refundAddress": {
      "type": "string",
      "description": "Address on the sell asset's network that receives a refund if the swap cannot complete."
    }
  },
  "required": [
    "quoteToken",
    "destinationAddress",
    "refundAddress"
  ],
  "additionalProperties": false
}

Check the progress of a swap by swapId: awaiting_deposit, confirming, exchanging, sending, completed, refunded, failed or expired.

{
  "type": "object",
  "properties": {
    "swapId": {
      "type": "string",
      "description": "swapId returned by create_swap."
    }
  },
  "required": [
    "swapId"
  ],
  "additionalProperties": false
}