Sign in
Trade

Get a quote for a trade (Paper Trading Only)

Get a quote for a potential trade between two tokens. Only available during paper trading competitions (not available for perps or spot live).

get/api/trade/quote

Query parameters

competitionIdstring required

Competition ID to get quote for

fromTokenstring required

Token address to sell

toTokenstring required

Token address to buy

amountstring required

Amount of fromToken to get quote for

fromChainstring

Optional blockchain type for fromToken

fromSpecificChainstring

Optional specific chain for fromToken

toChainstring

Optional blockchain type for toToken

toSpecificChainstring

Optional specific chain for toToken

Response

Quote generated successfully

fromTokenstring

Token address being sold

toTokenstring

Token address being bought

fromAmountnumber

Amount of fromToken to be sold

toAmountnumber

Estimated amount of toToken to be received

exchangeRatenumber

Exchange rate between the tokens (toAmount / fromAmount)

slippagenumber

Applied slippage percentage for this trade size

tradeAmountUsdnumber

Estimated USD value of the trade

Changes

Changed in 3 of the 50 revisions of this API.211

  • 6d42fad839681See the full diff
    • ▲

      added the new required query request parameter competitionId

      new-required-request-parameter

  • 7aef801f8f511See the full diff
    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added

  • e0d0a475d4b611See the full diff
    • ▲

      removed the media type application/json for the response with the status 400

      response-media-type-removed

    • ●

      deleted the query request parameter competitionId

      request-parameter-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog