AMM API Docs
The Arkadiko AMM has a public API that can be used for integrations. This page shows documentation on the endpoints and how they can be used
/api/v1/tickers
The /api/v1/tickers API endpoint shows all trading pairs that are listed on the Arkadiko AMM. The endpoint returns a JSON with the following fields
Name | Data Type | Description |
ticker_id | string | Identifier of a ticker with delimiter to separate base/target, eg. BTC_ETH (Contract address for DEX) |
base_currency | string | Symbol/Currency code/Contract Address of a the base cryptoasset, eg. BTC (Contract address for DEX) |
target_currency | string | Symbol/Currency code/Contract Address of the target cryptoasset, eg. ETH (Contract address for DEX) |
pool_id | string | pool/ pair address or unique ID (Mandatory for DEX) |
last_price | decimal | Last transacted price of base currency based on given target currency (unit in base or target) eg. X = ? 1 base = X target X base = 1 target |
base_volume | decimal | 24 hour trading volume for the pair (unit in base) |
target_volume | decimal | 24 hour trading volume for the pair (unit in target) |
pool_id | string | pool/pair address or unique ID (Mandatory for DEX) |
liquidity_in_usd | decimal | Pool liquidity in USD |
bid | decimal | Current highest bid price |
ask | decimal | Current lowest ask price |
high | decimal | Rolling 24-hours highest transaction price |
low | decimal | Rolling 24-hours lowest transaction price |
/api/v1/pools/:id
Given a pool ID (e.g. 1, 2,3 etc), returns information about the pool and its assets. The endpoint returns a JSON with the following fields:
Name | Data Type | Description |
id | string | The ID of the entry in the DB |
token_x_name | string | The name of token X in the pair |
token_y_name | integer | |
token_x_address | string | Start time from which to query historical trades from |
token_y_address | string | End time for historical trades query |
token_x_id | string | The ID of token X of the entry in the DB |
token_y_id | string | The ID of token Y of the entry in the DB |
balance_x | string | The balance of token X in the pool (denominated in token X) |
balance_y | string | The balance of token Y in the pool (denominated in token Y) |
enabled | boolean | Whether pair is enabled in the AMM or not |
/api/v1/pools/:id/prices
Given a pool ID (e.g. 1, 2, 3 etc), returns all historical prices of a pair.
Last updated