openfigi

KO | EN

gitlite — search

#react #typescript #llm #golang #android #rust #deep-learning #docker #nodejs #java #kubernetes #vue #mcp #openai

(★ 29)

Simple wrapper and a command-line tool for Bloomberg's OpenFIGI API.

openfigi Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# openfigi

Simple wrapper and a command-line tool for Bloomberg's OpenFIGI API.

The API specification is located at https://www.openfigi.com/api

## Installation

Execute

pip install openfigi

or clone this repository and install the package directly from disk:

git clone https://github.com/jwergieluk/openfigi.git
    cd openfigi
    pip install .

## Usage

>>> import openfigi
    >>> 
    >>> conn = openfigi.OpenFigi("32577205-8353-4cb9-b11e-3b9bbfd1fde2")
    >>> conn.enqueue_request(id_type='ID_WERTPAPIER', id_value='XM91CQ', mic_code='EUWX')
    >>> print(conn.fetch_response())
    [{'idValue': 'XM91CQ', 'micCode': 'EUWX', 'idType': 'ID_WERTPAPIER', 'data': [{'shareClassFIGI': None, 'uniqueIDFutOpt': None, 'uniqueID': 'EQ0000000047042754', 'name': 'DEUTSCH-PW17 DAX INDEX', 'figi': 'BBG00BP732P7', 'exchCode': 'GW', 'marketSector': 'Equity', 'securityType': 'Index WRT', 'ticker': 'XM91CQ', 'securityType2': 'Warrant', 'securityDescription': 'XM91CQ', 'compositeFIGI': 'BBG00BP73295'}]}]

## Cli usage

> ofg --help
    Usage: ofg [OPTIONS] ID_TYPE [ID_VALUES]...
    
      Calls OpenFIGI API
    
      ID_TYPE must be one of the following: 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
      TRADING_SYSTEM_IDENTIFIER UNIQUE_ID_FUT_OPT
    
      ID_VALUES is a list of (space separated) ids corresponding to the specified
      ID_TYPE.
    
    Options:
      --exchange-code TEXT            An optional exchange code if it applies
                                      (cannot use with mic_code).
      --mic-code TEXT                 An optional ISO market identification
                                      code(MIC) if it applies (cannot use with
                                      exchange_code).
      --currency TEXT                 An optional currency if it applies.
      --remove-missing / --no-remove-missing
                                      Remove records with errors.
      --api-version [V1|V2]           The OpenFIGI API version to utilize.
      --help                          Show this message and exit.

Sample call:

$ ofg --mic-code EUWX ID_WERTPAPIER XM91CQ
    [
        {
            "data": [
                {
                    "compositeFIGI": "BBG00BP73295",
                    "exchCode": "GW",
                    "figi": "BBG00BP732P7",
                    "marketSector": "Equity",
                    "name": "DEUTSCH-PW17 DAX INDEX",
                    "securityType": "Index WRT",
                    "shareClassFIGI": null,
                    "ticker": "XM91CQ",
                    "uniqueID": "EQ0000000047042754",
                    "uniqueIDFutOpt": null
                }
            ]
        }
    ]

The cli tool searches for the `openfigi_key` environment variable and uses it to
authenticate the API calls. If `openfigi_key` is not defined, an anonymous access is used.

## Trademarks

'OPENFIGI', 'BLOOMBERG', and 'BLOOMBERG.COM' are trademarks and service marks of
Bloomberg Finance L.P., a Delaware limited partnership, or its subsidiaries.

## Copyright and license

MIT License: see LICENSE file for details.

openfigi

openfigi Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

openfigi

openfigi Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README