GET Firm quote

/bridge/firm-quote

get

Request executable calldata for initiating a bridging request

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 Bridge Contract.

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

src_chainstring · enumRequired

Blockchain name of the chain to initiate bridging, eg: ethereum, arbitrum, ... (refer to network name reference)

Possible values:

dst_chainstring · enumRequired

Blockchain name of the chain to receive bridged tokens, eg: ethereum, arbitrum, ... (refer to network name reference)

Possible values:

token_instringRequired

Address of the token to be sold/bridge-out

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

token_outstringRequired

Address of the token to be bought/bridge-in

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

amountstringRequired

The amount of token_in token to pay/sell/bridge-out

versionstringOptional

The version of Native Swap Router (if bridging includes token swaps). Leave empty or use 4 (latest)

refund_tostringRequired

The address to receive refunded tokens in an event of fail and refund. This MUST be the real user address or any address that can process the refund. Otherwise the fund will stuck.

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

Header parameters

api_keystringRequired

The API key that was assigned to you by Native

Responses

200

Successful response containing executable calldata for initiating a bridging request

application/json

successbooleanOptional

Indicates whether the request was successful

widgetFeeSignaturestringOptional

Overall widget fee signature

recipientstringOptional

Address that will receive the final tokens

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

amountInstringOptional

Total input amount (in wei)

amountOutstringOptional

Total output amount after fees (in wei)

amountOutBeforeFeestringOptional

Output amount before fees are deducted (in wei)

fallbackSwapDataArrayobject[]Optional

Fallback swap data array for alternative swap paths

tokenTransferFeeOnPercentnumber · doubleOptional

Token transfer fee as a percentage

sourceinteger · int32[]Optional

Source identifiers for the quote

quoteSourceinteger · int32[]Optional

Quote source identifiers

errorMessagestringOptional

Error message if any issues occurred

router_versionstringOptional

Version of the router used

toWrapbooleanOptional

Whether the operation involves wrapping tokens

toUnwrapbooleanOptional

Whether the operation involves unwrapping tokens

amountInOffsetinteger · int32Optional

Offset for amountIn in calldata

amountOutMinimumOffsetinteger · int32Optional

Offset for amountOutMinimum in calldata

prioritystring · enumOptional

Transaction priority level (e.g., 'fast')

Possible values:

get

/swap-api-v2/v1/bridge/firm-quote

HTTPcURLJavaScriptPython

GET /swap-api-v2/v1/bridge/firm-quote?from_address=text&src_chain=ethereum&dst_chain=ethereum&token_in=text&token_out=text&amount=text&refund_to=text HTTP/1.1
Host: v2.api.native.org
api_key: text
Accept: */*

200

Successful response containing executable calldata for initiating a bridging request

{
  "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",
      "confidenceExtractedValueT": 1,
      "confidenceExtractedValueE": 1,
      "confidenceExtractedValueM": 1,
      "confidenceExtractedValueN": 1
    }
  ],
  "widgetFee": {
    "signer": "text",
    "feeRecipient": "text",
    "feeRate": 1
  },
  "widgetFeeSignature": "text",
  "recipient": "text",
  "amountIn": "text",
  "amountOut": "text",
  "amountOutBeforeFee": "text",
  "fallbackSwapDataArray": [
    {}
  ],
  "tokenTransferFeeOnPercent": 1,
  "txRequest": {
    "target": "text",
    "calldata": "text",
    "value": "text",
    "function": "text"
  },
  "source": [
    1
  ],
  "quoteSource": [
    1
  ],
  "errorMessage": "text",
  "router_version": "text",
  "toWrap": true,
  "toUnwrap": true,
  "amountInOffset": 1,
  "amountOutMinimumOffset": 1,
  "priority": "fast"
}