Market Data

public/get_instrument

Returns the full public definition of one instrument named by instrument_name: type, activation window and active status, tick size, min/max/step amounts, maker/taker/base fee rates, pro-rata matching parameters, base/quote currencies, and type-specific details (option, perp, or spot). Expired options remain queryable by instrument_name. Public endpoint.

post/public/get_instrument

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/public/get_instrument
  • Auth: none declared

Request body

instrument_namestring required

Response

Success

amount_stepstring required
base_asset_addressstring required

The traded asset's contract address — word 0 (asset) of the order action data. Use this (not erc20_details) when signing an order.

base_asset_sub_idstring required

The traded asset's sub-id — word 1 (subId) of the order action data. Decimal string; "0" for perps and spot.

base_currencystring required
base_feestring required
fifo_min_allocationstring required
instrument_namestring required
instrument_type'option' | 'perp' | 'erc20' required

Asset type of the instrument: "option", "perp", or "erc20".

is_activeboolean required
maker_fee_ratestring required
mark_price_fee_rate_capstring nullable
maximum_amountstring required
minimum_amountstring required
pro_rata_amount_stepstring required
pro_rata_fractionstring required
quote_currencystring required
risk_universe_idinteger required

Only subaccounts in this risk universe can trade the instrument.

scheduled_activationinteger required
scheduled_deactivationinteger required
taker_fee_ratestring required
tick_sizestring required

Changes

No recorded changes to this operation across all 1 revision of this API.