Nomics Cryptocurrency & Bitcoin API (1.0.0)

Download OpenAPI specification:Download

Introduction

Welcome to the Nomics Cryptocurrency & Bitcoin API. To sign up for an API key please go here.

nomics.com is built entirely with the Nomics API. Everything we've done on nomics.com you can do with our API. There are no internal API endpoints.

If you need support, reach out to use at our forums.

General

API Server URL

The Nomics API runs at https://api.nomics.com/v1. All requests should be prefixed by the server URL.

JSON and CSV Support

By default, all endpoints serve data as JSON. However, by passing format=csv in the URL, some endpoints 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.

Not all endpoints support CSV. Endpoints that support CSV will have the format parameter in the parameters section.

Errors

The Nomics API uses standard HTTP status codes to indicate success or failure. 200 represents success, 4xx represents a user error (such as a problem with your key), and 5xx represents a problem with our API.

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.

Patch version changes indicate we fixed a bug or security vulnerability. Patch versions don't add new functionality.

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 Application

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:

Demo Spreadsheet

Here is a demo of using the Nomics API with Google Sheets.

Open in Google Sheets to Copy and Edit

SDKs and Libraries

Community Submissions

We love watching developers explore new use-cases with our API. Whether you're tinkering on a small side project or building an open-source resource, please share what you're up to in our forums.

Authentication

Key

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

For example:

https://api.nomics.com/v1/markets?key=your-api-key-goes-here

The key used in the examples on this page is changed regularly and is intended only as a demo. Get your free Nomics API key here

Security scheme type: API Key
Query parameter name: key

Currencies

Currencies Ticker

Price, volume, market cap, and rank for all currencies across 1 hour, 1 day, 7 day, 30 day, 365 day, and year to date intervals. Current prices are updated every 10 seconds.

Authorizations:
query Parameters
ids
string
Example: ids=BTC%2CETH%2CXRP

Comma separated list of Nomics Currency IDs to filter result rows

interval
string
Enum: "1h" "1d" "7d" "30d" "365d" "ytd"
Example: interval=1d%2C30d

Comma separated time interval of the ticker(s). Default is 1d,7d,30d,365d,ytd.

quote-currency
string
Deprecated
Example: quote-currency=EUR

Currency to quote ticker price, market cap, and volume values. Must be a valid currency from Exchange Rates. Default is USD.

convert
string
Example: convert=EUR

Currency to quote ticker price, market cap, and volume values. May be a Fiat Currency or Cryptocurrency. Default is USD.

include-transparency
boolean

Whether to include Transparent Volume information for currencies. Default is false. This option is only available to customers of our paid API plans.

Responses

200

Price, volume, market cap, and rank for all currencies

401

Authentication information is missing or invalid

get /currencies/ticker

API Server

https://api.nomics.com/v1/currencies/ticker

Request samples

Copy
curl "https://api.nomics.com/v1/currencies/ticker?key=2018-09-demo-dont-deploy-b69315e440beb145&ids=BTC,ETH,XRP&interval=1d,30d&convert=EUR"

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Currencies Metadata

The currencies endpoint returns all the currencies and their metadata that Nomics supports.

Authorizations:
query Parameters
ids
string
Example: ids=BTC%2CETH%2CXRP

Comma separated list of Nomics Currency IDs to filter result rows

attributes
string
Example: attributes=id%2Cname%2Clogo_url

Comma separated list of currency attributes to filter result columns

format
string
Value: "csv"

Format of the response. Defaults to JSON when blank.

Responses

200

A list of Nomics Currencies

401

Authentication information is missing or invalid

get /currencies

API Server

https://api.nomics.com/v1/currencies

Request samples

Copy
curl "https://api.nomics.com/v1/currencies?key=2018-09-demo-dont-deploy-b69315e440beb145&ids=BTC,ETH,XRP&attributes=id,name,logo_url"

Response samples

Content type
Copy
Expand all Collapse all
[]

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.

Authorizations:
query Parameters
start
required
string
Example: start=2018-04-14T00%253A00%253A00Z

Start time of the interval in RFC3339 (URI escaped)

end
string
Example: end=2018-05-14T00%253A00%253A00Z

End time of the interval in RFC3339 (URI escaped). If not provided, the current time is used.

Responses

200

Currency performance over time for all currencies over the requested time period.

401

Authentication information is missing or invalid

get /currencies/sparkline

API Server

https://api.nomics.com/v1/currencies/sparkline

Request samples

Copy
curl "https://api.nomics.com/v1/currencies/sparkline?key=2018-09-demo-dont-deploy-b69315e440beb145&start=2018-04-14T00%3A00%3A00Z&end=2018-05-14T00%3A00%3A00Z"

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Markets

Markets

The markets endpoint returns information on the exchanges and markets that Nomics supports, in addition to the Nomics currency identifiers for the base and quote currency.

Authorizations:
query Parameters
exchange
string
Example: exchange=binance

Nomics Exchange ID to filter by

base
string
Example: base=BTC%2CETH%2CLTC%2CXMR

Comma separated list of base currencies to filter by

quote
string
Example: quote=BTC%2CETH%2CBNB

Comma separated list of quote currencies to filter by

format
string
Value: "csv"

Format of the response. Defaults to JSON when blank.

Responses

200

A list of markets

401

Authentication information is missing or invalid

get /markets

API Server

https://api.nomics.com/v1/markets

Request samples

Copy
curl "https://api.nomics.com/v1/markets?key=2018-09-demo-dont-deploy-b69315e440beb145&exchange=binance&base=BTC,ETH,LTC,XMR&quote=BTC,ETH,BNB"

Response samples

Content type
Copy
Expand all Collapse all
[
  • {
    }
]

Market Cap History

MarketCap History is the total market cap for all cryptoassets at intervals between the requested time period.

Authorizations:
query Parameters
start
required
string
Example: start=2018-04-14T00%253A00%253A00Z

Start time of the interval in RFC3339 (URI escaped)

end
string
Example: end=2018-05-14T00%253A00%253A00Z

End time of the interval in RFC3339 (URI escaped). If not provided, the current time is used.

format
string
Value: "csv"

Format of the response. Defaults to JSON when blank.

Responses

200

Performance over time for the entire market.

401

Authentication information is missing or invalid

get /market-cap/history

API Server

https://api.nomics.com/v1/market-cap/history

Request samples