Institutional Trading Rewards Program
The program outlined below and all numbers provided are subject to change
Method Name
public/get_instrument
public/get_instrumentGet single instrument by asset name
Parameters
| Name | Type | Required | Enum | Description |
|---|---|---|---|---|
| instrument_name | string | True | Instrument name |
Response
| Name | Type | Required | Enum | Description |
|---|---|---|---|---|
| id | string or integer | True | ||
| result | object | True | ||
| ➜ activation | integer | True | Timestamp at which to activate instrument | |
| ➜ amount_step | string | True | ||
| ➜ base_currency | string | True | Underlying currency of base asset (ETH, BTC, etc) | |
| ➜ expiry | integer | True | Instrument expiry timestamp | |
| ➜ instrument_name | string | True | Instrument name | |
| ➜ instrument_type | string | True | erc20optionperp | erc20, option, or perp |
| ➜ is_active | boolean | True | If True: instrument is tradeable within activation and expiry timestamps | |
| ➜ maker_fee_rate | string | True | Percent of spot fee rate | |
| ➜ mark_price_fee_rate_cap | string or null | True | Percent of option price fee cap, e.g. 12.5%, null if not applicable | |
| ➜ max_price | string | True | Maximum valid limit_price | |
| ➜ maximum_amount | string | True | Maximum valid amount of contracts / tokens per trade | |
| ➜ min_price | string | True | Minimum valid limit_price | |
| ➜ minimum_amount | string | True | Minimum valid amount of contracts / tokens per trade | |
| ➜ quote_currency | string | True | Underlying currency of quote asset (USD for perps, USDC for options) | |
| ➜ taker_fee_rate | string | True | Percent of spot fee rate | |
| ➜ tick_size | string | True | Maximum num of decimals in the price | |
| ➜ option_details | object | True | underlying, expiry, strike option_type | |
| ➜ ➜ expiry | integer | True | Unix timestamp of expiry date (in seconds) | |
| ➜ ➜ index | string | True | Underlying settlement price index | |
| ➜ ➜ option_type | string | True | CP | |
| ➜ ➜ strike | string | True | ||
| ➜ perp_details | object | True | TODO | |
| ➜ ➜ index | string | True | Underlying spot price index for funding rate | |
| ➜ ➜ max_rate_per_hour | string | True | ||
| ➜ ➜ min_rate_per_hour | string | True | ||
| ➜ ➜ static_interest_rate | string | True |
Example
# Shell example will be inserted here// JavaScript example will be inserted here# Python example will be inserted hereThe above command returns JSON structured like this:
{
"id": "example",
"result": {
"instrument_name": "ETH-PERP"
}
}Updated 2 months ago