Get api quote

GET

api

{blockchain}

quote

TypeScript

const options = {method: 'GET'};

fetch('https://swap.ggp.gg/api/{blockchain}/quote', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "aggregatorAddress": "<string>",
  "blockNumber": 1,
  "data": {
    "rawTotalGasEstimate": 1,
    "steps": [
      [
        {
          "exchanger": {
            "address": "<string>",
            "fee": 1,
            "name": "<string>",
            "poolType": "UniswapV2"
          },
          "amountIn": "<string>",
          "amountOut": "<string>",
          "percentBps": 1,
          "tokenIn": "<string>",
          "tokenOut": "<string>",
          "priceImpact": 1
        }
      ]
    ],
    "totalAmountOut": "<string>",
    "totalPriceImpact": 1,
    "addressTokenIn": "<string>",
    "addressTokenOut": "<string>",
    "amountIn": "<string>",
    "amountInUsd": 123,
    "amountOutUsd": 123,
    "usdDifference": 123
  },
  "stateAgeMs": 1,
  "tokenApprovalAddress": "<string>"
}

{
  "code": 400,
  "error": "string"
}

{
  "code": 404,
  "error": "string"
}

{
  "code": 408,
  "error": "string"
}

{
  "code": 500,
  "error": "string"
}

Path Parameters

blockchain

enum<string>

required

Available options:

ethereum,

bsc

Query Parameters

addressTokenIn

string

required

Source token contract address (ERC20 or native token)

addressTokenOut

string

required

Destination token contract address (ERC20 or native token)

amountIn

string

Amount of source token to swap (in token's normalized unit, e.g., eth for ETH). Ignored when amountInWei is provided.

amountInWei

string

Amount of source token in the smallest unit (wei). Takes precedence over amountIn

useful for callers that don't account for token decimals.

apiKey

string

Partner API key. Header X-Api-Key takes precedence.

Response

Quote for aggregation swap through POST /{blockchain}/swap

aggregatorAddress

string

required

Address to send the swap transaction to. Use this for tx.to when building the transaction.

blockNumber

integer<int64> | null

Block of the pool state the quote was computed on.

Required range: x >= 0

data

null | object

Show child attributes

stateAgeMs

integer<int64> | null

Age of that state when the quote was computed, in milliseconds.

Required range: x >= 0

tokenApprovalAddress

string | null

Address that the user must approve for ERC20 spending before calling /swap. Null when the input token is native.

TypeScript

const options = {method: 'GET'};

fetch('https://swap.ggp.gg/api/{blockchain}/quote', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "aggregatorAddress": "<string>",
  "blockNumber": 1,
  "data": {
    "rawTotalGasEstimate": 1,
    "steps": [
      [
        {
          "exchanger": {
            "address": "<string>",
            "fee": 1,
            "name": "<string>",
            "poolType": "UniswapV2"
          },
          "amountIn": "<string>",
          "amountOut": "<string>",
          "percentBps": 1,
          "tokenIn": "<string>",
          "tokenOut": "<string>",
          "priceImpact": 1
        }
      ]
    ],
    "totalAmountOut": "<string>",
    "totalPriceImpact": 1,
    "addressTokenIn": "<string>",
    "addressTokenOut": "<string>",
    "amountIn": "<string>",
    "amountInUsd": 123,
    "amountOutUsd": 123,
    "usdDifference": 123
  },
  "stateAgeMs": 1,
  "tokenApprovalAddress": "<string>"
}

{
  "code": 400,
  "error": "string"
}

{
  "code": 404,
  "error": "string"
}

{
  "code": 408,
  "error": "string"
}

{
  "code": 500,
  "error": "string"
}