REST API

Front-end developers may use our REST API (https://api.alexgo.io) to access the latest market data on ALEX.

Returns all existing swaps with status

GET/v1/allswaps

Response

200403404

Successfully returning all existing swaps

Request

JavaScriptCurl

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

Returns pool stats

GET/v1/pool_stats/{pool_token}

Path parameters

pool_token*one of

pool token of swap pool eg. fwp-alex-wslm

stringinteger

Query parameters

Response

200403404

Successfully returning pool stats

Request

JavaScriptCurl

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

Returns all 24 hour pool volumes in time series

GET/v1/pool_volume/{pool_token}

Path parameters

pool_token*one of

pool token of swap pool eg. fwp-alex-wslm

stringinteger

Query parameters

Response

200403404

Successfully returning volumes

Request

JavaScriptCurl

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

Returns daily volumes of token in time series

GET/v1/volume_24h/{token}

Path parameters

token*one of

name of token eg. age000-governance-token

stringinteger

Query parameters

Response

200403404

Successfully returning volumes

Request

JavaScriptCurl

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

Returns weekly volumes of token in time series

GET/v1/volume_7d/{token}

Path parameters

token*one of

name of token eg. age000-governance-token

stringinteger

Query parameters

Response

200403404

Successfully returning volumes

Request

JavaScriptCurl

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

Returns liquidity in time series

GET/v1/pool_liquidity/{pool_token}

Path parameters

pool_token*one of

pool token of swap pool eg. fwp-alex-wslm

stringinteger

Query parameters

Response

200403404

Successfully returning liquidity

Request

JavaScriptCurl

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

Returns liquidity of token in time series

GET/v1/liquidity/{token}

Path parameters

token*one of

name of token eg. age000-governance-token

stringinteger

Query parameters

Response

200403404

Successfully returning liquidity

Request

JavaScriptCurl

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

Returns pool fee in time series

GET/v1/fee/{pool_token}

Path parameters

pool_token*one of

pool token of swap pool eg. fwp-alex-wslm

stringinteger

Query parameters

Response

200403404

Successfully returning fee

Request

JavaScriptCurl

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

Returns total TVL(total value locked) value of ALEX platform

GET/v1/stats/tvl

Response

200403404

Successfully returning TVL

Request

JavaScriptCurl

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

Returns token TVL(total value locked) in time series

GET/v1/stats/tvl/{token}

Path parameters

token*string

Query parameters

Response

200403404

Successfully returning liquidity

Request

JavaScriptCurl

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

Returns total supply of queried token eg. age000-governance-token

GET/v1/stats/total_supply/{token}

Path parameters

token*string

Response

200403404

Successfully returning total supply

Request

JavaScriptCurl

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

Returns price of token

GET/v1/price/{token}

Path parameters

token*one of

name of token eg. age000-governance-token

stringinteger

Response

200403404

Successfully returning price

Request

JavaScriptCurl

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

Returns pool token price value of ALEX platform

GET/v1/pool_token_price/{pool_token}

Path parameters

pool_token*one of

pool token of swap pool eg. fwp-alex-wslm

stringinteger

Response

200403404

Successfully returning Pool token price

Request

JavaScriptCurl

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

Returns pool token price value of ALEX platform

GET/v1/pool_token_stats

Response

200403404

Successfully returning all existing pool token stats

Request

JavaScriptCurl

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

Returns price history of token

GET/v1/price_history/{token}

Path parameters

token*one of

name of token eg. age000-governance-token

stringinteger

Query parameters

Response

200403404

Successfully returning price history

Request

JavaScriptCurl

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

Returns all existing pairs

GET/v1/pairs

Response

200403404

Successfully returning all existing pairs

Request

JavaScriptCurl

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

Returns all markets statistics for the last 24 hours

GET/v1/tickers

Response

200403404

Successfully returning all markets statistics for the last 24 hours

Request

JavaScriptCurl

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

GET/v1/ticker/{ticker_id}

Path parameters

ticker_id*one of

A ticker with delimiter between different cryptoassets eg. ALEX_WSLM

stringinteger

Response

200403404

Successfully returning all historical trades of certain ticker

Request

JavaScriptCurl

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

GET/v1/orderbook/{ticker}

Path parameters

ticker*one of

A ticker with delimiter between different cryptoassets eg. ALEX_WSLM

stringinteger

Response

200403404

Successfully returning all historical trades of certain ticker

Request

JavaScriptCurl

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

Returns all existing historical trades

GET/v1/historical_swaps/{ticker}

Path parameters

ticker*one of

A ticker with delimiter between different cryptoassets eg. ALEX_WSLM

stringinteger

Query parameters

Response

200403404

Successfully returning all historical trades of certain ticker

Request

JavaScriptCurl

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

GET/v2/coin-gecko/pairs

Response

200

Get all pairs from both AMM and orderbook

Body

application/json

ticker_id*string

ticker id with delimiter between different cryptoassets.

pool_id*string

pool id with delimiter between different cryptoassets.

base_currency*string

target_currency*string

base*string

display name of base currency.

target*string

display name of target currency.

Request

JavaScriptCurl

const response = await fetch('/v2/coin-gecko/pairs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "ticker_id": "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-slunr_stx",
    "pool_id": "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-amm-swap-pool-v1-1",
    "base_currency": "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-slunr",
    "target_currency": "stx",
    "base": "sLUNR",
    "target": "STX"
  }
]

GET/v2/coin-gecko/tickers

Response

200

Get all tickers from both AMM and orderbook

Body

application/json

ticker_id*string

ticker id with delimiter between different cryptoassets.

pool_id*string

pool id with delimiter between different cryptoassets.

base_currency*string

target_currency*string

base*string

display name of base currency.

target*string

display name of target currency.

last_price*number

base_volume*number

target_volume*number

liquidity_in_usd*number

Request

JavaScriptCurl

const response = await fetch('/v2/coin-gecko/tickers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "ticker_id": "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-slunr_stx",
    "pool_id": "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-amm-swap-pool-v1-1",
    "base_currency": "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-slunr",
    "target_currency": "stx",
    "base": "sLUNR",
    "target": "STX",
    "last_price": 0.08540716070881907,
    "base_volume": 0.08540716070881907,
    "target_volume": 22589.502469,
    "liquidity_in_usd": 22062.86716874599
  }
]