BitcoinAverage integration API

API manual

Terms of use

You are free to use our public API in your projects. If you decide to do so - please provide a link back saying BitcoinAverage Price Index. Also please send us a note to bitcoinaverage@gmail.com telling about your project and how you're going to use our data.
There is no explicit restriction on how often you can call the API, however calling it more than once a minute makes no sense. Please be good.

Basics

BitcoinAverage API can be found at https://api.bitcoinaverage.com/.
API allows you to access all data available on site and is read only.
API is accessible via HTTP GET in JSON format for current data and in CSV format for historical data. API doesn't provide JSONP, however it does support cross-origin resource sharing and provides HTTP header Access-Control-Allow-Origin: * allowing unlimited crossdomain AJAX calls.

Each API level starting from the top provides you with a self-explanatory JSON document containing links to deeper levels of API up to data endpoints.
Each API endpoint JSON document includes a timestamp indicating document generation time. All API timestamps assume UTC time.
You can use HTTP or HTTPS for API queries, preference is yours, yet we recommend using HTTPS.


API is updated along with the site, normally around every minute.
This manual assumes that you are familiar with software development in general and understood all of the above.

Global tickers API

Global weighted average ticker API endpoints list is available at https://api.bitcoinaverage.com/ticker/global/. Currencies dedicated endpoints are available at https://api.bitcoinaverage.com/ticker/global/<UPPERCASE_CURRENCY_CODE>/. Aggregated ticker showing all currencies at once is available at https://api.bitcoinaverage.com/ticker/global/all. Ticker fields:
  • ask: weighted average of ask prices
  • bid: weighted average of bid prices
  • last: weighted average of last prices
  • volume_btc: total trading volume across all exchanges in this currency in last 24 hours
  • volume_percent: percent of global ฿ trading volume
Each ticker field is available as a plain text value via separate request to its own name. E.g. https://api.bitcoinaverage.com/ticker/global/USD/last will return only USD last trading price value, as plain text.

Market tickers API

Market tickers represent only currencies that are directly traded to Bitcoin and thus have actual markets of its own. Each currency has its own average market price. Ticker API endpoints list is available at https://api.bitcoinaverage.com/ticker/. Currencies dedicated endpoints are available at https://api.bitcoinaverage.com/ticker/<UPPERCASE_CURRENCY_CODE>/. Aggregated ticker showing all currencies at once is available at https://api.bitcoinaverage.com/ticker/all. Ticker fields:
  • 24h_avg: average of weighted averages for last 24 hours
  • ask: weighted average of ask prices
  • bid: weighted average of bid prices
  • last: weighted average of last prices
  • total_vol: total trading volume across all exchanges in last 24 hours
Each ticker field is available as a plain text value via separate request to its own name. E.g. https://api.bitcoinaverage.com/ticker/USD/last will return only USD last trading price value, as plain text.

Exchange volume API

Exchange volume API URL list is available at https://api.bitcoinaverage.com/exchanges/. Currencies dedicated exchange volume endpoints available at https://api.bitcoinaverage.com/exchanges/<UPPERCASE_CURRENCY_CODE>/. Aggregated document showing all currencies volumes at once is available at https://api.bitcoinaverage.com/exchanges/all. Each exchange volume endpoint document is broken down by exchange. Each exchange has these fields:
  • rates: subset of current ask, bid and last values for exchange to date
  • source: either 'api' or 'bitcoincharts'. Indicates whether data is retrieved directly from the exchange API, or from bitcoincharts API
  • volume_btc: trading volume for last 24h in BTC
  • volume_percent: percent of trading volume represented at this exchange relative to total volume for this currency

Historical data

Historical data URL list is available at https://api.bitcoinaverage.com/history/. A list of historical data CSV files for any currency can be obtained at https://api.bitcoinaverage.com/history/<UPPERCASE_CURRENCY_CODE>/.
Each currency has four CSV endpoints:
  • https://api.bitcoinaverage.com/history/<UPPERCASE_CURRENCY_CODE>/per_minute_24h_sliding_window.csv - 24 hours sliding window, per minute prices for last 24 hours.
  • https://api.bitcoinaverage.com/history/<UPPERCASE_CURRENCY_CODE>/per_hour_monthly_sliding_window.csv - monthly sliding window, per hour averaged prices for last 30 days.
  • https://api.bitcoinaverage.com/history/<UPPERCASE_CURRENCY_CODE>/per_day_all_time_history.csv - averaged daily prices, since start of tracking at bitcoinaverage.com, stored forever.
  • https://api.bitcoinaverage.com/history/<UPPERCASE_CURRENCY_CODE>/volumes.csv - 24h trading volumes per exchange, since start of tracking at bitcoinaverage.com, stored forever.
Each history file has self explanatory headers for each column. CSV files use comma as separators, with values that are wrapped in quotes.

Deprecated 'no-mtgox' API subset

This API subset is deprecated and will be removed in future!

Ignored exchanges

List of temporarily ignored exchanges and reasons for ignoring is available at https://api.bitcoinaverage.com/ignored. Normally it should be empty.