Skip to main content

py-openfigi

Python client for the OpenFIGI API — map ISINs, tickers, CUSIPs and other identifiers to FIGI codes, and search or filter securities.

Installation

Requires Python 3.14+.

pip install py-openfigi

Usage

Python API

from openfigi import OpenFIGIDataSource, MappingJob, IdType

ds = OpenFIGIDataSource()  # set OPENFIGI_API_KEY env var for higher rate limits

# Resolve by ISIN
security = ds.resolve_query(isin="US0378331005")

# Bulk map identifiers
results = ds.map_identifiers([
    MappingJob(idType=IdType.ID_ISIN, idValue="US0378331005"),
    MappingJob(idType=IdType.TICKER, idValue="AAPL", exchCode="US"),
])

# Search by keyword
items = ds.search("Apple")

CLI

openfigi lookup --isin US0378331005
openfigi lookup --symbol AAPL --exchange US --format json
openfigi lookup --desc "Apple" --limit 5
openfigi manifest    # every command, flag and exit code, for agents

The CLI is built on treaty: output is a JSON envelope when stdout is not a terminal, and failures exit with a typed code:

Exit Code Meaning
2 ARG_ERROR Invalid arguments; nothing was sent
5 NOT_FOUND No security matches
8 AUTH_REQUIRED OPENFIGI_API_KEY was rejected
10 TIMEOUT OpenFIGI did not answer in time
11 RATE_LIMITED Rate limit exceeded; retry after error.retry_after_ms
12 UNAVAILABLE OpenFIGI unreachable or returned HTTP 5xx

Configuration

Env var Description
OPENFIGI_API_KEY Optional API key for higher rate limits

License

MIT

Metadata

Release files for py-openfigi2 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-openfigi2 0.2.1
File Size Uploaded
py_openfigi2-0.2.1.tar.gz 12.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for py-openfigi2 0.2.1
File Interpreter ABI Platform
py_openfigi2-0.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 23.9 kB

Release files / py_openfigi2-0.2.1.tar.gz

Download URL py_openfigi2-0.2.1.tar.gz
Size 12.7 kB
Tags Source
SHA-256 checksum
How to use checksums
90396a7b3e9b7201f27b52df3cc2bee21f8908121981d3cbd4c94294f5b98534
BLAKE2b-256 checksum
How to use checksums
43be9598ed13492b668f5c7c78c7afc761bf33973091ffb83f8285441914fd56
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.22 {"installer":{"name":"uv","version":"0.12.22","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / py_openfigi2-0.2.1-py3-none-any.whl

Download URL py_openfigi2-0.2.1-py3-none-any.whl
Size 11.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eea31b30b643c5d2249b035186cd7720fbc4bacfab21e26747e2c0f42c140b96
BLAKE2b-256 checksum
How to use checksums
e83c7afdadf7c3a399f162ba93a2c104eebd38d431931373f8a6cc5691edae51
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.22 {"installer":{"name":"uv","version":"0.12.22","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2.0

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page