# OpenFIGI

> Look up the Financial Instrument Global Identifier (FIGI), the free and open identifier for shares, bonds, funds, options and other securities, with OpenFIGI, the service Bloomberg runs for it. Turn ISINs, CUSIPs, SEDOLs and tickers into FIGIs with each instrument's name, exchange and type, one at a time or ten at once, search instruments by name, and list instruments by exchange, currency or type. No account or API key required.

App · 5 actions. Web page: https://docs.lodol.com/docs/integrations/openfigi

## Actions

### Filter instruments

List every instrument matching keywords or filters, such as all common stock on one exchange or all Apple call options expiring this year, with how many match in all. Lists up to 100 at a time, with a page token for the next ones.

**Inputs**

- Keywords (`query`, text): Words to look for, such as a company name or ticker. Leave empty to list by filters alone.
- Exchange code (`exchange_code`, text): Only instruments on this exchange, by OpenFIGI's code: US for every US exchange together, UN for the New York Stock Exchange, UW for NASDAQ Global Select, LN for London. Use this or MIC code, not both.
- MIC code (`mic_code`, text): Only instruments on this market, by its ISO 10383 market identifier code (MIC), such as XNYS for the New York Stock Exchange or XLON for London. Use this or Exchange code, not both.
- Currency (`currency`, text): Only instruments traded in this currency, such as USD or EUR. GBp is British pence, as London prices shares.
- Market sector (`market_sector`, text): Only instruments in this market sector, such as Equity. One of: `Equity` (Equity (shares, funds, equity options)), `Corp` (Corporate bonds), `Govt` (Government bonds), `Muni` (Municipal bonds), `Mtge` (Mortgage-backed securities), `M-Mkt` (Money market), `Pfd` (Preferred shares), `Comdty` (Commodities), `Curncy` (Currencies), `Index` (Indices).
- Security type (`security_type`, text): Only instruments of this security type, such as Common Stock, ETP (exchange-traded funds and notes), ADR or Equity Option.
- Security type 2 (`security_type_2`, text): Only instruments of this broader security type, such as Common Stock, Option, Future, Bond or Mutual Fund.
- Include unlisted equities (`include_unlisted_equities`, true/false): Also find shares that aren't listed on an exchange, or no longer are. Turn on when a company you expect isn't found. Default: `false`.
- Option type (`option_type`, text): For options: calls, puts, or both. One of: `any` (Calls and puts), `Call` (Calls only), `Put` (Puts only). Default: `any`.
- Strike from (`strike_from`, number): For options: only strike prices of at least this much. At least 0.
- Strike to (`strike_to`, number): For options: only strike prices of at most this much. At least 0.
- Expires from (`expires_from`, date): For options, warrants and futures: only those expiring on or after this date. Alone, it searches the year after it.
- Expires to (`expires_to`, date): For options, warrants and futures: only those expiring on or before this date, at most a year after Expires from. Alone, it searches the year before it.
- Max results (`max_results`, number): The most instruments to list, up to 100. From 1 to 100. Default: `100`.
- Page token (`page_token`, text): To list the next instruments, the next_page_token of an earlier Filter instruments step with the same keywords and filters. Leave empty to start at the beginning.

**Outputs**

- `count` (number): How many instruments are listed here
- `has_more` (true/false): Whether more instruments match after these
- `instruments` (list): The instruments found, in FIGI order (oldest FIGIs first)
- `next_page_token` (text): Put this in the Page token field of another Filter instruments step with the same keywords and filters to list the instruments after these. Empty on the last page
- `query` (text): The keywords searched for, or empty when none were given
- `total` (number): How many instruments match in all

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "instruments": [
    {
      "composite_figi": "BBG01M4BHVG7",
      "details_available": true,
      "exchange_code": "US",
      "exchange_country": "US",
      "exchange_name": "United States",
      "figi": "BBG01M4BHVG7",
      "market_sector": "Equity",
      "name": "December 26 Calls on AAPL US",
      "security_description": "AAPL US 12/18/26 C250",
      "security_type": "Equity Option",
      "security_type_2": "Option",
      "share_class_figi": null,
      "ticker": "AAPL 12/18/26 C250",
      "url": "https://www.openfigi.com/id/BBG01M4BHVG7"
    }
  ],
  "next_page_token": "eyJzdGFydCI6IlFXOUZjMUZyU2toTlJFRjNUVlpLV1ZKcmN6SWdNUT09Lld0cyt2Qi8rampRSEVqWEEvSXBTU3IrbDB5YXcvekdwcnJQRlVId3JXRkE9Iiwic2tpcCI6MH0",
  "query": "AAPL",
  "total": 8
}
```

### List allowed values

List every value OpenFIGI accepts for a field: its identifier types, exchange codes (with each exchange's name and country), MIC codes, currencies, market sectors or security types. Narrow the list with a word.

**Inputs**

- Field (`field`, text, required): Which field's values to list. One of: `id_type` (Identifier types), `exchange_code` (Exchange codes), `mic_code` (MIC codes (ISO market identifiers)), `currency` (Currencies), `market_sector` (Market sectors), `security_type` (Security types), `security_type_2` (Security types 2 (broader)).
- Contains (`contains`, text): Only values, or exchange names, containing this text, in any capitals. Leave empty for every value.

**Outputs**

- `count` (number): How many values are listed here
- `field` (text): The field listed, such as exchange_code or currency
- `field_name` (text): The field's name, such as Exchange codes
- `total` (number): How many values the field accepts in all, before the Contains filter
- `values` (list): The values the field accepts, A to Z

**Example output**

```json
{
  "count": 3,
  "field": "exchange_code",
  "field_name": "Exchange codes",
  "total": 1109,
  "values": [
    {
      "description": "New York SE (US)",
      "value": "UN"
    },
    {
      "description": "United States (US)",
      "value": "US"
    },
    {
      "description": "NASDAQ Global Select Market (US)",
      "value": "UW"
    }
  ]
}
```

### Map an identifier to FIGIs

Look up an ISIN, CUSIP, SEDOL, ticker, FIGI or another identifier and get the instruments it names, one per exchange: each one's FIGI, composite and share class FIGIs, name, ticker, exchange and security type. Add an exchange code, such as US, to get just that listing.

**Inputs**

- Identifier type (`id_type`, text, required): What kind of identifier you have. One of: `ID_ISIN` (ISIN), `ID_CUSIP` (CUSIP), `ID_SEDOL` (SEDOL), `TICKER`, `ID_BB_GLOBAL` (FIGI), `COMPOSITE_ID_BB_GLOBAL` (Composite FIGI), `ID_BB_GLOBAL_SHARE_CLASS_LEVEL` (Share class FIGI), `ID_WERTPAPIER` (WKN (German securities code)), `ID_COMMON` (Common Code (Euroclear and Clearstream)), `ID_CINS` (CINS (CUSIP for non-US securities)), and 16 more.
- Identifier (`id_value`, text, required): The identifier itself, such as the ISIN US0378331005 or the ticker AAPL. Capitals and spaces in codes are tidied up for you.
- Exchange code (`exchange_code`, text): Only instruments on this exchange, by OpenFIGI's code: US for every US exchange together, UN for the New York Stock Exchange, UW for NASDAQ Global Select, LN for London. Use this or MIC code, not both.
- MIC code (`mic_code`, text): Only instruments on this market, by its ISO 10383 market identifier code (MIC), such as XNYS for the New York Stock Exchange or XLON for London. Use this or Exchange code, not both.
- Currency (`currency`, text): Only instruments traded in this currency, such as USD or EUR. GBp is British pence, as London prices shares.
- Market sector (`market_sector`, text): Only instruments in this market sector, such as Equity. One of: `Equity` (Equity (shares, funds, equity options)), `Corp` (Corporate bonds), `Govt` (Government bonds), `Muni` (Municipal bonds), `Mtge` (Mortgage-backed securities), `M-Mkt` (Money market), `Pfd` (Preferred shares), `Comdty` (Commodities), `Curncy` (Currencies), `Index` (Indices).
- Security type (`security_type`, text): Only instruments of this security type, such as Common Stock, ETP (exchange-traded funds and notes), ADR or Equity Option.
- Security type 2 (`security_type_2`, text): Only instruments of this broader security type, such as Common Stock, Option, Future, Bond or Mutual Fund. Needed for a base ticker or a local exchange symbol, where Common Stock is the usual choice.
- Include unlisted equities (`include_unlisted_equities`, true/false): Also find shares that aren't listed on an exchange, or no longer are. Turn on when a company you expect isn't found. Default: `false`.
- Max results (`max_results`, number): The most instruments to list. An ISIN can name hundreds, one per trading venue; the total is always given. From 1 to 1000. Default: `100`.

**Outputs**

- `composite_figi` (text): The first instrument's composite FIGI (its listings in one country), or empty
- `count` (number): How many instruments are listed here
- `figi` (text): The first instrument's FIGI, the one to use when you need just one, or empty when nothing was found. Add an exchange code to choose the listing it comes from
- `found` (true/false): Whether OpenFIGI found at least one instrument
- `has_more` (true/false): Whether OpenFIGI found more instruments than are listed; raise the maximum or add filters to see them
- `id_type` (text): The kind of identifier looked up, as OpenFIGI names it, such as ID_ISIN, ID_CUSIP or TICKER
- `id_value` (text): The identifier looked up, as sent to OpenFIGI (codes in capitals), such as US0378331005
- `instruments` (list): The instruments with this identifier, one per trading venue, first match first
- `message` (text): Why nothing was found, such as no instrument having this identifier with these filters. Empty when something was found
- `name` (text): The first instrument's name, such as APPLE INC, or empty
- `share_class_figi` (text): The first instrument's share class FIGI (its listings in every country), or empty
- `ticker` (text): The first instrument's ticker, such as AAPL, or empty
- `total` (number): How many instruments OpenFIGI found in all, which can be more than are listed

**Example output**

```json
{
  "composite_figi": "BBG000B9XRY4",
  "count": 2,
  "figi": "BBG000B9XRY4",
  "found": true,
  "has_more": true,
  "id_type": "ID_ISIN",
  "id_value": "US0378331005",
  "instruments": [
    {
      "composite_figi": "BBG000B9XRY4",
      "details_available": true,
      "exchange_code": "US",
      "exchange_country": "US",
      "exchange_name": "United States",
      "figi": "BBG000B9XRY4",
      "market_sector": "Equity",
      "name": "APPLE INC",
      "security_description": "AAPL",
      "security_type": "Common Stock",
      "security_type_2": "Common Stock",
      "share_class_figi": "BBG001S5N8V8",
      "ticker": "AAPL",
      "url": "https://www.openfigi.com/id/BBG000B9XRY4"
    },
    {
      "composite_figi": "BBG000B9XRY4",
      "details_available": true,
      "exchange_code": "UW",
      "exchange_country": "US",
      "exchange_name": "NASDAQ Global Select Market",
      "figi": "BBG000B9Y5X2",
      "market_sector": "Equity",
      "name": "APPLE INC",
      "security_description": "AAPL",
      "security_type": "Common Stock",
      "security_type_2": "Common Stock",
      "share_class_figi": "BBG001S5N8V8",
      "ticker": "AAPL",
      "url": "https://www.openfigi.com/id/BBG000B9Y5X2"
    }
  ],
  "message": null,
  "name": "APPLE INC",
  "share_class_figi": "BBG001S5N8V8",
  "ticker": "AAPL",
  "total": 301
}
```

### Map identifiers in bulk

Look up to 10 identifiers in one step, such as TICKER:AAPL US or ISIN:US0378331005, each answered on its own with its FIGIs and instrument details. One that isn't found or isn't valid is reported without stopping the rest.

**Inputs**

- Identifiers (`identifiers`, list, required): Up to 10 identifiers, one per line, each as TYPE:VALUE, optionally followed by an exchange code and a market sector the way Bloomberg writes them: TICKER:AAPL US Equity, ISIN:US0378331005, CUSIP:037833100, SEDOL:2046251, FIGI:BBG000BLNNH6. A list of OpenFIGI job objects works too.
- Default identifier type (`default_id_type`, text): The kind of identifier for lines that don't start with one, such as a pasted column of ISINs. One of: `ID_ISIN` (ISIN), `ID_CUSIP` (CUSIP), `ID_SEDOL` (SEDOL), `TICKER`, `ID_BB_GLOBAL` (FIGI), `COMPOSITE_ID_BB_GLOBAL` (Composite FIGI), `ID_BB_GLOBAL_SHARE_CLASS_LEVEL` (Share class FIGI), `ID_WERTPAPIER` (WKN (German securities code)), `ID_COMMON` (Common Code (Euroclear and Clearstream)), `ID_CINS` (CINS (CUSIP for non-US securities)), and 16 more.
- Exchange code (`exchange_code`, text): Only listings on this exchange, for every identifier that doesn't name its own: US for every US exchange together, LN for London.
- Include unlisted equities (`include_unlisted_equities`, true/false): Also find shares that aren't listed on an exchange, or no longer are. Turn on when a company you expect isn't found. Default: `false`.
- Max results per identifier (`max_results_per_identifier`, number): The most instruments to list for each identifier; the total is always given. From 1 to 100. Default: `10`.

**Outputs**

- `count` (number): How many entries were looked up
- `error_count` (number): How many entries could not be looked up, each with its reason in message
- `figis` (list): The first FIGI found for each entry that was found, in order
- `found_count` (number): How many entries OpenFIGI found instruments for
- `not_found_count` (number): How many entries OpenFIGI found nothing for
- `results` (list): One result per entry, in the order given

**Example output**

```json
{
  "count": 3,
  "error_count": 1,
  "figis": [
    "BBG000B9XRY4",
    "BBG000C6K6G9"
  ],
  "found_count": 2,
  "not_found_count": 0,
  "results": [
    {
      "composite_figi": "BBG000B9XRY4",
      "count": 1,
      "exchange_code": "US",
      "figi": "BBG000B9XRY4",
      "found": true,
      "has_more": false,
      "id_type": "TICKER",
      "id_value": "AAPL",
      "input": "TICKER:AAPL US",
      "instruments": [
        {
          "composite_figi": "BBG000B9XRY4",
          "details_available": true,
          "exchange_code": "US",
          "exchange_country": "US",
          "exchange_name": "United States",
          "figi": "BBG000B9XRY4",
          "market_sector": "Equity",
          "name": "APPLE INC",
          "security_description": "AAPL",
          "security_type": "Common Stock",
          "security_type_2": "Common Stock",
          "share_class_figi": "BBG001S5N8V8",
          "ticker": "AAPL",
          "url": "https://www.openfigi.com/id/BBG000B9XRY4"
        }
      ],
      "message": null,
      "name": "APPLE INC",
      "share_class_figi": "BBG001S5N8V8",
      "status": "found",
      "ticker": "AAPL",
      "total": 1
    },
    {
      "composite_figi": "BBG000C6K5W3",
      "count": 1,
      "exchange_code": "LN",
      "figi": "BBG000C6K6G9",
      "found": true,
      "has_more": false,
      "id_type": "TICKER",
      "id_value": "VOD",
      "input": "TICKER:VOD LN",
      "instruments": [
        {
          "composite_figi": "BBG000C6K5W3",
          "details_available": true,
          "exchange_code": "LN",
          "exchange_country": "GB",
          "exchange_name": "London SE Domestic",
          "figi": "BBG000C6K6G9",
          "market_sector": "Equity",
          "name": "VODAFONE GROUP PLC",
          "security_description": "VOD",
          "security_type": "Common Stock",
          "security_type_2": "Common Stock",
          "share_class_figi": "BBG001S6PJ31",
          "ticker": "VOD",
          "url": "https://www.openfigi.com/id/BBG000C6K6G9"
        }
      ],
      "message": null,
      "name": "VODAFONE GROUP PLC",
      "share_class_figi": "BBG001S6PJ31",
      "status": "found",
      "ticker": "VOD",
      "total": 1
    },
    {
      "composite_figi": null,
      "count": 0,
      "exchange_code": null,
      "figi": null,
      "found": false,
      "has_more": false,
      "id_type": "ID_ISIN",
      "id_value": "XX0000000000",
      "input": "ISIN:XX0000000000",
      "instruments": [],
      "message": "OpenFIGI says 'XX0000000000' is not a valid ISIN. Check the value and the identifier type.",
      "name": null,
      "share_class_figi": null,
      "status": "error",
      "ticker": null,
      "total": 0
    }
  ]
}
```

### Search instruments

Find shares, bonds, funds, options and other instruments by keywords, such as a company name or ticker, narrowed by exchange, currency, market sector, security type or option details. Gives up to 100 best matches with their FIGIs.

**Inputs**

- Keywords (`query`, text, required): Words to search for, up to 12: a company or issuer name, a ticker, or both.
- Exchange code (`exchange_code`, text): Only instruments on this exchange, by OpenFIGI's code: US for every US exchange together, UN for the New York Stock Exchange, UW for NASDAQ Global Select, LN for London. Use this or MIC code, not both.
- MIC code (`mic_code`, text): Only instruments on this market, by its ISO 10383 market identifier code (MIC), such as XNYS for the New York Stock Exchange or XLON for London. Use this or Exchange code, not both.
- Currency (`currency`, text): Only instruments traded in this currency, such as USD or EUR. GBp is British pence, as London prices shares.
- Market sector (`market_sector`, text): Only instruments in this market sector, such as Equity. One of: `Equity` (Equity (shares, funds, equity options)), `Corp` (Corporate bonds), `Govt` (Government bonds), `Muni` (Municipal bonds), `Mtge` (Mortgage-backed securities), `M-Mkt` (Money market), `Pfd` (Preferred shares), `Comdty` (Commodities), `Curncy` (Currencies), `Index` (Indices).
- Security type (`security_type`, text): Only instruments of this security type, such as Common Stock, ETP (exchange-traded funds and notes), ADR or Equity Option.
- Security type 2 (`security_type_2`, text): Only instruments of this broader security type, such as Common Stock, Option, Future, Bond or Mutual Fund.
- Include unlisted equities (`include_unlisted_equities`, true/false): Also find shares that aren't listed on an exchange, or no longer are. Turn on when a company you expect isn't found. Default: `false`.
- Option type (`option_type`, text): For options: calls, puts, or both. One of: `any` (Calls and puts), `Call` (Calls only), `Put` (Puts only). Default: `any`.
- Strike from (`strike_from`, number): For options: only strike prices of at least this much. At least 0.
- Strike to (`strike_to`, number): For options: only strike prices of at most this much. At least 0.
- Expires from (`expires_from`, date): For options, warrants and futures: only those expiring on or after this date. Alone, it searches the year after it.
- Expires to (`expires_to`, date): For options, warrants and futures: only those expiring on or before this date, at most a year after Expires from. Alone, it searches the year before it.
- Max results (`max_results`, number): The most instruments to list, up to 100. From 1 to 100. Default: `20`.

**Outputs**

- `count` (number): How many instruments are listed here
- `has_more` (true/false): Whether OpenFIGI has more matches than are listed; narrow the search with filters, or use Filter instruments to page through them all
- `instruments` (list): The instruments found, best matches first
- `query` (text): The keywords searched for, or empty when none were given

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "instruments": [
    {
      "composite_figi": "BBG000B9XRY4",
      "details_available": true,
      "exchange_code": "US",
      "exchange_country": "US",
      "exchange_name": "United States",
      "figi": "BBG000B9XRY4",
      "market_sector": "Equity",
      "name": "APPLE INC",
      "security_description": "AAPL",
      "security_type": "Common Stock",
      "security_type_2": "Common Stock",
      "share_class_figi": "BBG001S5N8V8",
      "ticker": "AAPL",
      "url": "https://www.openfigi.com/id/BBG000B9XRY4"
    }
  ],
  "query": "apple"
}
```
