Versioning

We follow Semantic Versioning. That means our API is versioned as Major.Minor.Patch.
For example, Version 1.2.3 has major version 1, minor version 2, and patch version 3.

Major version changes indicate that we have altered
the API significantly and it is no longer compatible with a previous version. Major
versions are also used as the API URL prefix.

When we update the major version, we will not remove the previous version without notice
to API customers and a deprecation period to allow everyone to smoothly update to the new
version.

Minor version changes indicate that we have added new functionality without breaking
any existing functionality. An API client is compatible with future minor versions. Note
that a minor version update may add a new field to an existing API endpoint's response. Your
API client must ignore fields it does not understand in order to be compatible with future
minor versions.

JSON and CSV Support

By default, all endpoints serve data as JSON. However, by passing format=csv in the URL,
an endpoint will return CSV data. This can be used in Google Sheets via the IMPORTDATA
function.

CSV responses will not contain a header row, this is so that data can be easily concatenated
from multiple requests. The fields will be rendered in the same order as the JSON fields. See
the endpoint's documentation for an example.

Cross Origin Resource Sharing (CORS)

This API supports Cross Origin Resource Sharing, which allows you to make API requests directly
from your user's browser.

To use CORS, you must provide Nomics with the domains on which your application will run so that
we can whitelist them for CORS access.

Requests from localhost, 127.0.0.1, and 0.0.0.0 will always succeed to aid in development.

Demo

A demo application using the Nomics API, CORS, and React is available on Glitch.com. This can help
you get started using the Nomics API. Keep in mind it uses the demo key, which is rotated frequently.
You should get your own API key before deploying an app to production. Check it out:

Authentication

Key

You must include your API Key as a query parameter in every request you make.

Request samples

Response samples

200

application/json

Copy

Expand all Collapse all

[

{

"currency": "BTC",

"price": "10000.00000"

}

]

Aggregated OHLCV Candles

The candles endpoint returns aggregated open, high, low, close, and volume information for Nomics currencies.
When asking for candles, a currency is provided as a parameter. Nomics aggregates all markets where the given
currency is the base currency and the quote currency is a fiat currency, BTC, or ETH and returns all values in
USD.

Candles are aggregated across all markets for the base currencies, which necessitates converting to a common
quote currency. Nomics converts all markets into USD in order to aggregated candles.

Response samples

Exchange OHLCV Candles

The exchange candles endpoint returns raw open, close, high, low, and volume information for Nomics Markets.
The data is not aggregated, therefore prices are in the quote currency of the market and volume is in the base
currency of the market.

Currencies Sparkline

The currencies sparkline endpoint returns prices for all currencies within a customizable time interval
suitable for sparkline charts.

Note the timestamps and prices are built off of OHLCV candles using the close price. This means that the timestamp
represents the start of the candle, and the price is the close price of that candle. This means the response's final timestamp
and price value are always as current as possible, but also that the price is effectively "off" by one candle. This endpoint
is designed to serve as a convenient way to render sparklines, if you need exactly aligned times and prices you can use the
Aggregated OHLCV Candles endpoint.

Request samples

Response samples

200

application/json

Copy

Expand all Collapse all

[

{

"timestamp": "2018-04-14T00:00:00Z",

"volume": "5209035491"

}

]

Exchange Rates

The exchange rates endpoint returns the current exchange rates used by Nomics to convert prices from markets
into USD. This contains Fiat currencies as well as a BTC and ETH quote prices. This endpoint helps normalize
data across markets as well as to provide localization for users.

Currently, this endpoint does not support historical data, but this feature is planned.