Canadian Bitcoin Index api access to index
- Index API
- History API
- Convert API
- Order Book API
- Summary API
- Volatility API
- News API
- Notifications API
- Analysis API
- Sentiment API
Connecting to the REST API
The current root for all API calls is https://api.cbix.ca/v1/.
The REST API currently does not require any authentication unless specifically indicated. All dates are UTC and all API calls are cached for 60 seconds. The API follows the general rule that all 200 codes are deemed successful, 300 codes denote a redirection, 400 codes are client errors and 500 codes are server errors.
API status may be found at status.cbix.ca.
Index API (/index)
The Index API provides the latest index values, volume data and change information. The API also includes latest bid/ask spreads from all supported exchanges. The API has no additional parameters and does not require authentication and may be tested below.
History API (/history)
The History API returns daily index values and change information from 2011-09-01. An optional limit parameter restricts the amount of data returned (for use with displaying latest historical information) and does not require authentication.
- limit (optional [int]) - days to limit the historical data returned to. Returns all data if no limit is specified.
Convert API (/convert)
The Convert API processes a simple currency conversion between BTC and CAD based on the current index price. The parameters specify the currency to be converted to/from. If no parameters are specified the conversion is from CAD to BTC. The below example converts $100 to BTC.
- from (optional [BTC|CAD]) - The currency from (defaults to CAD)
- to (optional [BTC|CAD]) - The currency to (defaults to BTC)
- amount (required [BTC|CAD]) - The amount to be converted
Order Book API (/orderbook)
The Order Book API returns a full order book for all supported exchanges for use in calculating and displaying price depth as on www.cbix.ca/orderbook. An optional limit parameter restricts the amount of data returned.
- limit (optional [int]) - number of orders to limit the results to. Returns all data if no limit is specified.
Summary API (/summary)
The Summary API returns the latest index and market summary including market capitalization, total coins in circulation and 52-week high and lows. There are no additional parameters and may be called without authentication.
Volatility API (/volatility)
The Volatility API returns daily historical index volatility data. An optional limit parameter restricts the amount of data returned and does not require authentication.
- limit (optional [int]) - number of days to limit the results to. Returns all data if no limit is specified.
News API (/news)
The News API returns the latest news feed curated by CBIX. There are no additional parameters and may be called without authentication. This API is in active development to refine returned results.
Notifications API (/notifications)
The Notifications API allows users to subscribe to notifications programatically rather than using the online form. This API is currently private and a public version will be released shortly.
Analysis API (/analysis)
In development... The Analysis API is a real-time analysis of trading information from supported exchanges including unusual trading activity and statistics.
Sentiment API (/sentiment)
In development... The Sentiment API is a real-time sentiment indicator for Bitcoin in Canada based on online sources.