Native Documentation
  • introduction
    • What is Native
    • About Native V2
    • Benefits for Key Players
  • SOLUTION
    • Native Credit Pool
    • Native Swap Engine
  • CONCEPTS
    • Orderbook
    • Firm Quote Orders
    • Auto Sign Orders
    • Swap Fees
    • Slippage
    • Base and Listed Assets
    • Single-Sided Liquidity Pools
    • Total Available Liquidity
    • Liquidity Pairing
    • Liquidity Bootstrapping
    • Health Ratio
    • Earning Fees and Incentives
    • Credit-Based Swap
      • Collateral Factor
      • PMM Credit
      • Settlement and Liquidation
    • Market-Responsive Pricing
    • Risks
  • USER GUIDE
    • Add Liquidity
    • Pair Liquidity
    • Claim Rewards
    • Swap with Native
  • Build with Native
    • Swap Aggregators
      • Guide
      • FirmQuote Swap APIs
        • GET Orderbook
        • GET Indicative quote
        • GET Firm quote
    • Asset Issuers
      • For Pegged Assets
      • For General Assets
  • Resources
    • Addresses
    • Audits
    • Github
    • System Status
    • Business Source License
    • Media Kit
Powered by GitBook
On this page
  1. Build with Native
  2. Swap Aggregators
  3. FirmQuote Swap APIs

GET Indicative quote

PreviousGET OrderbookNextGET Firm quote

Last updated 3 months ago

Get amount out for selling a ERC20 / native token.

get
Query parameters
from_addressstringRequired

Address of the user that sells the token_in

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

Address of the user that receives the token_out. If empty, this address will be the same as from_address

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

Blockchain name, eg: ethereum, arbitrum, ...

Possible values:
dst_chainstring · enumRequired

Blockchain name, eg: ethereum, arbitrum, ...

Possible values:
token_instringRequired

Token address for the token to be sold.

Example: 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2Pattern: ^0x[a-fA-F0-9]{40}$
token_outstringRequired

Token address for the token to be bought.

Example: 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2Pattern: ^0x[a-fA-F0-9]{40}$
amountnumberOptional

Amount of token to be sold, in ether unit.

Default: 0
amount_weistringOptional

Amount of token to be sold, in wei unit.

Default: 0
expiry_timenumberOptional

The expiry time of the quote, in seconds.

Default: 0
timeout_millisnumberOptional

Timeout in milliseconds

Default: 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/indicative-quote HTTP/1.1
Host: v2.api.native.org
apiKey: text
Accept: */*
[
  {
    "success": true,
    "buyerToken": "text",
    "sellerToken": "text",
    "buyerTokenAmount": 1,
    "buyerTokenAmountWei": "text",
    "sellerTokenAmount": 1,
    "sellerTokenAmountWei": "text",
    "price": 1,
    "widgetFeeUsd": 1,
    "liquidityProviderFeeUsd": 1,
    "totalFeeUsd": 1,
    "routes": [
      "text"
    ],
    "source": "p0",
    "bridge": {}
  }
]