Endpoints

All the endpoints available in the Ekubo API, generated from the OpenAPI 3.1 specification

List tokens

get

Get a list of tokens for the given chain ID

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

searchstring · min: 1 · max: 32Optional

Token symbol search

pageSizeinteger · min: 1 · max: 10000OptionalDefault: 1000

afterTokenstringOptional

The :-concatenated chain ID and token address for pagination

Example: 1:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48Pattern: ^(?:\d+|0x[a-fA-F0-9]+):0x[a-fA-F0-9]+$

minVisibilityPriorityinteger · min: -100 · max: 100 · nullableOptional

Token visibility priority threshold

Responses

200

List of tokens

application/json

Array of tokens

chain_idstringRequired

namestring · min: 1 · max: 100Required

Name of the token

symbolstring · min: 1 · max: 32Required

Symbol for the token

decimalsinteger · max: 78Required

The number of decimals used for display of token balances

addressstringRequired

The address of the token for the specified chain

visibility_priorityintegerRequired

How much this token should be surfaced relative to other tokens (higher is better)

sort_orderintegerRequired

How much the token should prefer to be the numerator when displayed in prices (higher is more numerator-like)

total_supplyinteger · nullableRequired

The total supply of the token

logo_urlstring · uriOptional

usd_pricenumber · nullableRequired

The USD price for one unit of the token

bridgeInfosobject · nullableRequired

get/tokens

HTTPcURLJavaScriptPython

GET /tokens HTTP/1.1
Accept: */*

200

List of tokens

[
  {
    "chain_id": "text",
    "name": "text",
    "symbol": "text",
    "decimals": 1,
    "address": "text",
    "visibility_priority": 1,
    "sort_order": 1,
    "total_supply": null,
    "logo_url": "https://example.com",
    "usd_price": null,
    "bridgeInfos": null
  }
]

Batch tokens

get

Fetch metadata for a specific set of tokens

Query parameters

idstring[]Required

Repeat the id parameter to fetch multiple tokens (e.g. ?id=1:0x...&id=0x1:0x...)

Example: 1:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48

Responses

200

Tokens

application/json

Array of tokens

chain_idstringRequired

namestring · min: 1 · max: 100Required

Name of the token

symbolstring · min: 1 · max: 32Required

Symbol for the token

decimalsinteger · max: 78Required

The number of decimals used for display of token balances

addressstringRequired

The address of the token for the specified chain

visibility_priorityintegerRequired

How much this token should be surfaced relative to other tokens (higher is better)

sort_orderintegerRequired

How much the token should prefer to be the numerator when displayed in prices (higher is more numerator-like)

total_supplyinteger · nullableRequired

The total supply of the token

logo_urlstring · uriOptional

usd_pricenumber · nullableRequired

The USD price for one unit of the token

bridgeInfosobject · nullableRequired

get/tokens/batch

HTTPcURLJavaScriptPython

GET /tokens/batch?id=1%3A0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48 HTTP/1.1
Accept: */*

200

Tokens

[
  {
    "chain_id": "text",
    "name": "text",
    "symbol": "text",
    "decimals": 1,
    "address": "text",
    "visibility_priority": 1,
    "sort_order": 1,
    "total_supply": null,
    "logo_url": "https://example.com",
    "usd_price": null,
    "bridgeInfos": null
  }
]

Get token

get

Returns metadata for a specific token on the given chain

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

tokenAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

Token information

application/json

chain_idstringRequired

namestring · min: 1 · max: 100Required

Name of the token

symbolstring · min: 1 · max: 32Required

Symbol for the token

decimalsinteger · max: 78Required

The number of decimals used for display of token balances

addressstringRequired

The address of the token for the specified chain

visibility_priorityintegerRequired

How much this token should be surfaced relative to other tokens (higher is better)

sort_orderintegerRequired

How much the token should prefer to be the numerator when displayed in prices (higher is more numerator-like)

total_supplyinteger · nullableRequired

The total supply of the token

logo_urlstring · uriOptional

usd_pricenumber · nullableRequired

The USD price for one unit of the token

bridgeInfosobject · nullableRequired

404

Token not found

application/json

get/tokens/{chainId}/{tokenAddress}

HTTPcURLJavaScriptPython

GET /tokens/{chainId}/{tokenAddress} HTTP/1.1
Accept: */*

{
  "chain_id": "text",
  "name": "text",
  "symbol": "text",
  "decimals": 1,
  "address": "text",
  "visibility_priority": 1,
  "sort_order": 1,
  "total_supply": null,
  "logo_url": "https://example.com",
  "usd_price": null,
  "bridgeInfos": null
}

Get the block closest to a given timestamp

get

Returns the block whose timestamp is nearest to the provided timestamp

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

Query parameters

timestampstring · date-timeRequired

Timestamp to find the closest block for in the ISO string format

Example: 2025-11-10T00:00:00Z

Responses

200

The block closest to the given timestamp

application/json

numberintegerRequired

timestampstringRequired

get/blocks/{chainId}/closest

HTTPcURLJavaScriptPython

GET /blocks/{chainId}/closest?timestamp=2025-11-10T00%3A00%3A00Z HTTP/1.1
Accept: */*

200

The block closest to the given timestamp

{
  "number": 1,
  "timestamp": "text"
}

Get block

get

Get information about a particular block ingested by the API

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

blockTagany ofRequired

The tag of the block to get or the number of a block containing events

integer · min: 160000Optional

or

string · enumOptionalPossible values:

Responses

200

The timestamp of the given block number

application/json

numberintegerRequired

timestampstringRequired

get/blocks/{chainId}/{blockTag}

HTTPcURLJavaScriptPython

GET /blocks/{chainId}/{blockTag} HTTP/1.1
Accept: */*

200

The timestamp of the given block number

{
  "number": 1,
  "timestamp": "text"
}

Get pairs

get

Returns stats for the top pairs

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

minTvlUsdnumber · nullableOptional

Minimum USD TVL required for a pair to be included

Default: 1000

Responses

200

The stats for the protocols top pairs

application/json

get/overview/pairs

HTTPcURLJavaScriptPython

GET /overview/pairs HTTP/1.1
Accept: */*

200

The stats for the protocols top pairs

{
  "topPairs": [
    {
      "chain_id": "text",
      "token0": "text",
      "token1": "text",
      "volume0_24h": "text",
      "volume1_24h": "text",
      "fees0_24h": "text",
      "fees1_24h": "text",
      "tvl0_total": "text",
      "tvl1_total": "text",
      "tvl0_delta_24h": "text",
      "tvl1_delta_24h": "text",
      "depth0": "text",
      "depth1": "text",
      "min_depth_percent": null
    }
  ]
}

Get boosted fees pools

get

Returns pools with boosted fees state, including current and scheduled donation deltas

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

Responses

200

Pools with boosted fees data

application/json

get/overview/boosted-fees-pools

HTTPcURLJavaScriptPython

GET /overview/boosted-fees-pools HTTP/1.1
Accept: */*

200

Pools with boosted fees data

{
  "pools": [
    {
      "chain_id": "text",
      "token0": "text",
      "token1": "text",
      "pool_id": "text",
      "fee": "text",
      "tick_spacing": 1,
      "core_address": "text",
      "extension": "text",
      "volume0_24h": "text",
      "volume1_24h": "text",
      "fees0_24h": "text",
      "fees1_24h": "text",
      "tvl0_total": "text",
      "tvl1_total": "text",
      "tvl0_delta_24h": "text",
      "tvl1_delta_24h": "text",
      "depth0": "text",
      "depth1": "text",
      "depth_percent": null,
      "stableswap_params": {
        "center_tick": 1,
        "amplification": 1
      },
      "boosts": {
        "donate_rate0": "text",
        "donate_rate1": "text",
        "last_donated_time": 1,
        "future_donation_deltas": [
          {
            "time": 1,
            "donate_rate_delta0": "text",
            "donate_rate_delta1": "text"
          }
        ]
      }
    }
  ]
}

Get revenue

get

Returns the revenue stats for the protocol

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

Responses

200

The revenue stats for the protocol

application/json

get/overview/revenue

HTTPcURLJavaScriptPython

GET /overview/revenue HTTP/1.1
Accept: */*

200

The revenue stats for the protocol

{
  "revenueByTokenByDate": [
    {
      "token": "text",
      "revenue": "text",
      "chain_id": "text",
      "date": "text"
    }
  ],
  "revenueByToken_24h": [
    {
      "token": "text",
      "revenue": "text",
      "chain_id": "text"
    }
  ]
}

Get TVL

get

Returns the TVL portion of the overview

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

Responses

200

The TVL stats

application/json

get/overview/tvl

HTTPcURLJavaScriptPython

GET /overview/tvl HTTP/1.1
Accept: */*

200

The TVL stats

{
  "tvlByToken": [
    {
      "token": "text",
      "balance": "text",
      "chain_id": "text"
    }
  ],
  "tvlDeltaByTokenByDate": [
    {
      "token": "text",
      "date": "text",
      "delta": "text",
      "chain_id": "text"
    }
  ]
}

Get volume

get

Returns the volume portion of the overview

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

Responses

200

The volume stats for the protocol

application/json

get/overview/volume

HTTPcURLJavaScriptPython

GET /overview/volume HTTP/1.1
Accept: */*

200

The volume stats for the protocol

{
  "volumeByTokenByDate": [
    {
      "token": "text",
      "volume": "text",
      "fees": "text",
      "chain_id": "text",
      "date": "text"
    }
  ],
  "volumeByToken_24h": [
    {
      "token": "text",
      "volume": "text",
      "fees": "text",
      "chain_id": "text"
    }
  ]
}

Get pair TVL

get

Returns TVL stats for the pair

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

tokenAany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenBany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

coreAddressany ofOptional

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

poolIdany ofOptional

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

Information about the token pair TVL

application/json

get/pair/{chainId}/{tokenA}/{tokenB}/tvl

HTTPcURLJavaScriptPython

GET /pair/{chainId}/{tokenA}/{tokenB}/tvl HTTP/1.1
Accept: */*

200

Information about the token pair TVL

{
  "tvlByToken": [
    {
      "token": "text",
      "balance": "text"
    }
  ],
  "tvlDeltaByTokenByDate": [
    {
      "token": "text",
      "date": "text",
      "delta": "text",
      "chain_id": "text"
    }
  ]
}

Get pair volume

get

Returns volume stats for a given trading pair

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenAany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenBany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

coreAddressany ofOptional

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

poolIdany ofOptional

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

Information about the token pair volume

application/json

chain_idstringRequired

get/pair/{chainId}/{tokenA}/{tokenB}/volume

HTTPcURLJavaScriptPython

GET /pair/{chainId}/{tokenA}/{tokenB}/volume HTTP/1.1
Accept: */*

200

Information about the token pair volume

{
  "chain_id": "text",
  "volumeByTokenByDate": [
    {
      "token": "text",
      "volume": "text",
      "fees": "text",
      "date": "text"
    }
  ],
  "volumeByToken_24h": [
    {
      "token": "text",
      "volume": "text",
      "fees": "text"
    }
  ]
}

Get pools of pair

get

Returns pool info for a pair

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenAany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenBany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

minTvlUsdnumber · nullableOptional

Minimum USD TVL required for a pool to be included

Default: 1000

Responses

200

Information about the pools of a token pair

application/json

get/pair/{chainId}/{tokenA}/{tokenB}/pools

HTTPcURLJavaScriptPython

GET /pair/{chainId}/{tokenA}/{tokenB}/pools HTTP/1.1
Accept: */*

200

Information about the pools of a token pair

{
  "topPools": [
    {
      "pool_id": "text",
      "fee": "text",
      "tick_spacing": 1,
      "core_address": "text",
      "extension": "text",
      "volume0_24h": "text",
      "volume1_24h": "text",
      "fees0_24h": "text",
      "fees1_24h": "text",
      "tvl0_total": "text",
      "tvl1_total": "text",
      "tvl0_delta_24h": "text",
      "tvl1_delta_24h": "text",
      "depth0": "text",
      "depth1": "text",
      "depth_percent": null,
      "stableswap_params": {
        "center_tick": 1,
        "amplification": 1
      },
      "boosts": {
        "donate_rate0": "text",
        "donate_rate1": "text",
        "last_donated_time": 1,
        "future_donation_deltas": [
          {
            "time": 1,
            "donate_rate_delta0": "text",
            "donate_rate_delta1": "text"
          }
        ]
      }
    }
  ]
}

Get price history

get

Get the VWAP-based price history for the given pair

Path parameters

baseTokenany ofRequired

An address on the specified blockchain network

Example: 0x0

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

quoteTokenany ofRequired

An address on the specified blockchain network

Example: 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

chainIdany ofRequired

A number represented in hexadecimal or decimal

Example: 1

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

intervalinteger · min: 60Optional

Responses

200

The price history of the pair

application/json

timestampintegerRequired

startintegerRequired

endintegerRequired

intervalintegerRequired

get/price/{chainId}/{baseToken}/{quoteToken}/history

HTTPcURLJavaScriptPython

GET /price/{chainId}/{baseToken}/{quoteToken}/history HTTP/1.1
Accept: */*

200

The price history of the pair

{
  "timestamp": 1,
  "start": 1,
  "end": 1,
  "interval": 1,
  "data": [
    {
      "start": "text",
      "vwap": 1,
      "max": 1,
      "min": 1,
      "k_volume": "text"
    }
  ]
}

Get pool price history

get

Returns pool OHLC history with swap candles and TWAMM-projected tail fill when needed

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

coreAddressany ofRequired

An address on the specified blockchain network

Example: 0xabcd

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

poolIdany ofRequired

A number represented in hexadecimal or decimal

Example: 1

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

intervalinteger · min: 1Optional

Bucket size in seconds

startinteger · nullableOptional

Unix timestamp (seconds)

endinteger · nullableOptional

Unix timestamp (seconds)

Responses

200

Pool-level price history and TWAMM metadata for charting

application/json

timestampintegerRequired

startintegerRequired

endintegerRequired

intervalintegerRequired

token0stringRequired

token1stringRequired

get/pools/{chainId}/{coreAddress}/{poolId}/price/history

HTTPcURLJavaScriptPython

GET /pools/{chainId}/{coreAddress}/{poolId}/price/history HTTP/1.1
Accept: */*

200

Pool-level price history and TWAMM metadata for charting

{
  "timestamp": 1,
  "start": 1,
  "end": 1,
  "interval": 1,
  "token0": "text",
  "token1": "text",
  "data": [
    {
      "start": "text",
      "open": 1,
      "high": 1,
      "low": 1,
      "close": 1
    }
  ]
}

Get pool key

get

Returns the pool key details for the given core address and pool id

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

coreAddressany ofRequired

An address on the specified blockchain network

Example: 0xabcd

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

poolIdany ofRequired

A number represented in hexadecimal or decimal

Example: 1

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

Pool key details for the given pool

application/json

get/pools/{chainId}/{coreAddress}/{poolId}/key

HTTPcURLJavaScriptPython

GET /pools/{chainId}/{coreAddress}/{poolId}/key HTTP/1.1
Accept: */*

200

Pool key details for the given pool

{
  "pool_key": {
    "token0": "text",
    "token1": "text",
    "fee": "text",
    "tick_spacing": null,
    "extension": "text",
    "stableswap_params": {
      "center_tick": 1,
      "amplification": 1
    }
  }
}

Get pool liquidity

get

Returns the liquidity delta for each tick for the given pool key hash

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

coreAddressany ofRequired

An address on the specified blockchain network

Example: 0xabcd

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

poolIdany ofRequired

A number represented in hexadecimal or decimal

Example: 1

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The current liquidity chart for the given pool key hash

application/json

get/pools/{chainId}/{coreAddress}/{poolId}/liquidity

HTTPcURLJavaScriptPython

GET /pools/{chainId}/{coreAddress}/{poolId}/liquidity HTTP/1.1
Accept: */*

200

The current liquidity chart for the given pool key hash

{
  "data": [
    {
      "tick": "text",
      "net_liquidity_delta_diff": "text"
    }
  ]
}

Get pair liquidity

get

Returns the liquidity chart for the given token pair, aggregated across all pools

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

tokenAany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenBany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

For each tick for pools of the pair, the liquidity delta

application/json

get/tokens/{chainId}/{tokenA}/{tokenB}/liquidity

HTTPcURLJavaScriptPython

GET /tokens/{chainId}/{tokenA}/{tokenB}/liquidity HTTP/1.1
Accept: */*

200

For each tick for pools of the pair, the liquidity delta

{
  "data": [
    {
      "tick": "text",
      "net_liquidity_delta_diff": "text"
    }
  ]
}

Get top positions for pair

get

Returns the top positions (by liquidity) for the given trading pair

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

tokenAany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenBany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

coreAddressany ofOptional

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

poolIdany ofOptional

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

limitinteger · min: 1 · max: 50Optional

Maximum number of positions to return

Default: 10

Responses

200

Top positions for the given pair

application/json

get/pair/{chainId}/{tokenA}/{tokenB}/positions

HTTPcURLJavaScriptPython

GET /pair/{chainId}/{tokenA}/{tokenB}/positions HTTP/1.1
Accept: */*

200

Top positions for the given pair

{
  "data": [
    {
      "id": "text",
      "chain_id": "text",
      "nft_address": "text",
      "core_address": "text",
      "positions_address": "text",
      "owner": "text",
      "minted_timestamp": "text",
      "pool_key": {
        "token0": "text",
        "token1": "text",
        "fee": "text",
        "tick_spacing": null,
        "extension": "text",
        "stableswap_params": {
          "center_tick": 1,
          "amplification": 1
        }
      },
      "bounds": {
        "lower": 1,
        "upper": 1
      },
      "liquidity": "text",
      "pool_state": {
        "sqrt_ratio": "text",
        "tick": 1,
        "liquidity": "text"
      }
    }
  ]
}

Get pair events

get

Returns a list of recent events for the given trading pair

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

tokenAany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenBany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

coreAddressany ofOptional

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

poolIdany ofOptional

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

A list of events for the given pair

application/json

get/tokens/{chainId}/{tokenA}/{tokenB}/events

HTTPcURLJavaScriptPython

GET /tokens/{chainId}/{tokenA}/{tokenB}/events HTTP/1.1
Accept: */*

200

A list of events for the given pair

{
  "data": [
    {
      "type": 0,
      "fee": "text",
      "tick_spacing": 1,
      "extension": "text",
      "core_address": "text",
      "locker": "text",
      "timestamp": "text",
      "transaction_hash": "text",
      "delta0": "text",
      "delta1": "text"
    }
  ]
}

List positions

get

Returns the list of position NFTs and their keys

Path parameters

addressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

statestring · enumOptional

Filter positions by state; defaults to returning all positions

Possible values:

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

pageSizeinteger · min: 1 · max: 200Optional

Maximum number of positions to return per page

Default: 50

pageinteger · min: 1Optional

Page number to fetch (1-indexed)

Default: 1

Responses

200

The position NFTs owned by the address and keys

application/json

get/positions/{address}

HTTPcURLJavaScriptPython

GET /positions/{address} HTTP/1.1
Accept: */*

200

The position NFTs owned by the address and keys

{
  "data": [
    {
      "id": "text",
      "chain_id": "text",
      "positions_address": "text",
      "owner": null,
      "pool_key": {
        "token0": "text",
        "token1": "text",
        "fee": "text",
        "tick_spacing": null,
        "extension": "text",
        "stableswap_params": {
          "center_tick": 1,
          "amplification": 1
        }
      },
      "bounds": {
        "lower": 1,
        "upper": 1
      },
      "metadata_url": "text",
      "image": "text",
      "liquidity": "text",
      "pool_state": {
        "sqrt_ratio": "text",
        "tick": 1,
        "liquidity": "text"
      },
      "rewards": {
        "ANY_ADDITIONAL_PROPERTY": {
          "amount": "text",
          "pending": "text"
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "totalPages": 1,
    "totalItems": 1
  }
}

List position history

get

Returns the entire history of the given position ID

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

lockerAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The position history

application/json

chain_idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

get/positions/{chainId}/{lockerAddress}/{id}/history

HTTPcURLJavaScriptPython

GET /positions/{chainId}/{lockerAddress}/{id}/history HTTP/1.1
Accept: */*

200

The position history

{
  "chain_id": "text",
  "events": [
    {
      "type": "transfer",
      "block_number": "text",
      "transaction_hash": "text",
      "timestamp": "text",
      "from_address": "text",
      "to_address": "text"
    }
  ]
}

Get NFT Metadata

get

Returns the ERC721 metadata for the given position token ID

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The NFT metadata for the given position ID

application/json

namestringRequired

descriptionstringRequired

imagestringRequired

get/positions/{chainId}/{nftAddress}/{id}

HTTPcURLJavaScriptPython

GET /positions/{chainId}/{nftAddress}/{id} HTTP/1.1
Accept: */*

200

The NFT metadata for the given position ID

{
  "name": "text",
  "description": "text",
  "image": "text",
  "attributes": [
    {
      "trait_type": "text",
      "value": null
    }
  ]
}

Get NFT Image

get

Returns the generated art for the given order NFT ID

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The order NFT image

No content

get/orders/{chainId}/{nftAddress}/{id}/image.svg

HTTPcURLJavaScriptPython

GET /orders/{chainId}/{nftAddress}/{id}/image.svg HTTP/1.1
Accept: */*

200

The order NFT image

No content

Get NFT Metadata

get

Returns the ERC721 metadata for the given order token ID

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The NFT metadata for the given order ID

application/json

namestringRequired

descriptionstringRequired

imagestringRequired

get/orders/{chainId}/{nftAddress}/{id}

HTTPcURLJavaScriptPython

GET /orders/{chainId}/{nftAddress}/{id} HTTP/1.1
Accept: */*

200

The NFT metadata for the given order ID

{
  "name": "text",
  "description": "text",
  "image": "text",
  "attributes": [
    {
      "trait_type": "text",
      "value": null
    }
  ]
}

Get TWAP pool

get

Returns the current state of the given TWAMM pool, including the future order expirations

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

tokenAany ofRequired

An address on the specified blockchain network

Example: 0x0

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenBany ofRequired

An address on the specified blockchain network

Example: 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

coreAddressany ofRequired

An address on the specified blockchain network

Example: 0xabcd

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

feeany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The current state of the given TWAMM pool

application/json

get/twap/pools/{chainId}/{coreAddress}/{tokenA}/{tokenB}/{fee}

HTTPcURLJavaScriptPython

GET /twap/pools/{chainId}/{coreAddress}/{tokenA}/{tokenB}/{fee} HTTP/1.1
Accept: */*

200

The current state of the given TWAMM pool

{
  "saleRateDeltas": [
    {
      "time": 1,
      "token0SaleRateDelta": "text",
      "token1SaleRateDelta": "text"
    }
  ]
}

Get TWAP pair

get

Returns the current state of the given TWAMM pair, including the future order expirations

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

tokenAany ofRequired

An address on the specified blockchain network

Example: 0x0

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

tokenBany ofRequired

An address on the specified blockchain network

Example: 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The current state of the given TWAMM pair

application/json

get/twap/pair/{chainId}/{tokenA}/{tokenB}

HTTPcURLJavaScriptPython

GET /twap/pair/{chainId}/{tokenA}/{tokenB} HTTP/1.1
Accept: */*

200

The current state of the given TWAMM pair

{
  "saleRateDeltas": [
    {
      "time": 1,
      "token0SaleRateDelta": "text",
      "token1SaleRateDelta": "text"
    }
  ]
}

List TWAP orders

get

Returns the list of TWAP orders currently held by the given address

Path parameters

addressany ofRequired

An address on the specified blockchain network

Example: 0x1234

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

statestring · enumOptional

Filter orders by state; defaults to returning all orders

Possible values:

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

pageSizeinteger · min: 1 · max: 200Optional

Maximum number of TWAP orders to return per page

Default: 50

pageinteger · min: 1Optional

Page number to fetch (1-indexed)

Default: 1

Responses

200

The list of TWAP orders placed by the address

application/json

get/twap/orders/{address}

HTTPcURLJavaScriptPython

GET /twap/orders/{address} HTTP/1.1
Accept: */*

200

The list of TWAP orders placed by the address

{
  "orders": [
    {
      "chain_id": "text",
      "nft_address": "text",
      "token_id": "text",
      "orders": [
        {
          "key": {
            "sell_token": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
            "buy_token": "0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
            "fee": "1020847100762815411640772995208708096",
            "start_time": 1,
            "end_time": 1
          },
          "total_proceeds_withdrawn": "text",
          "sale_rate": "text",
          "last_collect_proceeds": null,
          "total_amount_sold": "text"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "totalPages": 1,
    "totalItems": 1
  }
}

List limit orders

get

Returns the list of limit orders currently held by the given address

Path parameters

addressany ofRequired

An address on the specified blockchain network

Example: 0x1234

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

statestring · enumOptional

Filter limit orders by state; defaults to returning all orders

Possible values:

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

pageSizeinteger · min: 1 · max: 200Optional

Maximum number of limit orders to return per page

Default: 50

pageinteger · min: 1Optional

Page number to fetch (1-indexed)

Default: 1

Responses

200

The list of limit orders held or previously held by the address

application/json

get/limit-orders/orders/{address}

HTTPcURLJavaScriptPython

GET /limit-orders/orders/{address} HTTP/1.1
Accept: */*

200

The list of limit orders held or previously held by the address

{
  "orders": [
    {
      "chain_id": "text",
      "token_id": 1,
      "orders": [
        {
          "key": {
            "token0": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
            "token1": "0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
            "tick": 0
          },
          "liquidity": "text",
          "amount": "text",
          "token0_amount_withdrawn": null,
          "token1_amount_withdrawn": null
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "totalPages": 1,
    "totalItems": 1
  }
}

Get NFT Image

get

Returns the generated art for the given position NFT ID

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The position NFT image

No content

get/positions/{chainId}/{nftAddress}/{id}/image.svg

HTTPcURLJavaScriptPython

GET /positions/{chainId}/{nftAddress}/{id}/image.svg HTTP/1.1
Accept: */*

200

The position NFT image

No content

Get NFT Metadata

get

Returns the ERC721 metadata for the given token ID, chain ID and NFT contract address

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The NFT metadata for the given position ID

No content

get/nft/{chainId}/{nftAddress}/{id}

HTTPcURLJavaScriptPython

GET /nft/{chainId}/{nftAddress}/{id} HTTP/1.1
Accept: */*

200

The NFT metadata for the given position ID

No content

Get NFT Image

get

Returns the generated art for the given position NFT ID

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The position NFT image

No content

get/nft/{chainId}/{nftAddress}/{id}/image.svg

HTTPcURLJavaScriptPython

GET /nft/{chainId}/{nftAddress}/{id}/image.svg HTTP/1.1
Accept: */*

200

The position NFT image

No content

List auction keys

get

Lists auction NFTs grouped by token_id + (token0, token1, config)

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

minVisibilityPriorityinteger · min: -100 · max: 100 · nullableOptional

Token visibility priority threshold

ownerany ofOptional

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

List of auction keys

application/json

get/auctions

HTTPcURLJavaScriptPython

GET /auctions HTTP/1.1
Accept: */*

200

List of auction keys

{
  "auctions": [
    {
      "chain_id": "text",
      "key": {
        "token0": "text",
        "token1": "text",
        "config": "text"
      },
      "token_id": "text",
      "owner": "text",
      "auctions_contract_address": "text",
      "total_sale_rate": "text",
      "boost_end_time": "text",
      "completed_timestamp": "text"
    }
  ]
}

Get auction NFT metadata

get

Returns NFT metadata for auction NFTs; route shape matches positions and orders

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The NFT metadata for the given token ID

application/json

namestringRequired

descriptionstringRequired

imagestringRequired

get/auctions/{chainId}/{nftAddress}/{id}

HTTPcURLJavaScriptPython

GET /auctions/{chainId}/{nftAddress}/{id} HTTP/1.1
Accept: */*

200

The NFT metadata for the given token ID

{
  "name": "text",
  "description": "text",
  "image": "text",
  "attributes": [
    {
      "trait_type": "text",
      "value": null
    }
  ]
}

Get auction NFT image

get

Returns the generated NFT image for auction NFTs; route shape matches positions and orders

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The NFT image

No content

get/auctions/{chainId}/{nftAddress}/{id}/image.svg

HTTPcURLJavaScriptPython

GET /auctions/{chainId}/{nftAddress}/{id}/image.svg HTTP/1.1
Accept: */*

200

The NFT image

No content

Get auction NFT state

get

Returns dynamic auction NFT state for UI consumption

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

nftAddressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

idany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

Auction NFT state data

application/json

current_ownerstring · nullableRequired

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

get/auctions/{chainId}/{nftAddress}/{id}/state

HTTPcURLJavaScriptPython

GET /auctions/{chainId}/{nftAddress}/{id}/state HTTP/1.1
Accept: */*

200

Auction NFT state data

{
  "current_owner": null,
  "auctions": [
    {
      "token0": "text",
      "token1": "text",
      "config": "text",
      "total_sale_rate": "text",
      "participants_count": 1,
      "creator_proceeds_collected": null,
      "boost_rate": null,
      "boost_end_time": "text",
      "completed_timestamp": "text",
      "creator_amount": null,
      "boost_amount": null
    }
  ]
}

List Proposals

get

Returns the list of all proposals

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

The list of proposals

application/json

get/governance/{chainId}/proposals

HTTPcURLJavaScriptPython

GET /governance/{chainId}/proposals HTTP/1.1
Accept: */*

200

The list of proposals

{
  "proposals": [
    {
      "id": "text",
      "createdTime": 1,
      "description": null,
      "calls": [
        {
          "to": "text",
          "selector": "text",
          "calldata": [
            "text"
          ]
        }
      ],
      "results": [
        [
          "text"
        ]
      ],
      "executed_tx_hash": null
    }
  ]
}

List Top Delegates

get

Returns the list of top delegates

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

pageSizeinteger · min: 1 · max: 1000Optional

startinteger · nullableOptional

Responses

200

The list of top delegates

application/json

amountDelegatedTostringRequired

A decimal number

Pattern: ^\d+e?\d*$

get/governance/{chainId}/delegates

HTTPcURLJavaScriptPython

GET /governance/{chainId}/delegates HTTP/1.1
Accept: */*

200

The list of top delegates

{
  "amountDelegatedTo": "text",
  "delegates": [
    {
      "delegate": "text",
      "amount": "text",
      "votingRecord": {
        "yea": 1,
        "nay": 1,
        "missed": 1
      }
    }
  ]
}

List Votes

get

Returns the list of votes on a proposal

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

proposalIdstringRequired

The ID of the proposal

Pattern: ^0x[a-fA-F0-9]+$

Responses

200

The list of votes on a specific proposal

application/json

get/governance/{chainId}/proposals/{proposalId}/votes

HTTPcURLJavaScriptPython

GET /governance/{chainId}/proposals/{proposalId}/votes HTTP/1.1
Accept: */*

200

The list of votes on a specific proposal

{
  "votes": [
    {
      "time": 1,
      "voter": "text",
      "weight": "text",
      "yea": true
    }
  ]
}

List Voters

get

Returns the list of voters for a proposal and their votes

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

proposalIdstringRequired

The ID of the proposal

Pattern: ^0x[a-fA-F0-9]+$

Responses

200

The list of voters and their weights for a specific proposal

application/json

get/governance/{chainId}/proposals/{proposalId}/voters

HTTPcURLJavaScriptPython

GET /governance/{chainId}/proposals/{proposalId}/voters HTTP/1.1
Accept: */*

200

The list of voters and their weights for a specific proposal

{
  "voters": [
    {
      "voter": "text",
      "weight": "text",
      "vote": {
        "time": 1,
        "yea": true
      }
    }
  ]
}

Get Staker Info

get

Returns information about a particular staker address: the addresses they have delegated to and the total amount delegated to them

Path parameters

chainIdany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

addressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Responses

200

Information about the given staker

application/json

amountDelegatedTostringRequired

A decimal number

Pattern: ^\d+e?\d*$

get/governance/{chainId}/delegates/{address}

HTTPcURLJavaScriptPython

GET /governance/{chainId}/delegates/{address} HTTP/1.1
Accept: */*

200

Information about the given staker

{
  "amountDelegatedTo": "text",
  "delegates": [
    {
      "delegate": "text",
      "amount": "text",
      "votingRecord": {
        "yea": 1,
        "nay": 1,
        "missed": 1
      }
    }
  ]
}

List campaigns

get

List all the liquidity incentive campaigns

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

Responses

200

The list of campaigns

application/json

Response for list campaigns endpoint

get/campaigns

HTTPcURLJavaScriptPython

GET /campaigns HTTP/1.1
Accept: */*

200

The list of campaigns

{
  "campaigns": [
    {
      "slug": "text",
      "chain_id": "text",
      "coreAddress": "text",
      "allowedLockers": [
        "text"
      ],
      "name": "text",
      "rewardToken": "text",
      "startTime": "text",
      "endTime": null,
      "nextDropTime": "text",
      "allowedExtensions": [
        "text"
      ],
      "pairs": [
        {
          "token0": "text",
          "token1": "text",
          "depth_percent": null,
          "depth0": null,
          "depth1": null,
          "distributed": "text",
          "scheduled": "text",
          "daily_rewards": "text",
          "daily_rewards_token0": "text",
          "daily_rewards_token1": "text",
          "realized_volatility": null
        }
      ]
    }
  ]
}

Get position rewards

get

Returns the computed rewards for a specified position

Path parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Required

The ID of the network that is being fetched

lockerany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

saltany ofRequired

A number represented in hexadecimal or decimal

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

startTimestring · date-timeOptional

Filter to rewards in periods that started at or after this time

endTimestring · date-timeOptional

Filter to rewards in periods that ended at or before this time

Responses

200

The computed rewards for each campaign and the specified position

application/json

The list of rewards for a specified position

get/rewards/{chainId}/{locker}/{salt}

HTTPcURLJavaScriptPython

GET /rewards/{chainId}/{locker}/{salt} HTTP/1.1
Accept: */*

200

The computed rewards for each campaign and the specified position

{
  "rewards": [
    {
      "campaignSlug": "text",
      "amount": "text",
      "pending": "text"
    }
  ]
}

List available claims

get

Returns all the claims available for the address

Path parameters

addressany ofRequired

An address on the specified blockchain network

stringOptional

A hexadecimal number

Pattern: ^0x[a-fA-F0-9]+$

or

stringOptional

A decimal number

Pattern: ^\d+e?\d*$

Query parameters

chainIdinteger · int64 · min: 1 · max: 9223372036854776000Optional

The ID of the network that is being fetched

Responses

200

The list of claims for an address

application/json

The list of claims for the given address

get/claims/{address}

HTTPcURLJavaScriptPython

GET /claims/{address} HTTP/1.1
Accept: */*

200

The list of claims for an address

{
  "claims": [
    {
      "campaign": null,
      "chainId": "text",
      "dropAddress": "text",
      "key": {
        "owner": "text",
        "token": "text",
        "root": "text"
      },
      "claim": {
        "index": 1,
        "account": "text",
        "amount": "text"
      },
      "proof": [
        "text"
      ]
    }
  ]
}