API Endpoints | Ekubo Protocol

List tokens

Get the list of supported tokens

GET/tokens

Response

List of tokens

Body

name*string

Name of the token

symbol*string

Symbol for the token

decimals*integer

The number of decimals used for display of token balances

l2_token_address*string

The address of the token on Starknet

sort_order*integer

How much the token should prefer to be the numerator

total_supply*integernull

The total supply of the token

hiddenboolean

Whether the token should display by default in the interface.

disabledboolean

Whether the token has been disabled for use in Ekubo Interface

logo_urlstring (uri)

Request

const response = await fetch('/tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "symbol": "text",
    "l2_token_address": "text",
    "hidden": false,
    "disabled": false,
    "logo_url": "https://example.com"
  }
]

Get block

Get information about a particular block ingested by the API

GET/blocks/{blockTag}

Path parameters

blockTag*any of

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

Response

The timestamp of the given block number

Body

number*integer

The number of the block

timestamp*string

The timestamp of the block

Request

const response = await fetch('/blocks/{blockTag}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "timestamp": "text"
}

List leaderboard

Get the first thousand users on the leaderboard

GET/leaderboard

Query parameters

Response

The list of addresses and the number of points earned over the specified period

Body

timestamp*number

data*array of object

Request

const response = await fetch('/leaderboard', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "timestamp": 0,
  "data": [
    {
      "collector": "text"
    }
  ]
}

Get points

Get the points for a specific collector on the leaderboard

GET/leaderboard/{collector}/points

Path parameters

collector*Address

The address of a contract on Starknet

Response

The list of addresses and the number of points earned over the specified period

Body

referral_points*integer

points*integer

Request

const response = await fetch('/leaderboard/{collector}/points', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get quote

Returns a quote for a swap or series of swaps to/from one token amount from/to another token

GET/quote/{amount}/{token}/{otherToken}

Path parameters

amount*string

The amount of the specified token

token*any of

A hexadecimal number

otherToken*any of

A hexadecimal number

Query parameters

Response

The suggested route(s) to get the best price

Body

any of

Request

const response = await fetch('/quote/{amount}/{token}/{otherToken}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "specifiedAmount": "text",
  "amount": "-123456",
  "route": [
    {
      "pool_key": {
        "token0": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
        "token1": "0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
        "fee": "0x20c49ba5e353f80000000000000000",
        "tick_spacing": 1000,
        "extension": "0x0"
      },
      "sqrt_ratio_limit": "0xfffffc080ed7b4556f3528fe26840249f4b191ef6dff7928",
      "skip_ahead": 123
    }
  ]
}

Get protocol overview

Returns an overview of the high level protocol stats

GET/overview

Response

The stats for the protocol overall

Body

object

Request

const response = await fetch('/overview', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get pair stats

Returns high level stats for a given trading pair

GET/pair/{tokenA}/{tokenB}

Path parameters

tokenA*Address

The address of a contract on Starknet

tokenB*Address

The address of a contract on Starknet

Response

Information about the token pair

Body

object

Request

const response = await fetch('/pair/{tokenA}/{tokenB}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get pair price

Get the price of the base token in terms of the quote token

GET/price/{baseToken}/{quoteToken}

Path parameters

baseToken*any of

A hexadecimal number

quoteToken*any of

A hexadecimal number

Query parameters

Response

The price of base token in terms of quote token

Body

object

Request

const response = await fetch('/price/{baseToken}/{quoteToken}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get price history

Get the VWAP-based price history for the given pair

GET/price/{baseToken}/{quoteToken}/history

Path parameters

baseToken*any of

A hexadecimal number

quoteToken*any of

A hexadecimal number

Query parameters

Response

The price history of the pair

Body

object

Request

const response = await fetch('/price/{baseToken}/{quoteToken}/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get token prices

Given a quote token, returns the price of all other tokens in terms of the qutoe token

GET/price/{quoteToken}

Path parameters

quoteToken*Address

The address of a contract on Starknet

Query parameters

Response

The prices of other tokens in terms of quote token

Body

object

Request

const response = await fetch('/price/{quoteToken}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get pool states

Returns the current state of all the Ekubo pools, including current liquidity and price

GET/pools

Response

The current state of all the pools

Body

object

Request

const response = await fetch('/pools', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get pool liquidity

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

GET/pools/{keyHash}/liquidity

Path parameters

keyHash*Numeric

A number represented in hexadecimal or decimal

Response

The current liquidity chart for the given pool key hash

Body

array of object

Request

const response = await fetch('/pools/{keyHash}/liquidity', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {}
]

List positions

Returns the list of position NFTs and their keys

GET/positions/{address}

Path parameters

address*Address

The address of a contract on Starknet

Query parameters

Response

The position NFTs owned by the address and keys

Body

object

Request

const response = await fetch('/positions/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get pair liquidity

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

GET/tokens/{tokenA}/{tokenB}/liquidity

Path parameters

tokenA*Address

The address of a contract on Starknet

tokenB*Address

The address of a contract on Starknet

Response

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

Body

object

Request

const response = await fetch('/tokens/{tokenA}/{tokenB}/liquidity', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get pair events

Returns a list of recent events for the given trading pair

GET/tokens/{tokenA}/{tokenB}/events

Path parameters

tokenA*Address

The address of a contract on Starknet

tokenB*Address

The address of a contract on Starknet

Response

A list of events for the given pair

Body

object

Request

const response = await fetch('/tokens/{tokenA}/{tokenB}/events', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get NFT Metadata

Returns the ERC721 metadata for the given position token ID

GET/{id}

Path parameters

id*TokenID

The ID of a position NFT token

Response

The NFT metadata for the given position ID

Body

object

Request

const response = await fetch('/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

List position history

Returns the entire history of the given position ID

GET/{id}/history

Path parameters

id*TokenID

The ID of a position NFT token

Response

The position history

Body

object

Request

const response = await fetch('/{id}/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get NFT Image

Returns the generated art for the given position NFT ID

GET/{id}/image.svg

Path parameters

id*TokenID

The ID of a position NFT token

Response

The position NFT image

Body

object

Request

const response = await fetch('/{id}/image.svg', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}