Helix API

Helix-api EndPoints

BaseURL: https://helix-data.io/api

No.	Endpoint	Description
1.	/pairs	Details on crypto assets traded on an exchange
2.	/tickers	Market related statistics for all markets for the last 24 hours
3.	/orderbook	Order book depth of any given trading pair, split into two different arrays for bid and ask orders
4.	/historical_trades	Historical trade data for any given trading pair

Endpoint 1 - /pairs

The /pairs endpoint provides a summary on crypto asset trading pairs available on the exchange.

{ “ticker_id”: “0x231…_0xC02..”, “pool_id”: “0xc6f47e4eb14b421c3ae0984141bE9cF3793bDe93”, "base": "HELIX", "target": "WETH", “base_name”: “Helix”, “base_address”: “0x231CC03E6d8b7368eC2aBfAfb5f73D216c8af980”, “target_name”: “Wrapped Ether”, “target_address”: “0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2”, “price”: “0.00009264199358808715”, “base_volume”: “163485.366155771566560557”, “target_volume”: “14.087847964362054559”, “liquidity”: “111376.3607594455161360619883045426”, “liquidity_ETH”: “70.41369082307403118611343058279249” }

/pairs endpoint response description:

ticker_id	string	Mandatory	Identifier of a ticker with delimiter to separate base/target
base	string	Mandatory	Symbol/currency code of the base crypto asset
target	string	Mandatory	Symbol/currency code of the target crypto asset
pool_id	string	Recommended/Mandatory	pool/pair address or unique ID (Mandatory for DEX)
base_volume	decimal	Recommended	24 hour trading volume in base pair volume (unit in base)
target_volume	decimal	Recommended	24 hour trading volume in target pair volume (unit in target)
base_name	string	Recommended	Name of base crypto asset
base_address	string	Recommended	Address of base crypto asset
target_name	string	Recommended	Name of target crypto asset
target_address	string	Recommended	Address of target crypto asset
price	decimal	Recommended	Price denominated in target / base
liquidity	decimal	Recommended	Liquidity denominated in USD
liquidity_ETH	decimal	Recommended	Liquidity denominated in ETH

Endpoint 2 - /tickers (Market Info)

The /tickers endpoint provides 24-hour pricing and volume information on each market pair available on an exchange.

{ "ticker_id": "0x…_0x..", "pool_id": "0x..", "base_currency": "HELIX", "target_currency": "WETH", "last_price": "0.15", "base_volume": "174596.366155", "target_volume": "14.9796283", "base_id": "0x..", "base_name": "Helix", "target_id": "0x..", "target_name": "Wrapped Ether" }

/tickers endpoint response description:

Name	Data Type	Category	Description
ticker_id	string	Mandatory	Identifier of a ticker with delimiter to separate base/target
pool_id	string	Mandatory	pool/pair address
base_currency	string	Mandatory	Symbol/currency code of base pair
target_currency	string	Mandatory	Symbol/currency code of target pair
last_price	decimal	Mandatory	Last transacted price of base currency based on given target currency (unit in base or target)
base_volume	decimal	Mandatory	24 hour trading volume in base pair volume (unit in base)
target_volume	decimal	Mandatory	24 hour trading volume in target pair volume (unit in target
base_id	string	Recommended	Base pair address
base_name	string	Recommended	Base pair name
target_id	string	Recommended	Target pair address
target_name	string	Recommended	Target pair name

Endpoint 3 - /orderbook (Order book depth details)

The /orderbook/ticker_id endpoint is to provide order book information

Endpoint parameters:

Name	Type	Status	Description
ticker_id	string	Mandatory	A ticker such as "0x231.._0x343…"

Example query: ...api/orderbook?pair=0x231CC03E6d8b7368eC2aBfAfb5f73D216c8af980_0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2

{ "ticker_id": "0x231C.._0xC02aaA..", "timestamp":"1700050000", "bids":[ [ "49.8", "0.50000000" ], [ "49.9", "6.40000000" ] ], "asks":[ [ "50.1", "9.20000000" ], [ "50.2", "7.9000000" ] ] }

Order book response descriptions:

Name	Data Type	Category	Description
ticker_id	string	Mandatory	A pair such as "0x.._0x..", with delimiter between different crypto asset addresses
timestamp	timestamp	Recommended	Unix timestamp in milliseconds for when the last updated time occurred.
bids	decimal	mandatory	An array containing 2 elements. The offer price and quantity for each bid order
asks	decimal	Mandatory	An array containing 2 elements. The ask price and quantity for each ask order

[Optional] Endpoint 4 - /historical_trades (Historical Data)

The /historical_trades/ticker_id is used to return data on historical completed trades for a given market pair.

Endpoint parameters:

Name	Data Type	Category	Description
ticker_id	string	Mandatory	A pair such as "0x231CC03E6d8b7368eC2aBfAfb5f73D216c8af980_0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", with delimiter between different crypto assets

Example query: .../api/historical_trades?pair=0x231CC03E6d8b7368eC2aBfAfb5f73D216c8af980_0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2

[ { "trade_id":“0xf9ef286bfdc5167edd18cef5139024bc5cbaa004298ccf8316c65fafdd43032c-0”, "price":"0.00008755749306534042", "base_volume":"42257.948126025581834956", "target_volume":"3.7", "trade_timestamp":"1658262406", "type":"buy" }, { "trade_id":“0xf9ef286bfdc5167edd18cef5139024bc5cbaa004298ccf8316c65fafdd43032c-0”, "price":"0.00008755749306534042", "base_volume":"42257.948126025581834956", "target_volume":"3.7", "trade_timestamp":"1658262406" "type":"sell" } ]

/historical_trades response descriptions:

Name	Data Type	Category	Description
trade_id	string	Mandatory	A unique ID associated with the trade for the currency pair transaction Note: Unix timestamp does not qualify as trade_id.
price	decimal	Mandatory	Transaction price in base pair volume.
base_volume	decimal	Mandatory	Transaction amount in base pair volume.
target_volume	decimal	Mandatory	Transaction amount in target pair volume.
trade_timestamp	timestamp	Mandatory	Unix timestamp in milliseconds for when the transaction occurred.
type	string	Mandatory	Used to determine the type of the transaction that was completed. Buy – Identifies an ask that was removed from the order book. Sell – Identifies a bid that was removed from the order book.