Brave New Coin (BNC) has been providing data for the cryptographic asset marketplace since April 2014. BNC makes this data available through its API's. The V3 platform is the latest iteration, currently presenting market data but expanding to include indices, taxonomy and newsfeeds through a single interface. Access is either via REST or Websockets. In both cases authentication is by OAuth token. Contact support@bravenewcoin.com to obtain the API credentials.

Market data includes the ticker data from over 200 exchanges representing the markets for more than 1500 crypto assets.

BNC aggregates market prices from across exchanges to provide reference rates - the market weighted average (MWA) - for the 6000+ traded market pairs being tracked. These international market reference rates provide the basis to derive a single USD rate, the global weighted average (GWA), for each asset.

Market data is available both as intraday values or as daily summaries (EOD) based on a midnight UTC close providing the open, high, low and close for the 24hr period. Intraday data is limited to a 200 day trailing window. Historic datasets covering the full history back to April 2014 are available on request by contacting support@bravenewcoin.com

A typical interaction with an API endpoint might include:

• A call to obtain an OAuth token based on client credentials.
• A call to one of the lookups to get the UUID for an asset, market or an exchange.
• A call to the API endpoint to get the response.

The following sections provide further details about the general features of the API. You can jump to the Quickstart section if preferred or to the full details of the REST API or Websocket

BNC uses OAuth2 flows for security. When on-boarding to the BNC API platform for the first time, clients are provided with API credentials that allow them to be authenticated and authorised to make API calls. With these credentials a user may obtain an access token which must be submitted as a Header with each API request. The token will contain the information to permit the client to make the call and the scopes that define which endpoints will be accessible to them depending on their contract.

Our websocket endpoint requires the bearer token to be sent as access_token parameter in the connection url. The token will have to be used within 86400 seconds (24 hours) of being issued.

wss://ws.bravenewcoin.com?access_token=<token>

Our REST endpoints require a bearer token, valid for 24 hours, to be sent in the Authorization header.

Authorization: Bearer <token>

BNC utilises UUIDs to identify entities such as assets, markets and exchanges. These UUIDs often provide the values for API endpoint parameters.

The following resources are our informational API endpoints that can be queried to provide UUIDs:

• Asset: Identifier for an asset, coin or token. e.g. BTC, LTC, ETH etc.
• Market: Identifier for a market pair, consisting of a base asset and quote asset. e.g. BTC/USD, BTC/ETH etc.
• Exchange: Identifier for an exchange. e.g. Binance, Bitstamp, Kraken.
• Contract: Identifier for a derivatives contract. e.g. Bybit's BTCUSDM23 Future or Deribit's ETH-31MAR23-4000-C Option.

All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list assets, list exchange tickers, and list GWA / MWA. These list API methods share a common structure, taking at least these three parameters: size, timestamp or startAfter.

APIs which support query parameters timestamp and startAfter will provide paginated results when these query parameters are provided.

Brave New Coin API's utilise cursor-based pagination using the startAfter parameter. The parameter should be an existing object ID and returns resources in reverse chronological order. The startAfter parameter returns resources listed after the named resource. For APIs which take both a startAfter and timestamp parameters, the timestamp is ignored if startAfter is provided.

Brave New Coin APIs will return datetime values in ISO8601 format. Datetime values are always returned in UTC time (as indicated by the Z at the end of the datetime value).

Currently Brave New Coin APIs only accept datetimes in query parameters and request bodies which are in UTC.

The overall service status for Brave New Coin's platform including the APIs is visible here.

If there any issues or problems arising from using the API's then please contact support@bravenewcoin.com and one of the team will reply within at most one working day if not immediately available.

When we make backwards-incompatible changes to the API, we will release a new version. The current version is v3.

The following changes are considered backwards-compatible:

• Adding new API resources
• Adding new optional request parameters to existing API methods
• Adding new properties to existing API responses
• Changing the order of properties in existing API responses
• Changing the length or format of object IDs or other opaque strings

Global weighted average Spot Rates:

The Global Weighted Average for an asset, say Litecoin (LTC), can be obtained by passing the indexType query parameter as GWA and indexId as the Asset Id(UUID) for LTC.

You can find detailed explanation under:

• GWA

In order to get the Asset Id(UUID) for LTC, you need to query the Asset API:

• Asset

curl https://api.bravenewcoin.com/v3/asset?symbol=LTC

Example API call for GWA Intraday LTC:

To request LTC index tickers with a timestamp before 17th March 2020.

curl https://api.bravenewcoin.com/v3/index-ticker?timestamp=2020-03-17T00:00:00.000Z&indexType=GWA&indexId=220cbd0c-e466-4a75-9833-755307f872f3 -H 'Authorization: Bearer test_SiHrnL5NKsea0G2W4LHd' -G

Example API call for GWA Open, High, Low, Close, Volume for LTC:

curl https://api.bravenewcoin.com/v3/ohlcv?timestamp=2019-09-25T00:00:00.000Z&indexType=GWA&indexId={LTC_Asset_Id} -H 'Authorization: Bearer test_SiHrnL5NKsea0G2W4LHd' -G

Market Weighted Average Reference Rates:

The Market weighted average for a market, say BTC/USD (base/quote) can be obtained by passing the indexType query parameter as MWA and indexId as the Market Id(UUID) for BTC/USD.

You can find detailed explanation under:

• MWA

In order to get the Market Id(UUID) for BTC/USD, you need to query the Market API:

• Market

curl https://api.bravenewcoin.com/v3/market?baseAssetId={BTC_Asset_Id}&quoteAssetId={USD_Asset_Id}

The respective asset Ids can be obtained by querying the Asset API as shown in the GWA section.

Example API call for MWA Intraday BTC/USD:

curl https://api.bravenewcoin.com/v3/index-ticker?timestamp=2019-09-25T00:00:00.000Z&indexType=MWA&indexId={BTC_USD_Market_Id} -H 'Authorization: Bearer test_SiHrnL5NKsea0G2W4LHd' -G

Example API call for MWA Open, High, Low, Close, Volume for BTC/USD:

curl https://api.bravenewcoin.com/v3/ohlcv?timestamp=2019-09-25T00:00:00.000Z&indexType=MWA&indexId={BTC_USD_Market_Id} -H 'Authorization: Bearer test_SiHrnL5NKsea0G2W4LHd' -G

Brave New Coin REST API exposes the following endpoints:

• GWA / MWA / LX: Data from intraday API's is limited to a 200 day trailing window and refreshed every 30 seconds from June 1st, 2019.
• OHLCV: OHLCV API's can provide the full historic dataset.
• Market Cap: Latest ranking within the last 5 minutes.
• XchangeFeed: Standardized exchange market tickers updated every 30 seconds.

There are currently no rate limits on API requests, but pagination is enforced on API responses to limit the payload of any one call. See Pagination

A sample Java API client project using the BNC REST API is available on Github :

• Java

Please feel free to create issues and/or pull requests on Github if you would like to contribute to these projects.

You can download the OpenAPI specification and generate your own clients if the language which you are working with is not found in the list. The download link can be found at the top of this page; and is available on github

Brave New Coin uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g. A required parameter was missing). Codes in the 5xx range indicate an error with Brave New Coin's servers.

Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

{
  "status": "BAD_REQUEST",
  "timestamp": "2018-08-14T21:55:46.055Z",
  "message": "validation error",
  "errors": [
    {
      "object": "Asset",
      "field": "status",
      "rejectedValue": "ERROR",
      "message": "Invalid value provided for status"
    }
  ]
}

HTTP status code summary

Handling Errors

Our API libraries raise exceptions for many reasons, such as invalid parameters, authentication errors, and network unavailability. We recommend writing code that gracefully handles all possible API exceptions.

Retrieve information about assets.

Retrieve information about markets.

Retrieve information about exchanges.

BNC’s XchangeFeed integrates and normalizes data feeds from multiple exchanges and delivers the data via a single API.

The API allows you to query:

• All the markets for an individual exchange
• For a particular market on an individual exchange
• For a particular market across all the exchanges that trades the pair
• Returns all when unparameterized

To obtain an Exchange Id or Market Id to use as a parameter for REST or Websocket, you need to query the Exchange or Market API respectively:

• Exchange
• Market

The exchange tickers are refreshed every 30 seconds even if there has been no trade in that period. In that case the lastMoved timestamp in the response provides the time the price was last updated at the exchange.

The Market Cap is calculated based on the free float (or circulating) supply figures and the GWA index price. The Total Market Cap is calculated based on the total supply and the GWA index price.

If the percentChange parameter is set to true this API will also return movement in percentage of these values over a 24h, 7d or 30d period.

Retrieve contract specifications and ticker data for crypto Futures, Perpetual Swaps and Options.

The following exchanges are currently supported in our derivatives endpoints.

Brave New Coin Websocket API exposes the LX indices, GWA / MWA indices, trade data (for selected markets) and XchangeFeed (for all the exchanges and markets covered by BNC) via Websockets. Clients need to send a subscribe message to authenticate and start receiving data.

A sample project using the BNC Websocket API is available on Github :

• Node.js

Connection URL

wss://ws.bravenewcoin.com?access_token=<token>

Authentication

All websocket connections require authentication. For more information see -

• Authentication

Common Message Types

Websocket messages have an event field to identify them

Connection Message

Once the client connection is successful, the server will send back a connection message

{
  "event" : "CONNECTED",
  "timestamp" : "2018-09-05T01:34:39Z"
}

Ping message

Clients or server can send a ping request to check if the connection is active. Clients are expected to implement a pong response. The server may terminate the connection if the client does not respond to ping from the server.

Request

{
  "event": "PING",
  "requestId": 1
}

Response

{
  "event": "PONG",
  "timestamp": "2018-09-05T01:34:39Z",
  "requestId": 1
}

A requestId is an optional field that users may include for their own benefit.

Server will return an error message in the below format

{
  "event": "ERROR",
  "code": "400",
  "message": "Invalid event type provided",
  "timestamp": "2018-09-05T01:34:39Z"
}

Error code summary

There may be other types of errors that may be returned and we recommend handling the ERROR type gracefully.

This endpoint can be used to subscribe to the raw ticker data from different exchanges. Clients can send a Subscribe message to start receiving.

To subscribe to all the ticks of an exchange only the exchangeId can be sent. To subscribe to all the ticks of an market only the marketId or marketName can be sent. Both exchangeId and marketId can be sent to subscribe to the market in an exchange. Clients can subscribe to multiple sources as required. Clients need to call the Market and Exchange REST API's to get the ids.

Parameters

Subscribe to Exchange by Id

{
  "event": "SUBSCRIBE_EXCHANGE_TICKER",
  "exchangeId": "359107d3-bd1a-418c-9470-58831ed9a45e"
}

Subscribe to Market by Id

{
  "event": "SUBSCRIBE_EXCHANGE_TICKER",
  "marketId": "359107d3-bd1a-418c-9470-58831ed9a45e"
}

Subscribe to Market by Name

{
  "event": "SUBSCRIBE_EXCHANGE_TICKER",
  "marketName": "BTC_USD"
}

Subscribe to a Market in an Exchange

{
  "event": "SUBSCRIBE_EXCHANGE_TICKER",
  "exchangeId": "359107d3-bd1a-418c-9470-58831ed9a45e",
  "marketId": "f7cbc588-283e-41da-9c28-eee2113d7b8d"
}

Responses

Subscription response

{
  "event": "SUBSCRIBED_EXCHANGE_TICKER",
  "exchangeId": "359107d3-bd1a-418c-9470-58831ed9a45e",
  "marketId": "f7cbc588-283e-41da-9c28-eee2113d7b8d",
  "timestamp": "2020-06-25T05:01:17.429649Z"
}

The server will return ticks in this format

{
  "event": "EXCHANGE_TICKER"
  "id": "string",
  "exchangeId": "string",
  "marketId": "string",
  "last": "string",
  "volume": "string",
  "bid": "string",
  "ask": "string",
  "timestamp": "2020-06-25T05:02:17.429649Z"
}

Unsubscribe

To unsubscribe, the user should send a payload with the exact same body as the subscribe payload except the event becomes unsubscribe instead of subscribe

{
  "event": "UNSUBSCRIBE_EXCHANGE_TICKER",
  "exchangeId": "359107d3-bd1a-418c-9470-58831ed9a45e",
  "marketId": "f7cbc588-283e-41da-9c28-eee2113d7b8d"
}

This websocket endpoint can be used to subscribe to BNC's LX indices. Clients need to send a Subscribe message to start receiving. The LX Indices can be subscribed by the indexId or the indexType LX. The following table provides the available index Ids to subscribe to an LX index.

Subscribe by Index ID

{
  "event": "SUBSCRIBE_INDEX_TICKER",
  "indexId": "191724d4-7915-491b-8b73-bc293e03a93e",
  "requestId" : 1
}

Subscribe by Index Type

{
  "event": "SUBSCRIBE_INDEX_TICKER",
  "indexType": "LX",
  "requestId": 2
}

Responses

Subscription response

{
  "event": "SUBSCRIBED_INDEX_TICKER",
  "indexType": "LX",
  "timestamp": "2020-06-25T04:56:14.313516Z",
  "requestId": 2
}

The server will return ticks in this format

{
  "event": "INDEX_TICKER"
  "id": "uuid",
  "indexId": "uuid",
  "indexType": "LX",
  "name": "string",
  "price": "string",
  "volume": "string",
  "tickVolume": "string",
  "timestamp": "2020-06-25T04:57:01.298745Z"
}

Unsubscribe

To unsubscribe, the user should send a payload with the exact same body as the subscribe payload except the event becomes unsubscribe instead of subscribe. The requestId is a user option and isn't required.

{
  "event": "UNSUBSCRIBE_INDEX_TICKER",
  "indexType": "LX",
  "requestId": 2
}

This endpoint can be used to subscribe to the GWA / MWA data. These indices are calculated by BNC and published to the websocket endpoint. Clients need to send a Subscribe message to start receiving. Indices can be subscribed by the indexId or the indexType.

The index id will differ based on the index type.

Clients need to call the Market and Asset REST API's to get the ids.

Subscribe by Index ID

{
  "event": "SUBSCRIBE_INDEX_TICKER",
  "indexId": "1490fca6-29f8-416a-835b-e9d000f26fd0",
  "requestId" : 1
}

Subscribe by Index Type

{
  "event": "SUBSCRIBE_INDEX_TICKER",
  "indexType": "MWA",
  "requestId": 2
}

Responses

Subscription response

{
  "event": "SUBSCRIBED_INDEX_TICKER",
  "indexType": "MWA",
  "timestamp": "2020-06-25T04:56:14.313516Z",
  "requestId": 2
}

The server will return ticks in this format

{
  "event": "INDEX_TICKER"
  "id": "string",
  "indexId": "string",
  "indexType": "string",
  "price": "string",
  "volume": "string",
  "timestamp": "2020-06-25T04:57:01.298745Z"
}

Unsubscribe

To unsubscribe, the user should send a payload with the exact same body as the subscribe payload except the event becomes unsubscribe instead of subscribe. The requestId is a user option and isn't required.

{
  "event": "UNSUBSCRIBE_INDEX_TICKER",
  "indexId": "1490fca6-29f8-416a-835b-e9d000f26fd0",
  "requestId" : 1
}