GET Firm quote
Get signed order data for selling a ERC20 / native token. Submit the return data to Native router to execute swap.
get
Query parameters
from_addressstringRequiredPattern:
Address of the user that sells the token_in
^0x[a-fA-F0-9]{40}$
to_addressstringOptionalPattern:
Address of the user that receives the token_out. If empty, this address will be the same as from_address
^0x[a-fA-F0-9]{40}$
beneficiary_addressstringOptionalPattern:
Address of the end user that initiated the swap request.
^0x[a-fA-F0-9]{40}$
src_chainstring · enumRequiredPossible values:
Blockchain name, eg: ethereum, arbitrum, ...
dst_chainstring · enumRequiredPossible values:
Blockchain name, eg: ethereum, arbitrum, ...
token_instringRequiredPattern:
Address of the token to be sold
^0x[a-fA-F0-9]{40}$
token_outstringRequiredPattern:
Address of the token to be bought
^0x[a-fA-F0-9]{40}$
amountnumberOptionalDefault:
Amount of token to be sold, in ether unit.
0
amount_weistringOptionalDefault:
Amount of token to be sold, in wei unit.
0
expiry_timenumberOptionalDefault:
The expiry time of the quote, in seconds.
0
slippagenumberOptionalDefault:
Number in percent. For example, passing the value 5 means 5%, 0.1 means 0.1% slippage tolerance. By default it's 0.
0
timeout_millisnumberOptionalDefault:
Timeout in milliseconds
2000
Header parameters
apiKeystringRequired
The API key that was assigned to you by Native
Responses
200
Success
application/json
500
There was an exception with the server
get
GET /swap-api-v2/v1/firm-quote HTTP/1.1
Host: v2.api.native.org
apiKey: text
Accept: */*
{
"success": true,
"orders": [
{
"pool": "text",
"signer": "text",
"recipient": "text",
"sellerToken": "text",
"buyerToken": "text",
"effectiveSellerTokenAmount": "text",
"sellerTokenAmount": "text",
"buyerTokenAmount": "text",
"deadlineTimestamp": 1,
"nonce": 1,
"quoteId": "text",
"multiHop": true,
"signature": "text",
"externalSwapCalldata": "text",
"amountOutMinimum": "text",
"widgetFee": {
"signer": "text",
"feeRecipient": "text",
"feeRate": 1
},
"widgetFeeSignature": "text"
}
],
"functionCall": "text",
"widgetFee": {
"signer": "text",
"feeRecipient": "text",
"feeRate": 1
},
"widgetFeeSignature": "text",
"recipient": "text",
"calldata": "text",
"amountIn": "text",
"amountOut": "text",
"toWrap": true,
"toUnwrap": true,
"fallbackSwapDataArray": [
"text"
],
"tokenTransferFeeOnPercent": 1,
"txRequest": {
"target": "text",
"calldata": "text",
"value": "text"
},
"source": "p0",
"errorMessage": "text",
"router_version": "text",
"gasCostUsd": 1,
"estimateDuration": 1,
"bridge": {},
"amountInOffset": 1,
"amountOutMinimumOffset": 1
}
Last updated