HomeDocumentationAPI Reference
Log In
Documentation

Institutional Trading Rewards Program

The program outlined below and all numbers provided are subject to change

Method Name

public/get_instrument

Get single instrument by asset name

Parameters

NameTypeRequiredEnumDescription
instrument_namestringTrueInstrument name

Response

NameTypeRequiredEnumDescription
idstring or integerTrue
resultobjectTrue
➜ activationintegerTrueTimestamp at which to activate instrument
➜ amount_stepstringTrue
➜ base_currencystringTrueUnderlying currency of base asset (ETH, BTC, etc)
➜ expiryintegerTrueInstrument expiry timestamp
➜ instrument_namestringTrueInstrument name
➜ instrument_typestringTrueerc20
option
perp
erc20, option, or perp
➜ is_activebooleanTrueIf True: instrument is tradeable within activation and expiry timestamps
➜ maker_fee_ratestringTruePercent of spot fee rate
➜ mark_price_fee_rate_capstring or nullTruePercent of option price fee cap, e.g. 12.5%, null if not applicable
➜ max_pricestringTrueMaximum valid limit_price
➜ maximum_amountstringTrueMaximum valid amount of contracts / tokens per trade
➜ min_pricestringTrueMinimum valid limit_price
➜ minimum_amountstringTrueMinimum valid amount of contracts / tokens per trade
➜ quote_currencystringTrueUnderlying currency of quote asset (USD for perps, USDC for options)
➜ taker_fee_ratestringTruePercent of spot fee rate
➜ tick_sizestringTrueMaximum num of decimals in the price
➜ option_detailsobjectTrueunderlying, expiry, strike option_type
➜ ➜ expiryintegerTrueUnix timestamp of expiry date (in seconds)
➜ ➜ indexstringTrueUnderlying settlement price index
➜ ➜ option_typestringTrueC
P
➜ ➜ strikestringTrue
➜ perp_detailsobjectTrueTODO
➜ ➜ indexstringTrueUnderlying spot price index for funding rate
➜ ➜ max_rate_per_hourstringTrue
➜ ➜ min_rate_per_hourstringTrue
➜ ➜ static_interest_ratestringTrue

Example

# Shell example will be inserted here
// JavaScript example will be inserted here
# Python example will be inserted here

The above command returns JSON structured like this:

{
  "id": "example",
  "result": {
    "instrument_name": "ETH-PERP"
  }
}