ALEXGO
  • 😀What is ALEX?
  • 📈Automated Market Making
    • Our Design
  • 🧙‍♀️Bitcoin Oracle
    • What is the Bitcoin Oracle
  • 🩸XLink
    • XLink
  • 🚅Orderbook
    • What is the Orderbook?
    • Understanding the Orderbook
  • 🚀Launchpad
    • What is the Launchpad
  • 📚Whitepaper
    • Automated Market Making of Trading Pool
    • Automated Market Making of Yield Token Pool
    • Automated Market Making of Collateral Rebalancing Pool
    • Dive Into Collateral Rebalancing Pool!
  • 🎮Developers
    • Networks
      • Mainnet
      • Testnet
    • Protocol Contracts
      • amm-pool-v2-01.clar
      • amm-registry-v2-01.clar
      • amm-vault-v2-01.clar
    • REST API
Powered by GitBook
On this page
  1. Developers

REST API

Previousamm-vault-v2-01.clar

Last updated 6 months ago

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

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/allswaps'
200
403
404
No body

Successfully returning all existing swaps

Returns pool stats

get

/v1/pool_stats/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Query parameters
offsetany

Specifies the offset of data to be returned, default value is 0

limitanyrequired

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/pool_stats/{pool_token_id}?limit=null'
200
403
404
No body

Successfully returning pool stats

Returns all 24 hour pool volumes in time series

get

/v1/pool_volume/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Query parameters
offsetany

Specifies the offset of data to be returned, default value is 0

limitanyrequired

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/pool_volume/{pool_token_id}?limit=null'
200
403
404
No body

Successfully returning volumes

Returns daily volumes of token in time series

get

/v1/volume_24h/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Query parameters
offsetany

Specifies the offset of data to be returned, default value is 0

limitanyrequired

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/volume_24h/{pool_token_id}?limit=null'
200
403
404
No body

Successfully returning volumes

Returns weekly volumes of token in time series

get

/v1/volume_7d/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Query parameters
offsetany

Specifies the offset of data to be returned, default value is 0

limitanyrequired

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/volume_7d/{pool_token_id}?limit=null'
200
403
404
No body

Successfully returning volumes

Returns liquidity in time series

get

/v1/pool_liquidity/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Query parameters
offsetany

Specifies the offset of data to be returned, default value is 0

limitanyrequired

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/pool_liquidity/{pool_token_id}?limit=null'
200
403
404
No body

Successfully returning liquidity

Returns liquidity of token in time series

get

/v1/liquidity/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Query parameters
offsetany

Specifies the offset of data to be returned, default value is 0

limitany

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/liquidity/{pool_token_id}'
200
403
404
No body

Successfully returning liquidity

Returns pool fee in time series

get

/v1/fee/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Query parameters
offsetany

Specifies the offset of data to be returned, default value is 0

limitanyrequired

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/fee/{pool_token_id}?limit=null'
200
403
404
No body

Successfully returning fee

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

get

/v1/stats/tvl

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/stats/tvl'
200
403
404
No body

Successfully returning TVL

Returns token TVL(total value locked) in time series

get

/v1/stats/tvl/{token}

Path parameters
tokenstringrequired
Query parameters
offsetany

Specifies the offset of data to be returned, default value is 0

limitany

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/stats/tvl/{token}'
200
403
404
No body

Successfully returning liquidity

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

get

/v1/stats/total_supply/{token}

Path parameters
tokenstringrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/stats/total_supply/{token}'
200
403
404
No body

Successfully returning total supply

Returns price of token

get

/v1/price/{token}

Path parameters
tokenone ofrequired

name of token eg. SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-alex

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/price/{token}'
200
403
404
No body

Successfully returning price

Returns pool token price value of ALEX platform

get

/v1/pool_token_price/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/pool_token_price/{pool_token_id}'
200
403
404
No body

Successfully returning Pool token price

Returns pool token price value of ALEX platform

get

/v1/pool_token_stats

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/pool_token_stats'
200
403
404
No body

Successfully returning all existing pool token stats

Returns price history of token

get

/v1/price_history/{token}

Path parameters
tokenone ofrequired

name of token eg. SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-alex

Query parameters
order_byany

Specifies the order of block height to be returned, default value is desc

end_block_heightany

Specifies the end block height of data to be returned

start_block_heightany

Specifies the start block height of data to be returned

offsetany

Specifies the offset of data to be returned, default value is 0

limitany

Specifies number of data to be returned, default value is 10

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/price_history/{token}'
200
403
404
No body

Successfully returning price history

Returns all existing pairs

get

/v1/pairs

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/pairs'
200
403
404
No body

Successfully returning all existing pairs

Returns all markets statistics for the last 24 hours

get

/v1/tickers

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/tickers'
200
403
404
No body

Successfully returning all markets statistics for the last 24 hours

get

/v1/ticker/{ticker_id}

Path parameters
ticker_idone ofrequired

A ticker with delimiter between different cryptoassets eg. SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-alex_stx

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/ticker/{ticker_id}'
200
403
404
No body

Successfully returning all historical trades of certain ticker

get

/v1/orderbook/{ticker}

Path parameters
tickerone ofrequired

A ticker with delimiter between different cryptoassets eg. ALEX_WSLM

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/orderbook/{ticker}'
200
403
404
No body

Successfully returning all historical trades of certain ticker

Returns all existing historical trades

get

/v1/historical_swaps/{pool_token_id}

Path parameters
pool_token_idone ofrequired

pool token id of swap pool eg. 13

Query parameters
limitanyrequired

Specifies number of recent block heights to be returned, default value is 1000

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/historical_swaps/{pool_token_id}?limit=null'
200
403
404
No body

Successfully returning all historical trades of certain ticker

get

/v2/coin-gecko/pairs

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v2/coin-gecko/pairs'
200
No body
get

/v2/coin-gecko/tickers

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v2/coin-gecko/tickers'
200
[
  {
    "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
  }
]

Get all tickers from AMM

get

/v1/public/pairs

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/public/pairs'
200
{
  "data": [
    {
      "pool_id": 6,
      "token_x": "SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-wxusd",
      "wrapped_token_x": "SP2TZK01NKDC89J6TA56SA47SDF7RTHYEQ79AAB9A.Wrapped-USD",
      "token_y": "SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-wusda",
      "wrapped_token_y": "SP2C2YFP12AJZB4MABJBAJ55XECVS7E4PMMZ89YZR.usda-token"
    }
  ]
}

Get all token pairs from AMM

  • GETReturns all existing swaps with status
  • GETReturns pool stats
  • GETReturns all 24 hour pool volumes in time series
  • GETReturns daily volumes of token in time series
  • GETReturns weekly volumes of token in time series
  • GETReturns liquidity in time series
  • GETReturns liquidity of token in time series
  • GETReturns pool fee in time series
  • GETReturns total TVL(total value locked) value of ALEX platform
  • GETReturns token TVL(total value locked) in time series
  • GETReturns total supply of queried token eg. age000-governance-token
  • GETReturns price of token
  • GETReturns pool token price value of ALEX platform
  • GETReturns pool token price value of ALEX platform
  • GETReturns price history of token
  • GETReturns all existing pairs
  • GETReturns all markets statistics for the last 24 hours
  • GET/v1/ticker/{ticker_id}
  • GET/v1/orderbook/{ticker}
  • GETReturns all existing historical trades
  • GET/v2/coin-gecko/pairs
  • GET/v2/coin-gecko/tickers
  • GET/v1/public/pairs