GET Firm quote

In src_chain and dst_chain please ensure the parameters are passed with standardised chain names. Reference: Networks

Get signed order data for selling a ERC20 / native token. Submit the return data to Native router to execute swap.

get

Query parameters

from_addressstringRequired

Effectively recipient. This is the pay out address of the final swapped tokens. Funding address will always be the address calls Native Router.

Pattern: ^0x[a-fA-F0-9]{40}$

beneficiary_addressstringOptional

Address of the end user that initiated the swap request. This is REQUIRED if you are an aggregator/widget/wallet. Optional for solvers.

Pattern: ^0x[a-fA-F0-9]{40}$

src_chainstring · enumRequired

Blockchain name, eg: ethereum, arbitrum, ... (refer to network name reference)

Possible values:

dst_chainstring · enumRequired

Blockchain name, eg: ethereum, arbitrum, ... (refer to network name reference)

Possible values:

token_instringRequired

Address of the token to be sold

Pattern: ^0x[a-fA-F0-9]{40}$

token_outstringRequired

Address of the token to be bought

Pattern: ^0x[a-fA-F0-9]{40}$

amountnumberOptional

Amount of token to be sold, in ether unit. (Skip if already passing amount_wei)

Default: 0

amount_weistringOptional

Amount of token to be sold, in wei unit. (Skip if already passing amount)

Default: 0

expiry_timenumberOptional

The expiry time of the quote, in seconds. Recommand 60 for all networks to avoid quoting errors.

Default: 0

slippagenumberOptional

Number in percent. For example, passing the value 5 means 5%, 0.1 means 0.1% slippage tolerance. Recommend keeping default 0.5

Default: 0.5

timeout_millisnumberOptional

Timeout in milliseconds for the API request, useful in latency-sensitive applications.

Default: 2000

allow_multihopstringOptional

Whether to use multihop within all Native supported pairs for quoting. Recommanded true for wallets/widgets.

Default: false

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

/v1/firm-quote

HTTPcURLJavaScriptPython

GET /swap-api-v2/v1/firm-quote?from_address=text&src_chain=ethereum&dst_chain=ethereum&token_in=text&token_out=text 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
}