Skip to main content
POST
/
swap
/
quote
Swap Quote
curl --request POST \
  --url https://api.coinvoyage.io/v3/swap/quote \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amount": "0.1",
  "destination": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "recipient": "0x1234...abcd",
  "slippage_bps": 50,
  "source": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  },
  "trade_type": "EXACT_OUTPUT"
}
'
{
  "issues": {
    "price_impact_warning": {
      "impact": 0.07,
      "threshold": 0.05
    }
  },
  "quote": {
    "input": {
      "amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "balance": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "breakdown": {
        "base": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        },
        "fees": {
          "custom_fee": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          },
          "protocol_fee": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          },
          "relayer_fee": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          },
          "total_fee": {
            "raw": "100000000",
            "ui": "100.0",
            "value_usd": 100
          }
        },
        "gas": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        },
        "total": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        }
      },
      "currency": {
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "chain_id": 1,
        "decimals": 6,
        "id": "1:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "name": "USD Coin",
        "price_usd": 1,
        "symbol": "USDC"
      }
    },
    "output": {
      "amount": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "amount_out_minimum": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "currency": {
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "chain_id": 1,
        "decimals": 6,
        "id": "1:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "name": "USD Coin",
        "price_usd": 1,
        "symbol": "USDC"
      }
    },
    "trade_type": "EXACT_OUTPUT"
  },
  "result_type": "OK"
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
X-API-KEY
string
required

API key for authentication

Body

application/json
​
trade_type
enum<string>
required

Whether the source or destination amount is fixed.

Available options:
EXACT_INPUT,
EXACT_OUTPUT
Example:

"EXACT_OUTPUT"

​
amount
string
required
Example:

"0.1"

​
source
object
required
Example:
{
  "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "chain_id": 30000000000001
}
​
destination
object
required
Example:
{
  "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "chain_id": 30000000000001
}
​
recipient
string | null
Example:

"0x1234...abcd"

​
slippage_bps
integer | null
Example:

50

Response

Quote produced (check result_type)

​
result_type
enum<string>
required

Soft-error result code returned by /v3/swap/quote endpoints. Non-OK values still arrive on a 200 so polling clients don't have to special-case errors.

Available options:
OK,
NO_ROUTE,
HIGH_IMPACT
Example:

"OK"

​
issues
object
Example:
{
  "price_impact_warning": { "impact": 0.07, "threshold": 0.05 }
}
​
quote
object
Example:
{
  "input": {
    "amount": {
      "raw": "100000000",
      "ui": "100.0",
      "value_usd": 100
    },
    "balance": {
      "raw": "100000000",
      "ui": "100.0",
      "value_usd": 100
    },
    "breakdown": {
      "base": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "fees": {
        "custom_fee": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        },
        "protocol_fee": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        },
        "relayer_fee": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        },
        "total_fee": {
          "raw": "100000000",
          "ui": "100.0",
          "value_usd": 100
        }
      },
      "gas": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      },
      "total": {
        "raw": "100000000",
        "ui": "100.0",
        "value_usd": 100
      }
    },
    "currency": {
      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "chain_id": 1,
      "decimals": 6,
      "id": "1:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "name": "USD Coin",
      "price_usd": 1,
      "symbol": "USDC"
    }
  },
  "output": {
    "amount": {
      "raw": "100000000",
      "ui": "100.0",
      "value_usd": 100
    },
    "amount_out_minimum": {
      "raw": "100000000",
      "ui": "100.0",
      "value_usd": 100
    },
    "currency": {
      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "chain_id": 1,
      "decimals": 6,
      "id": "1:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "name": "USD Coin",
      "price_usd": 1,
      "symbol": "USDC"
    }
  },
  "trade_type": "EXACT_OUTPUT"
}