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,ETH,XRP

Comma separated list of Nomics Currency IDs to filter result rows

interval
string
Enum: "1h" "1d" "7d" "30d" "365d" "ytd"
Example: interval=1d,30d

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.

status
string
Enum: "active" "inactive" "dead"

Status by which to filter currencies. If not provided, all currencies are shown.

filter
string
Enum: "any" "new"

Further filter the set of currencies. The new filter returns currencies that have recently been priced by Nomics and any returns currencies regardless of their state. The any filer may be used to retrieve new-but-stale currencies that are listed under new, but are no longer active.

sort
string
Enum: "rank" "first_priced_at"

How to sort the returned currencies. rank sorts by rank ascending and first_priced_at sorts by when each currency was first priced by Nomics descending.

include-transparency
boolean

Whether to include Transparent Volume and transparent market cap information in the response. Default is false. This option is only available to customers of our paid API plans.

per-page
integer
Example: per-page=100

The maximum number of items to return per paginated response. Paginated responses include an additional response header, X-Pagination-Total-Items, which represents the total number of items available after all the request filters have been applied.

page
integer
Example: page=1

Which page of items to get. Only applicable when per-page is also supplied.

Responses