Skip to main content
POST
/openfigi/instruments

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
id_type
enum<string>
required
Available options:
BARCLAYS_TICKER,
BASE_TICKER,
COMPOSITE_ID_BB_GLOBAL,
ID_BB,
ID_BB_8_CHR,
ID_BB_GLOBAL,
ID_BB_GLOBAL_SHARE_CLASS_LEVEL,
ID_BB_SEC_NUM_DES,
ID_BB_UNIQUE,
ID_CINS,
ID_COMMON,
ID_CUSIP,
ID_CUSIP_8_CHR,
ID_EXCH_SYMBOL,
ID_FULL_EXCHANGE_SYMBOL,
ID_ISIN,
ID_ITALY,
ID_SEDOL,
ID_SHORT_CODE,
ID_TRACE,
ID_WERTPAPIER,
OCC_SYMBOL,
OPRA_SYMBOL,
TICKER,
TRADEBOOK_TICKER,
TRADING_SYSTEM_IDENTIFIER,
UNIQUE_ID_FUT_OPT,
VENDOR_INDEX_CODE
id_value
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
exch_code
string | null
mic_code
string | null
currency
string | null
market_sector
enum<string> | null
Available options:
Comdty,
Corp,
Curncy,
Equity,
Govt,
Index,
M-Mkt,
Mtge,
Muni,
Pfd
security_type
string | null
security_type2
string | null
include_unlisted_equities
boolean | null
option_type
enum<string> | null
Available options:
Call,
Put
state_code
string | null
strike_min
number | null
strike_max
number | null
contract_size_min
number | null
contract_size_max
number | null
coupon_min
number | null
coupon_max
number | null
maturity_start
string | null
maturity_end
string | null
expiration_start
string | null
expiration_end
string | null

Response

Successful Response

figi
string
required
@type
string
default:OpenfigiInstrument
name
string | null
ticker
string | null
exch_code
string | null
composite_figi
string | null
share_class_figi
string | null
security_type
string | null
security_type2
string | null
market_sector
string | null
security_description
string | null