For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Reference

Quote

post
Body
from_chainintegerRequired
to_chainintegerRequired
from_tokenstringRequired
to_tokenstringRequired
from_addressstringRequired
to_addressstringRequired
amountintegerRequired
slippageinteger · nullableOptional
affiliationstring · nullableOptional
external_bridgebooleanOptionalDefault: false
to_platform_idinteger · nullableOptional
select_routestring · nullableOptional
sponsor_gasbooleanOptionalDefault: false
use_deposit_addressbooleanOptionalDefault: false
exact_outbooleanOptionalDefault: false
strictbooleanOptionalDefault: false
Responses
200

Successful Response

application/json
request_idstringRequired
amount_outstringRequired
feestringRequired
txany of · nullableOptional
or
or
slippageintegerRequired
min_receivestringRequired
estimated_timenumberOptionalDefault: 10
recipientstringRequired
router_typestring · enumOptionalDefault: swapPossible values:
routerstringOptionalDefault: wheelx
created_atstring · date-timeRequired
pointsstringRequired
quote_messagestring · nullableOptional
deposit_addressstring · nullableOptional
approve_txany of · nullableOptional
or
or
swap_txany of · nullableOptional
or
or
gas_feestring · nullableOptional
bridge_order_idstring · nullableOptional
amount_instring · nullableOptional
post/v1/quote

Get Order

get
Path parameters
request_idstringRequired
Responses
200

Successful Response

application/json
order_idstringRequired
from_chainintegerRequired
from_tokenstringRequired
from_addressstringRequired
from_amountstringRequired
to_chainintegerRequired
to_tokenstringRequired
to_amountstringRequired
to_addressstringRequired
open_tx_hashstringRequired
open_blockintegerRequired
open_timestampstring · date-timeRequired
fill_tx_hashstring · nullableOptional
fill_blockinteger · nullableOptional
fill_timestampstring · date-time · nullableOptional
statusstring · enumRequiredPossible values:
pointsstringRequired
reward_typestring · enum · nullableOptionalPossible values:
routesstring[]Optional
to_platform_idinteger · nullableOptional
order_valuestring · nullableOptional
bridge_order_idstring · nullableOptional
deposit_addressstring · nullableOptional
get/v1/order/{request_id}

Get Orders

get

Query cross-chain orders — acts as a transaction explorer. Supports filtering by address, chain, token, status, bridge, tx hash, to_address, and time range.

Table structure: Quote LEFT JOIN Transaction LEFT JOIN ExternalTransaction

  • Transaction/ExternalTransaction hold destination-chain fill info

  • fill_tx_hash = COALESCE(Transaction.tx_hash, ExternalTransaction.tx_hash)

  • Status: same-chain = filled; cross-chain depends on Transaction/ExternalTransaction state

When an address filter is provided, relay deposit history from the Relay API is also fetched and merged with local DB results (deduplicated by bridge_order_id).

When use_deposit_address=True, only orders that went through a deposit address flow (Quote.deposit is not null) are returned. The address parameter still filters by sender.

Query parameters
addressstring[]OptionalDefault: []
networkstring · enumOptionalDefault: mainnetPossible values:
from_chaininteger · nullableOptional
to_chaininteger · nullableOptional
from_tokenstring · nullableOptional
to_tokenstring · nullableOptional
to_addressstring · nullableOptional
statusstring · nullableOptional
bridgestring · nullableOptional
deposit_tx_hashstring · nullableOptional
fill_tx_hashstring · nullableOptional
start_datestring · date-time · nullableOptional
end_datestring · date-time · nullableOptional
use_deposit_addressbooleanOptionalDefault: false
limitintegerOptionalDefault: 20
offsetintegerOptionalDefault: 0
sort_bystringOptionalDefault: request_id
sort_orderstringOptionalDefault: desc
Responses
200

Successful Response

application/json
totalintegerRequired
get/v1/orders

Get Deposit Address Config

get
Responses
200

Successful Response

application/json
get/v1/deposit-address-config
200

Successful Response

Chain Info

get
Query parameters
networkstring · enumOptionalDefault: mainnetPossible values:
Responses
200

Successful Response

application/json
get/v1/chain-info

Last updated

Was this helpful?