OpenFIGI Python API Docs | dltHub

Build a OpenFIGI-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

The OpenFIGI API allows mapping from third-party identifiers to FIGIs. The base URL is api.openfigi.com, and it's free to use without limitations. For documentation, visit https://www.openfigi.com/api/documentation. The REST API base URL is https://api.openfigi.com/v3 and All requests may be made unauthenticated but authenticated requests require an API key sent in the X-OPENFIGI-APIKEY header (auth provides higher rate limits)..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading OpenFIGI data in under 10 minutes.


What data can I load from OpenFIGI?

Here are some of the endpoints you can load from OpenFIGI:

ResourceEndpointMethodData selectorDescription
mapping_by_id/v3/mapping/{idType}/{idValue}GETdataMap a single identifier by path parameters to FIGIs.
mapping_values/v3/mapping/values/{key}GETvaluesRetrieve allowed enum values for mapping job properties (e.g., exchCode, marketSecDes).
schema/v3/schemaGETReturns the OpenAPI schema for the API.
mapping_values_list/v3/mapping/valuesGETLists all enum keys; response structure varies.
mapping/v3/mappingPOSTBatch mapping of third‑party identifiers to FIGIs (response is an array).
search/v3/searchPOSTdataSearch FIGIs by keywords and filters; supports pagination.
filter/v3/filterPOSTdataFiltered search returning alphabetical results and total count; supports pagination.

How do I authenticate with the OpenFIGI API?

Obtain an OpenFIGI API key from your account page and include it in requests using the header "X-OPENFIGI-APIKEY: <your_api_key>". Unauthenticated requests are allowed but rate‑limited.

1. Get your credentials

  1. Go to https://www.openfigi.com and sign up or sign in to your account.
  2. Open the Account / API Key page after logging in.
  3. Create or view your API key; copy the value.
  4. Use this value in the request header X-OPENFIGI-APIKEY: <your_api_key>.

2. Add them to .dlt/secrets.toml

[sources.openfigi_source] api_key = "your_openfigi_api_key_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.


How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the OpenFIGI API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

python openfigi_pipeline.py

If everything is configured correctly, you'll see output like this:

Pipeline openfigi_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset openfigi_data The duckdb destination used duckdb:/openfigi.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

dlt pipeline openfigi_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.


Python pipeline example

This example loads mapping and mapping_values from the OpenFIGI API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def openfigi_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.openfigi.com/v3", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "mapping", "endpoint": {"path": "v3/mapping"}}, {"name": "mapping_values", "endpoint": {"path": "v3/mapping/values/{key}", "data_selector": "values"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="openfigi_pipeline", destination="duckdb", dataset_name="openfigi_data", ) load_info = pipeline.run(openfigi_source()) print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.


How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("openfigi_pipeline").dataset() sessions_df = data.mapping.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM openfigi_data.mapping LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("openfigi_pipeline").dataset() data.mapping.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.


What destinations can I load OpenFIGI data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.


Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for OpenFIGI?

Request dlt skills, commands, AGENT.md files, and AI-native context.