Skip to main content
POST
/
rest
/
instruments
Get Instrument Details
curl --request POST \
  --url https://api.exchange.fairx.net/rest/instruments \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_codes": "[BIP]",
  "symbols": "[BIPZ30, B*]",
  "instrument_ids": "[1234, 12345]",
  "trading_states": "[PRE_OPEN, EXPIRED]",
  "activation_date": "2026-01-15",
  "expiration_date": "2026-01-15"
}
'
[
  {
    "product_id": 1,
    "instrument_id": 1001,
    "contract_type": "OUTRIGHT",
    "product_group": "CRYPTO",
    "symbol": "BITZ25",
    "product_code": "BIT",
    "trading_state": "OPEN",
    "contract_unit": "Bitcoin",
    "contract_size": 50.5,
    "price_band": 100,
    "price_band_multiplier": 2,
    "price_band_reference_price": 50000.5,
    "max_order_size": 1000,
    "market_order_protection_ticks": 10,
    "short_initial_margin": 5000,
    "long_initial_margin": 5000,
    "price_limit_reference_price": 50000.5,
    "prior_settlement_price": 49500.5,
    "last_end_of_day_settlement_price": 49500.5,
    "low_limit_price": 45000.5,
    "high_limit_price": 55000.5,
    "tick_size": 0.01,
    "activation_time": "2026-01-01T01:00",
    "expiration_time": "2027-01-01T01:00",
    "final_settlement_date": "2026-01-01",
    "first_trading_session_date": "2025-01-01",
    "last_trading_session_date": "2025-12-30",
    "lead_transition_date": "2025-12-01",
    "is_lead": true,
    "is24x7_enabled": true,
    "is_perp": true,
    "fair_value_limit_range": 100,
    "funding_interval_minutes": 10,
    "is_block_eligible": true,
    "block_min_qty": 100,
    "trading_session_date": "2025-12-11",
    "expiry_year": 2025,
    "expiry_month": 12
  }
]

Body

application/json

Optional instrument filter criteria, can be omitted

​
product_codes
string[]
Example:

"[BIP]"

​
symbols
string[]
Example:

"[BIPZ30, B*]"

​
instrument_ids
integer<int32>[]
Example:

"[1234, 12345]"

​
trading_states
enum<string>[]
Available options:
PRE_OPEN,
OPEN,
HALT,
PAUSE,
CLOSE,
PRE_OPEN_NO_CANCEL,
EXPIRED
Example:

"[PRE_OPEN, EXPIRED]"

​
activation_date
string<date>
Example:

"2026-01-15"

​
expiration_date
string<date>
Example:

"2026-01-15"

Response

Successfully retrieved instrument details

​
product_id
integer<int32>
Example:

1

​
instrument_id
integer<int32>
Example:

1001

​
contract_type
enum<string>
Available options:
OUTRIGHT,
CALENDAR_SPREAD,
OPTION
Example:

"OUTRIGHT"

​
product_group
enum<string>
Available options:
CURRENCY,
EQUITY,
ENERGY,
METALS,
INTEREST_RATE,
AGRICULTURE,
CRYPTO
Example:

"CRYPTO"

​
symbol
string
Example:

"BITZ25"

​
product_code
string
Example:

"BIT"

​
trading_state
enum<string>
Available options:
PRE_OPEN,
OPEN,
HALT,
PAUSE,
CLOSE,
PRE_OPEN_NO_CANCEL,
EXPIRED
Example:

"OPEN"

​
contract_unit
string
Example:

"Bitcoin"

​
contract_size
number<double>
Example:

50.5

​
price_band
integer<int32>
Example:

100

​
price_band_multiplier
integer<int32>
Example:

2

​
price_band_reference_price
number<double>
Example:

50000.5

​
max_order_size
integer<int32>
Example:

1000

​
market_order_protection_ticks
integer<int32>
Example:

10

​
short_initial_margin
integer<int32>
Example:

5000

​
long_initial_margin
integer<int32>
Example:

5000

​
price_limit_reference_price
number<double>
Example:

50000.5

​
prior_settlement_price
number<double>
Example:

49500.5

​
last_end_of_day_settlement_price
number<double>
Example:

49500.5

​
low_limit_price
number<double>
Example:

45000.5

​
high_limit_price
number<double>
Example:

55000.5

​
tick_size
number<double>
Example:

0.01

​
activation_time
string<date-time>
Example:

"2026-01-01T01:00"

​
expiration_time
string<date-time>
Example:

"2027-01-01T01:00"

​
final_settlement_date
string<date>
Example:

"2026-01-01"

​
first_trading_session_date
string<date>
Example:

"2025-01-01"

​
last_trading_session_date
string<date>
Example:

"2025-12-30"

​
lead_transition_date
string<date>
Example:

"2025-12-01"

​
is_lead
boolean
Example:

true

​
is24x7_enabled
boolean
Example:

true

​
is_perp
boolean
Example:

true

​
fair_value_limit_range
integer<int32>
Example:

100

​
funding_interval_minutes
integer<int32>
Example:

10

​
is_block_eligible
boolean
Example:

true

​
block_min_qty
integer<int32>
Example:

100

​
trading_session_date
string<date>
Example:

"2025-12-11"

​
expiry_year
integer<int32>
Example:

2025

​
expiry_month
integer<int32>
Example:

12