REST API Overview

Base URL

All REST API endpoints are relative to the base URL:

https://bitnomial.com/exchange/api/<version>/<environment>/

Version

The current API version is v1.

Environment

The API supports the following environments:

Endpoints

The exchange API provides the following endpoints:

• The Products endpoint for publicly available product data
• The Orders endpoint for authenticated account requests
• The Fills endpoint for authenticated fills
• The Block Trades endpoint for block trade information
• The Indexes endpoint for index data information
• The Funding Rates endpoint for perpetual future funding rate information

Rate Limiting

The exchange API is rate-limited to 200 requests per 5 minutes. Exceeding this rate will result in HTTP 403 responses.

Time

In the exchange REST API, time values may be either:

• an ISO8601 timestamp
• now, corresponding to the current time in UTC

Pagination

Some API endpoints are paginated, and will return pagination info in addition to queried data. This pagination info in the response can be used to browse through records in a sorted manner, large queries can be accumulated by clients depending on the users needs.

export type Pagination<T1, T2> = IPagination<T1, T2>;

export interface IPagination<T1, T2> {
  data: T1;
  pagination: T2;
}

export interface CursorInfo {
  cursor: string;
}

The Pagination result types will have the required info to continue the query. Currently all paginated APIs return a CursorInfo, with a cursor string that can be passed to the endpoint by a cursor query parameter. Future endpoints might add new kinds of pagination info.