OpenFIGI API

https://www.openfigi.com/api/documentation
Admin
The OpenFIGI API provides a free and public service for mapping third-party financial identifiers to...
Tokens:10,535
Snippets:47
Trust Score:9.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Request with start for Pagination

Source: https://www.openfigi.com/api/documentation

JSON request to retrieve the next page of results. The 'start' property is set to the value from the 'next' property of the previous response. This example uses the same 'exchCode' filter as the initial request.

```json
{
    "exchCode": "US",
    "start": "QW9JSVFEOFMrQ3hDUWtjd01ERTRTMHhhUXpBPSAx.3AG33VCsv54AsUl5fGHehSytWPuWLJxf0t8VL3YXuJh="
}
```

--------------------------------

### Sample Response for /v3/mapping/values/:key

Source: https://www.openfigi.com/api/documentation

Example JSON response from the /v3/mapping/values/:key endpoint. Contains a values array listing the current possible values for the requested key.

```json
{
    "values": [
        "Comdty",
        "Corp",
        "Curncy",
        "Equity",
        "Govt",
        "Index",
        "M-Mkt",
        "Mtge",
        "Muni",
        "Pfd"
    ]
}     
```

--------------------------------

### Search request with start property for pagination

Source: https://www.openfigi.com/api/documentation

Request to retrieve the next page of results. The 'start' property is set to the value of the 'next' property from the previous response. This process can be repeated as long as 'next' appears.

```json
{
    "query": "ibm",
    "exchCode": "US",
    "start": "QW9JSVFEOFMrQ3hDUWtjd01ERTRTMHhhUXpBPSAx.3AG33VCsv54AsUl5fGHehSytWPuWLJxf0t8VL3YXuJh="
}
```

--------------------------------

### Sample Request for /v3/mapping/values/:key

Source: https://www.openfigi.com/api/documentation

Example request to the /v3/mapping/values/:key endpoint. The key is the name of the Mapping Job property for which to list possible values.

```http
/v3/mapping/values/marketSecDes
```

--------------------------------

### Sample search response with data and next properties

Source: https://www.openfigi.com/api/documentation

Example response from POST /v3/search. Contains a 'data' array with FIGI objects and a 'next' property indicating more results are available. The 'data' array works as in POST /v3/mapping.

```json
{
    "data": [{
        "figi": "BBG000BLNNH6",
        "name": "INTL BUSINESS MACHINES CORP",
        "ticker": "IBM",
        "exchCode": "US",
        "compositeFIGI": "BBG000BLNNH6",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "shareClassFIGI": "BBG001S5S399",
        "securityType2": "Common Stock",
        "securityDescription": "IBM"
    }, {
        "figi": "BBG0002ZTPD8",
        "name": "March 10 Calls on IBM US",
        "ticker": "IBM 03/20/10 C105",
        "exchCode": "US",
        "compositeFIGI": "BBG0002ZTPD8",
        "securityType": "Equity Option",
        "marketSector": "Equity",
        "shareClassFIGI": null,
        "securityType2": "Option",
        "securityDescription": "IBM US 03/20/10 C105"
    }
        ...
    ],
    "next": "QW9JSVFEOFMrQ3hDUWtjd01ERTRTMHhhUXpBPSAx.3AG33VCsv54AsUl5fGHehSytWPuWLJxf0t8VL3YXuJh="
}
```

--------------------------------

### Sample search request for IBM with exchCode US

Source: https://www.openfigi.com/api/documentation

Example request body for POST /v3/search. Uses 'query' and 'exchCode' properties. The 'exchCode' filter works as in POST /v3/mapping.

```json
{
    "query": "ibm",
    "exchCode": "US"
}
```

--------------------------------

### Sample Mapping Response

Source: https://www.openfigi.com/api/documentation

Example JSON response from the mapping endpoint. Shows an array of objects, each corresponding to a mapping job, with data arrays containing FIGI details or an error property.

```json
[{
    "data": [{
        "figi": "BBG000NHN466",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "ticker": "IBMGBX",
        "name": "INTL BUSINESS MACHINES CORP",
        "exchCode": "EU",
        "shareClassFIGI": "BBG001S5S399",
        "compositeFIGI": "BBG000NHN304",
        "securityType2": "Common Stock",
        "securityDescription": "IBMGBX"
    }, {
        "figi": "BBG000NRMJ71",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "ticker": "IBMGBX",
        "name": "INTL BUSINESS MACHINES CORP",
        "exchCode": "XL",
        "shareClassFIGI": "BBG001S5S399",
        "compositeFIGI": "BBG000NRMD01",
        "securityType2": "Common Stock",
        "securityDescription": "IBMGBX"
    }]
}, {
    "data": [{
        "figi": "BBG009R4CLR3",
        "marketSector": "Govt",
        "securityType": "US GOVERNMENT",
        "ticker": "T 2 08/15/25",
        "name": "US TREASURY N/B",
        "exchCode": "BERLIN",
        "securityDescription": "T 2 08/15/25",
        "securityType2": "Note",
        "compositeFIGI": null,
        "shareClassFIGI": null,
    }]
},
{
    "error": "No identifier found."
},
...
]    
```

--------------------------------

### Sample Response for POST /v3/filter

Source: https://www.openfigi.com/api/documentation

Example JSON response from POST /v3/filter. Contains a 'data' array with FIGI objects, a 'next' property for pagination, and a 'total' count. The 'next' property appears when more results are accessible.

```json
{
    "data": [{
        "figi": "BBG000BLNNH6",
        "name": "INTL BUSINESS MACHINES CORP",
        "ticker": "IBM",
        "exchCode": "US",
        "compositeFIGI": "BBG000BLNNH6",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "shareClassFIGI": "BBG001S5S399",
        "securityType2": "Common Stock",
        "securityDescription": "IBM"
    }, {
        "figi": "BBG0002ZTPD8",
        "name": "March 10 Calls on IBM US",
        "ticker": "IBM 03/20/10 C105",
        "exchCode": "US",
        "compositeFIGI": "BBG0002ZTPD8",
        "securityType": "Equity Option",
        "marketSector": "Equity",
        "shareClassFIGI": null,
        "securityType2": "Option",
        "securityDescription": "IBM US 03/20/10 C105"
    }
        ...
    ],
    "next": "QW9JSVFEOFMrQ3hDUWtjd01ERTRTMHhhUXpBPSAx.3AG33VCsv54AsUl5fGHehSytWPuWLJxf0t8VL3YXuJh=",
    "total": 29930312
}
```

--------------------------------

### Sample Mapping Request

Source: https://www.openfigi.com/api/documentation

Example JSON array of mapping jobs for the OpenFIGI API. Each object specifies an idType and idValue, with optional fields like exchCode, currency, micCode, securityType2, expiration, strike, marketSecDes, maturity, and includeUnlistedEquities.

```json
[
    { "idType":"ID_BB_GLOBAL", "idValue":"BBG000BLNNH6"},
    { "idType":"TICKER", "idValue":"IBM", "exchCode":"US"},
    { "idType":"ID_BB_UNIQUE", "idValue":"EQ0010080100001000", "currency":"USD"},
    { "idType":"COMPOSITE_ID_BB_GLOBAL", "idValue":"BBG000BLNNH6", "micCode":"XNYS", "currency":"USD"},
    { "idType":"BASE_TICKER", "idValue":"TSLA 10 C100", "securityType2":"Option", "expiration":["2018-10-01", "2018-12-01"]},
    { "idType":"BASE_TICKER", "idValue":"NFLX 9 P330", "marketSecDes":"Equity", "securityType2":"Option", "strike":[330,null], "expiration":["2018-07-01",null]},
    { "idType":"BASE_TICKER", "idValue":"FG", "marketSecDes":"Mtge", "securityType2":"Pool", "maturity":["2019-09-01", "2020-06-01"]},
    { "idType":"BASE_TICKER", "idValue":"IBM", "marketSecDes":"Corp", "securityType2":"Corp", "maturity":["2026-11-01",null]},
    { "idType":"BASE_TICKER", "idValue":"2251Q", "securityType2":"Common Stock", "includeUnlistedEquities": true}
]     
```

--------------------------------

### Sample Request for POST /v3/filter

Source: https://www.openfigi.com/api/documentation

A minimal JSON request object for the POST /v3/filter endpoint, using only the 'exchCode' filter. All properties are optional; this example filters by exchange code 'US'.

```json
{
    "exchCode": "US"
}
```

--------------------------------

### Example JSON response for mapping request

Source: https://www.openfigi.com/api/documentation

Shows the JSON response returned by the mapping request. It contains an array with a data object that includes the FIGI, security type, market sector, ticker, name, exchange code, share class FIGI, composite FIGI, security type 2, and security description.

```json
[{
    "data": [{
        "figi": "BBG000BLNNH6",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "ticker": "IBM",
        "name": "INTL BUSINESS MACHINES CORP",
        "exchCode": "US",
        "shareClassFIGI": "BBG001S5S399",
        "compositeFIGI": "BBG000BLNNH6",
        "securityType2": "Common Stock",
        "securityDescription": "IBM"
    }]
}]

```

--------------------------------

### GET /v3/mapping/values/:key

Source: https://www.openfigi.com/api/documentation

Retrieves the current list of possible values for enum-like properties used in mapping jobs, such as idType, exchCode, micCode, currency, marketSecDes, securityType, securityType2, and stateCode.

```APIDOC
## GET /v3/mapping/values/:key

### Description
Retrieves the current list of possible values for enum-like properties used in mapping jobs, such as idType, exchCode, micCode, currency, marketSecDes, securityType, securityType2, and stateCode.

### Method
GET

### Endpoint
/v3/mapping/values/:key

### Parameters
#### Path Parameters
- **key** (String) - Required - The name of the Mapping Job property for which to list the possible values. Must be one of: idType, exchCode, micCode, currency, marketSecDes, securityType, securityType2, stateCode.

### Request Example
```
/v3/mapping/values/marketSecDes
```

### Response
#### Success Response (200)
The response is an object with one of the following properties:
- **values** (Array of String) - The current list of values for the specified property.
- **error** (String) - Present when there was an error processing the request.
- **warning** (String) - Present when no FIGI is found.

#### Response Example
```
{
    "values": [
        "Comdty",
        "Corp",
        "Curncy",
        "Equity",
        "Govt",
        "Index",
        "M-Mkt",
        "Mtge",
        "Muni",
        "Pfd"
    ]
}     
```
```

--------------------------------

### curl POST request to OpenFIGI mapping API with API key

Source: https://www.openfigi.com/api/documentation

Sends a POST request to the OpenFIGI mapping endpoint with an API key in the X-OPENFIGI-APIKEY header. The request body contains a JSON array with a single mapping job for ticker IBM on exchange US. Requires a valid API key to get higher rate limits and request size.

```bash
curl 'https://api.openfigi.com/v3/mapping' \
    --request POST \
    --header 'Content-Type: application/json' \
    --header 'X-OPENFIGI-APIKEY: abcdefghijklmnopqrstuvwxyz' \
    --data '[{"idType":"TICKER","idValue":"IBM","exchCode":"US"}]'

```

--------------------------------

### POST /v3/filter

Source: https://www.openfigi.com/api/documentation

Search for FIGIs using key words and other filters. The results are listed alphabetically by FIGI and include the number of results. The endpoint supports pagination via a 'next' token.

```APIDOC
## POST /v3/filter

### Description
Search for FIGIs using key words and other filters. The results are listed alphabetically by FIGI and include the number of results.

### Method
POST

### Endpoint
/v3/filter

### Parameters
#### Request Body
- **query** (String) - Optional - Key words.
- **start** (String) - Optional - The number of results returned for any given request is fixed. When more results are accessible, the response will contain a next property whose value should be sent in succeeding requests as the value of the start property.
- **exchCode, micCode, currency, marketSecDes, securityType, securityType2, includeUnlistedEquities, optionType, strike, contractSize, coupon, expiration, maturity, stateCode** - Optional - All of these properties are optional but otherwise work exactly as in POST /v3/mapping.

### Request Example
{
    "exchCode": "US"
}

### Response
#### Success Response
- **data** (Array of Objects) - Works exactly as in the response of POST /v3/mapping.
- **error** (String) - Works exactly as in the response of POST /v3/mapping.
- **next** (String) - Present when more results are accessible for the query.

#### Response Example
{
    "data": [{
        "figi": "BBG000BLNNH6",
        "name": "INTL BUSINESS MACHINES CORP",
        "ticker": "IBM",
        "exchCode": "US",
        "compositeFIGI": "BBG000BLNNH6",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "shareClassFIGI": "BBG001S5S399",
        "securityType2": "Common Stock",
        "securityDescription": "IBM"
    }, {
        "figi": "BBG0002ZTPD8",
        "name": "March 10 Calls on IBM US",
        "ticker": "IBM 03/20/10 C105",
        "exchCode": "US",
        "compositeFIGI": "BBG0002ZTPD8",
        "securityType": "Equity Option",
        "marketSector": "Equity",
        "shareClassFIGI": null,
        "securityType2": "Option",
        "securityDescription": "IBM US 03/20/10 C105"
    }
        ...
    ],
    "next": "QW9JSVFEOFMrQ3hDUWtjd01ERTRTMHhhUXpBPSAx.3AG33VCsv54AsUl5fGHehSytWPuWLJxf0t8VL3YXuJh=",
    "total": 29930312
}

### Pagination
When the response contains a `next` property, more results are accessible. To retrieve them, send the same request with the `start` property set to the value of `next`.

#### Example Pagination Request
{
    "exchCode": "US",
    "start": "QW9JSVFEOFMrQ3hDUWtjd01ERTRTMHhhUXpBPSAx.3AG33VCsv54AsUl5fGHehSytWPuWLJxf0t8VL3YXuJh="
}
```

--------------------------------

### curl POST mapping request to api.openfigi.com/v3/mapping

Source: https://www.openfigi.com/api/documentation

Sends a mapping request using curl. The request uses POST with Content-Type application/json and a JSON array containing an object with idType ID_BB_GLOBAL and idValue BBG000BLNNH6. Unauthenticated traffic is rate-limited; an API key provides a higher limit.

```bash
curl 'https://api.openfigi.com/v3/mapping' \
    --request POST \
    --header 'Content-Type: application/json' \
    --data '[{"idType":"ID_BB_GLOBAL","idValue":"BBG000BLNNH6"}]'

```

--------------------------------

### POST /v3/search

Source: https://www.openfigi.com/api/documentation

Search for FIGIs using key words and other filters. The request body includes a query string and optional filters, and the response provides data, error, and pagination information.

```APIDOC
## POST /v3/search

### Description
Search for FIGIs using key words and other filters.

### Method
POST

### Endpoint
/v3/search

### Parameters
#### Request Body
- **query** (String) - Optional - Key words.
- **start** (String) - Optional - The number of results returned for any given request is fixed. When more results are accessible, the response will contain a next property whose value should be sent in succeeding requests as the value of the start property. This will notify the API to return the next "page" of results.
- **exchCode**, **micCode**, **currency**, **marketSecDes**, **securityType**, **securityType2**, **includeUnlistedEquities**, **optionType**, **strike**, **contractSize**, **coupon**, **expiration**, **maturity**, **stateCode** - Optional - All of these properties are optional but otherwise work exactly as in POST /v3/mapping.

### Request Example
{
    "query": "ibm",
    "exchCode": "US"
}

### Response
#### Success Response
- **data** (Array of Objects) - Works exactly as in the response of POST /v3/mapping.
- **error** (String) - Works exactly as in the response of POST /v3/mapping.
- **next** (String) - Present when more results are accessible for the query. To get the next "page" of results for the query, send the same search request except with the start property's value set to the value provided here.

#### Response Example
{
    "data": [{
        "figi": "BBG000BLNNH6",
        "name": "INTL BUSINESS MACHINES CORP",
        "ticker": "IBM",
        "exchCode": "US",
        "compositeFIGI": "BBG000BLNNH6",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "shareClassFIGI": "BBG001S5S399",
        "securityType2": "Common Stock",
        "securityDescription": "IBM"
    }, {
        "figi": "BBG0002ZTPD8",
        "name": "March 10 Calls on IBM US",
        "ticker": "IBM 03/20/10 C105",
        "exchCode": "US",
        "compositeFIGI": "BBG0002ZTPD8",
        "securityType": "Equity Option",
        "marketSector": "Equity",
        "shareClassFIGI": null,
        "securityType2": "Option",
        "securityDescription": "IBM US 03/20/10 C105"
    }
        ...
    ],
    "next": "QW9JSVFEOFMrQ3hDUWtjd01ERTRTMHhhUXpBPSAx.3AG33VCsv54AsUl5fGHehSytWPuWLJxf0t8VL3YXuJh="
}
```

--------------------------------

### POST /v3/mapping

Source: https://www.openfigi.com/api/documentation

Maps a list of identifiers to FIGI codes. Each mapping job in the request array is processed and returns an array of results with FIGI data or an error/warning.

```APIDOC
## POST /v3/mapping

### Description
Maps a list of identifiers to FIGI codes. Each mapping job in the request array is processed and returns an array of results with FIGI data or an error/warning.

### Method
POST

### Endpoint
/v3/mapping

### Parameters
#### Request Body
The request body is an array of mapping job objects. Each object contains the following properties:
- **idType** (String) - Required - The type of identifier being provided. Possible values include: ID_BB_GLOBAL, TICKER, ID_BB_UNIQUE, COMPOSITE_ID_BB_GLOBAL, BASE_TICKER.
- **idValue** (String) - Required - The identifier value to map.
- **exchCode** (String) - Optional - Exchange code (e.g., "US").
- **currency** (String) - Optional - Currency code (e.g., "USD").
- **micCode** (String) - Optional - Market Identifier Code (e.g., "XNYS").
- **securityType2** (String) - Optional - Security type (e.g., "Option", "Pool", "Corp", "Common Stock").
- **expiration** (Array of String) - Optional - Expiration date range (e.g., ["2018-10-01", "2018-12-01"]).
- **marketSecDes** (String) - Optional - Market sector description (e.g., "Equity", "Mtge", "Corp").
- **strike** (Array of Number) - Optional - Strike price range (e.g., [330, null]).
- **maturity** (Array of String) - Optional - Maturity date range (e.g., ["2019-09-01", "2020-06-01"]).
- **includeUnlistedEquities** (Boolean) - Optional - Whether to include unlisted equities.

### Request Example
```
[
    { "idType":"ID_BB_GLOBAL", "idValue":"BBG000BLNNH6"},
    { "idType":"TICKER", "idValue":"IBM", "exchCode":"US"},
    { "idType":"ID_BB_UNIQUE", "idValue":"EQ0010080100001000", "currency":"USD"},
    { "idType":"COMPOSITE_ID_BB_GLOBAL", "idValue":"BBG000BLNNH6", "micCode":"XNYS", "currency":"USD"},
    { "idType":"BASE_TICKER", "idValue":"TSLA 10 C100", "securityType2":"Option", "expiration":["2018-10-01", "2018-12-01"]},
    { "idType":"BASE_TICKER", "idValue":"NFLX 9 P330", "marketSecDes":"Equity", "securityType2":"Option", "strike":[330,null], "expiration":["2018-07-01",null]},
    { "idType":"BASE_TICKER", "idValue":"FG", "marketSecDes":"Mtge", "securityType2":"Pool", "maturity":["2019-09-01", "2020-06-01"]},
    { "idType":"BASE_TICKER", "idValue":"IBM", "marketSecDes":"Corp", "securityType2":"Corp", "maturity":["2026-11-01",null]},
    { "idType":"BASE_TICKER", "idValue":"2251Q", "securityType2":"Common Stock", "includeUnlistedEquities": true}
]     
```

### Response
#### Success Response (200)
The response is an array of objects, each corresponding to a mapping job in the request. Each object has one of the following properties:
- **data** (Array of Object) - Present when FIGI(s) are found. Each object contains:
  - **figi** (String) - FIGI assigned to the instrument.
  - **securityType** (String or null) - Security type.
  - **marketSector** (String or null) - Market sector.
  - **exchCode** (String or null) - Exchange code.
  - **securityType2** (String or null) - Secondary security type.
  - **ticker** (String or null) - Ticker symbol.
  - **name** (String or null) - Instrument name.
  - **shareClassFIGI** (String or null) - Share class FIGI.
  - **compositeFIGI** (String or null) - Composite FIGI.
  - **securityDescription** (String or null) - Security description.
  - **metadata** (String) - Present when attributes are unavailable; value is "Metadata N/A".
- **error** (String) - Present when single job result exceeds 15,000 FIGIs or unexpected error.
- **warning** (String) - Present when no FIGI is found.

#### Response Example
```
[{
    "data": [{
        "figi": "BBG000NHN466",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "ticker": "IBMGBX",
        "name": "INTL BUSINESS MACHINES CORP",
        "exchCode": "EU",
        "shareClassFIGI": "BBG001S5S399",
        "compositeFIGI": "BBG000NHN304",
        "securityType2": "Common Stock",
        "securityDescription": "IBMGBX"
    }, {
        "figi": "BBG000NRMJ71",
        "securityType": "Common Stock",
        "marketSector": "Equity",
        "ticker": "IBMGBX",
        "name": "INTL BUSINESS MACHINES CORP",
        "exchCode": "XL",
        "shareClassFIGI": "BBG001S5S399",
        "compositeFIGI": "BBG000NRMD01",
        "securityType2": "Common Stock",
        "securityDescription": "IBMGBX"
    }]
}, {
    "data": [{
        "figi": "BBG009R4CLR3",
        "marketSector": "Govt",
        "securityType": "US GOVERNMENT",
        "ticker": "T 2 08/15/25",
        "name": "US TREASURY N/B",
        "exchCode": "BERLIN",
        "securityDescription": "T 2 08/15/25",
        "securityType2": "Note",
        "compositeFIGI": null,
        "shareClassFIGI": null,
    }]
},
{
    "error": "No identifier found."
},
...
]    
```

### Limits
- Without API key: Maximum 5 mapping jobs per request.
- With API key: Maximum 100 mapping jobs per request.
```
Tokens:
Raw