Skip to main content
GET

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your API secret.

API-Timestamp
string
header
required

Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.

Query Parameters

country
string
required

ISO 3166-1 alpha-2 country code used to select the derivatives offering. US and supported US territory codes, such as PR, select US Derivatives. Other countries select International/EEA Derivatives, subject to geographic restrictions.

Required string length: 2
Pattern: ^[A-Z]{2}$
Example:

"US"

asset_type
enum<string>
default:perpetual

Classification of the trading instrument.

Available options:
perpetual
Example:

"perpetual"

page_size
integer<int32>
default:20

Maximum number of results to return. Ignored when page_token is present.

Required range: 1 <= x <= 100
Example:

20

page_token
string

Opaque token returned as next_page_token in the previous response. Omit to request the first page.

Required string length: 1 - 256
symbol
string

Filter instruments by an exact symbol, ignoring case. Use search for partial matches.

Required string length: 1 - 64
Pattern: ^[^\s*,]+$
Example:

"PBTCUCZ0.BTNL"

Filter by a partial match, ignoring case. The US offering searches the symbol and instrument names. The International/EEA offering searches the symbol, base asset, and quote asset.

Required string length: 1 - 128
Example:

"ETH"

exchange
string

Filter instruments by exchange. Use the exact exchange value returned in the response.

Required string length: 1 - 64
Pattern: ^[^,]+$
Example:

"Bitnomial"

sort
enum<string>
default:symbol

Field used to sort instruments.

Available options:
symbol
Example:

"symbol"

sort_direction
enum<string>
default:asc

Sort direction.

Available options:
asc,
desc
Example:

"asc"

Response

Instruments matching the supplied filters.

data
object[]
required

The list of matching instruments.

next_page_token
string

Opaque token for retrieving the next page. Absent when there are no more results.

Required string length: 1 - 256