Skip to main content
POST
/
api
/
openfigi
/
instruments
/
search
/openfigi/instruments/search
curl --request POST \
  --url https://api.anysite.io/api/openfigi/instruments/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 2,
  "timeout": 300,
  "exch_code": "US",
  "mic_code": "XNAS",
  "currency": "USD",
  "security_type": "Common Stock",
  "security_type2": "Common Stock",
  "include_unlisted_equities": true,
  "state_code": "NY",
  "strike_min": 100,
  "strike_max": 200,
  "contract_size_min": 100,
  "contract_size_max": 1000,
  "coupon_min": 2.5,
  "coupon_max": 7.5,
  "maturity_start": "2030-01-01",
  "maturity_end": "2040-12-31",
  "expiration_start": "2026-01-01",
  "expiration_end": "2026-12-31"
}
'
[
  {
    "figi": "<string>",
    "@type": "@openfigi_instrument",
    "name": "<string>",
    "ticker": "<string>",
    "exch_code": "<string>",
    "composite_figi": "<string>",
    "share_class_figi": "<string>",
    "security_type": "<string>",
    "security_type2": "<string>",
    "market_sector": "<string>",
    "security_description": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
query
string
required

Free-text search query

Minimum string length: 1
Examples:

"apple"

"ibm"

​
count
integer
required

Number of instrument records to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
exch_code
string | null

Restrict to this exchange code

Example:

"US"

​
mic_code
string | null

Restrict to this ISO market identifier code (MIC)

Example:

"XNAS"

​
currency
string | null

Restrict to this currency

Example:

"USD"

​
market_sector
enum<string> | null

Restrict to this market sector

Available options:
Comdty,
Corp,
Curncy,
Equity,
Govt,
Index,
M-Mkt,
Mtge,
Muni,
Pfd
​
security_type
string | null

Restrict to this security type

Example:

"Common Stock"

​
security_type2
string | null

Restrict to this broad security category

Example:

"Common Stock"

​
include_unlisted_equities
boolean | null

Include unlisted equity instruments

​
option_type
enum<string> | null

Restrict options to this type

Available options:
Call,
Put
​
state_code
string | null

Restrict to this US state code for municipal instruments

Example:

"NY"

​
strike_min
number | null

Lowest option strike price to include

Example:

100

​
strike_max
number | null

Highest option strike price to include

Example:

200

​
contract_size_min
number | null

Smallest contract size to include

Example:

100

​
contract_size_max
number | null

Largest contract size to include

Example:

1000

​
coupon_min
number | null

Lowest bond coupon rate to include

Example:

2.5

​
coupon_max
number | null

Highest bond coupon rate to include

Example:

7.5

​
maturity_start
string | null

Earliest bond maturity date to include (YYYY-MM-DD)

Example:

"2030-01-01"

​
maturity_end
string | null

Latest bond maturity date to include (YYYY-MM-DD)

Example:

"2040-12-31"

​
expiration_start
string | null

Earliest derivative expiration date to include (YYYY-MM-DD)

Example:

"2026-01-01"

​
expiration_end
string | null

Latest derivative expiration date to include (YYYY-MM-DD)

Example:

"2026-12-31"

Response

Successful Response

​
figi
string
required
​
@type
string
default:@openfigi_instrument
​
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