curl --request GET \
--url https://api.vane.xyz/api/v1/tokens/quote \
--header 'x-tenant-api-key: <api-key>'const options = {method: 'GET', headers: {'x-tenant-api-key': '<api-key>'}};
fetch('https://api.vane.xyz/api/v1/tokens/quote', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vane.xyz/api/v1/tokens/quote"
headers = {"x-tenant-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"depositToken": "BTC",
"depositAmount": 0.005,
"settleToken": "USDT",
"settleAmount": 316.2963,
"exchangeRate": 63259.26069931,
"depositTokenUsdValue": 316.98,
"settleTokenUsdValue": 316.27,
"exchange": "CEX",
"tradePath": [
{
"symbol": "BTCUSDT",
"side": "SELL",
"inputToken": "BTC",
"outputToken": "USDT"
}
]
}Get a quote
Returns an indicative quote for a deposit/settle token pair. Set amountIsDeposit=true to quote from a deposit amount, or false to quote from the settle amount you want to receive, in which case the API computes the required deposit.
Authenticate with the tenant API key, or with a JWT access token if you have one.
curl --request GET \
--url https://api.vane.xyz/api/v1/tokens/quote \
--header 'x-tenant-api-key: <api-key>'const options = {method: 'GET', headers: {'x-tenant-api-key': '<api-key>'}};
fetch('https://api.vane.xyz/api/v1/tokens/quote', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vane.xyz/api/v1/tokens/quote"
headers = {"x-tenant-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"depositToken": "BTC",
"depositAmount": 0.005,
"settleToken": "USDT",
"settleAmount": 316.2963,
"exchangeRate": 63259.26069931,
"depositTokenUsdValue": 316.98,
"settleTokenUsdValue": 316.27,
"exchange": "CEX",
"tradePath": [
{
"symbol": "BTCUSDT",
"side": "SELL",
"inputToken": "BTC",
"outputToken": "USDT"
}
]
}GET /v1/tokens/swap-limits still returns 200 OK, with significant order-book slippage included in exchangeRate. Check swap limits first and treat out-of-range quotes as unusable.Authorizations
Vane's shared tenant key. Contact support for a dedicated key if you need custom parameters or separate order tracking.
Query Parameters
Numeric id of the token being deposited. Ids are chain-specific: BTC is 158 on Bitcoin, 159 on Ethereum (ERC20), and 157 on BNB Smart Chain. Look ids up with GET /v1/tokens.
Numeric id of the token to receive. Pick the id on the chain you want to receive on; the catalog at GET /v1/tokens lists them all.
Amount to quote. Interpreted as the deposit amount when amountIsDeposit=true, or as the desired settle amount when false. The API does not enforce it: a missing or non-numeric value still returns 200 with depositAmount: null, settleAmount: 0, and exchangeRate: 0, so validate it client-side.
true if amount is the deposit amount, false if it is the settle amount you want to receive.
Response
Indicative quote for the pair. Returned even for amounts outside the swap limits, with order-book slippage included in exchangeRate.
An indicative quote. Quotes do not enforce swap limits; out-of-range amounts return a quote with order-book slippage included in exchangeRate.
Symbol of the deposit token.
Deposit amount. Computed by the API when amountIsDeposit=false. null when amount was missing or not numeric; the quote is unusable in that case.
Symbol of the settle token.
Estimated settle amount. Computed by the API when amountIsDeposit=true. 0 when amount was missing or not numeric.
Effective rate between deposit and settle tokens. For amounts outside the swap limits, order-book slippage is included here, which is why you check swap limits first. 0 when amount was missing or not numeric.
USD value of depositAmount at quote time, for display. null when depositAmount is null.
USD value of settleAmount at quote time, for display.
Pricing source label for the quote (for example CEX). It describes pricing only; solvers settle the order through intent matching.
Order-book legs used to price the quote. Routing for the price, never for settlement.
Show child attributes
Show child attributes