Files
ritmex-bot/docs/grvt/schemas/api_get_all_instruments_response.md
T

3.0 KiB

!!! info "ApiGetAllInstrumentsResponse" |Name
Lite|Type|Required
Default| Description | |-|-|-|-| |result
r |[Instrument]|True|List of instruments| ??? info "Instrument" |Name
Lite|Type|Required
Default| Description | |-|-|-|-| |instrument
i |string|True|The readable instrument name:

  • Perpetual: ETH_USDT_Perp
  • Future: BTC_USDT_Fut_20Oct23
  • Call: ETH_USDT_Call_20Oct23_2800
  • Put: ETH_USDT_Put_20Oct23_2800
| |instrument_hash
ih |string|True|The asset ID used for instrument signing.| |base
b |string|True|The base currency| |quote
q |string|True|The quote currency| |kind
k |Kind|True|The kind of instrument| |venues
v |[Venue]|True|Venues that this instrument can be traded at| |settlement_period
sp1 |InstrumentSettlementPeriod|True|The settlement period of the instrument| |base_decimals
bd |integer|True|The smallest denomination of the base asset supported by GRVT (+3 represents 0.001, -3 represents 1000, 0 represents 1)| |quote_decimals
qd |integer|True|The smallest denomination of the quote asset supported by GRVT (+3 represents 0.001, -3 represents 1000, 0 represents 1)| |tick_size
ts |string|True|The size of a single tick, expressed in price decimal units| |min_size
ms |string|True|The minimum contract size, expressed in base asset decimal units| |create_time
ct |string|True|Creation time in unix nanoseconds| |max_position_size
mp |string|True|The maximum position size, expressed in base asset decimal units| ??? info "Kind" The list of asset kinds that are supported on the GRVT exchange

        |Value| Description |
        |-|-|
        |`PERPETUAL` = 1|the perpetual asset kind|
        |`FUTURE` = 2|the future asset kind|
        |`CALL` = 3|the call option asset kind|
        |`PUT` = 4|the put option asset kind|
    ??? info "[Venue](/../../schemas/venue)"
        The list of Trading Venues that are supported on the GRVT exchange<br>

        |Value| Description |
        |-|-|
        |`ORDERBOOK` = 1|the trade is cleared on the orderbook venue|
        |`RFQ` = 2|the trade is cleared on the RFQ venue|
    ??? info "[InstrumentSettlementPeriod](/../../schemas/instrument_settlement_period)"
        |Value| Description |
        |-|-|
        |`PERPETUAL` = 1|Instrument settles through perpetual funding cycles|
        |`DAILY` = 2|Instrument settles at an expiry date, marked as a daily instrument|
        |`WEEKLY` = 3|Instrument settles at an expiry date, marked as a weekly instrument|
        |`MONTHLY` = 4|Instrument settles at an expiry date, marked as a monthly instrument|
        |`QUARTERLY` = 5|Instrument settles at an expiry date, marked as a quarterly instrument|