# /openfigi/instruments/search

`POST /api/openfigi/instruments/search`

Price: 1 credit

Search OpenFIGI instruments by free text and facet filters

## How to use it

Search the OpenFIGI instrument universe by free text. Optionally narrow by exchange code, MIC, currency, market sector, security type, option type, or by numeric range (option strike, contract size, bond coupon) and date range (bond maturity, derivative expiration). Each result carries figi, name, ticker, exchange code, composite FIGI, share-class FIGI, security type, market sector and security description.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `exch_code` (string, nullable) — Restrict to this exchange code (examples: "US", "LN")
- `mic_code` (string, nullable) — Restrict to this ISO market identifier code (MIC) (examples: "XNAS", "XLON")
- `currency` (string, nullable) — Restrict to this currency (examples: "USD", "EUR")
- `market_sector` (string, nullable) — Restrict to this market sector (one of: "Comdty", "Corp", "Curncy", "Equity", "Govt", "Index", "M-Mkt", "Mtge", "Muni", "Pfd")
- `security_type` (string, nullable) — Restrict to this security type (examples: "Common Stock")
- `security_type2` (string, nullable) — Restrict to this broad security category (examples: "Common Stock")
- `include_unlisted_equities` (boolean, nullable) — Include unlisted equity instruments
- `option_type` (string, nullable) — Restrict options to this type (one of: "Call", "Put")
- `state_code` (string, nullable) — Restrict to this US state code for municipal instruments (examples: "NY", "CA")
- `strike_min` (number, nullable) — Lowest option strike price to include (examples: 100)
- `strike_max` (number, nullable) — Highest option strike price to include (examples: 200)
- `contract_size_min` (number, nullable) — Smallest contract size to include (examples: 100)
- `contract_size_max` (number, nullable) — Largest contract size to include (examples: 1000)
- `coupon_min` (number, nullable) — Lowest bond coupon rate to include (examples: 2.5)
- `coupon_max` (number, nullable) — Highest bond coupon rate to include (examples: 7.5)
- `maturity_start` (string, nullable) — Earliest bond maturity date to include (YYYY-MM-DD) (examples: "2030-01-01")
- `maturity_end` (string, nullable) — Latest bond maturity date to include (YYYY-MM-DD) (examples: "2040-12-31")
- `expiration_start` (string, nullable) — Earliest derivative expiration date to include (YYYY-MM-DD) (examples: "2026-01-01")
- `expiration_end` (string, nullable) — Latest derivative expiration date to include (YYYY-MM-DD) (examples: "2026-12-31")
- `query` (string, required) — Free-text search query (examples: "apple", "ibm"; minLength: 1)
- `count` (integer, required) — Number of instrument records to return (min: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "OpenfigiInstrument")
- `figi` (string, required)
- `name` (string, nullable)
- `ticker` (string, nullable)
- `exch_code` (string, nullable)
- `composite_figi` (string, nullable)
- `share_class_figi` (string, nullable)
- `security_type` (string, nullable)
- `security_type2` (string, nullable)
- `market_sector` (string, nullable)
- `security_description` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.