No logo available for OKX to DuckDB connector icon

Load OKX data to DuckDB

Build a OKX to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the OKX API base URL, auth, endpoints, and incremental loading.

SourceOKXOKX API DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

OKX is a cryptocurrency exchange platform providing REST APIs for trading and account management. Everything needed to build a working OKX → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.


Build your OKX to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from OKX to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the OKX API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.


OKX API at a glance

Base URLhttps://openapi.okx.com
Example endpointGET api/v5/account/bills
Records found atdata
Authenticationall private requests require four custom headers for request signing and authentication
Also requiredOK-ACCESS-KEY, OK-ACCESS-SIGN, OK-ACCESS-TIMESTAMP, OK-ACCESS-PASSPHRASE
PaginationCursor-based via before, after, page size via limit (default 100, max 100). Pagination uses a cursor-based approach where 'before' and 'after' parameters are used to navigate relative to specific ID or timestamp values. 'after' returns records earlier than the requested value, and 'before' returns records newer than the requested value. The 'limit' parameter controls the number of results per page.
Incremental fieldafter
API referencehttps://www.okx.com/docs-v5/en/

These values come from the OKX API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the OKX API?

All private requests require four custom headers: OK-ACCESS-KEY (API key), OK-ACCESS-SIGN (Base64-encoded HMAC-SHA256 signature), OK-ACCESS-TIMESTAMP (ISO 8601 UTC timestamp), and OK-ACCESS-PASSPHRASE (key passphrase). The signature is generated by signing the concatenated string of timestamp + method + requestPath + body with the API secret key.

1. Get your credentials

To obtain OKX API credentials, log in to your OKX account on the web, navigate to Profile > API and connections, and click Create API key. Provide an API name, select the account and purpose, configure IP address allowlisting (optional but recommended), set the required permissions (e.g., Read, Trade), and enter a secure Passphrase. Upon creation, you will be provided with an API Key, Secret Key, and the Passphrase you defined. Note that the Secret Key and Passphrase cannot be recovered if lost; if you lose them, you must delete the existing key and create a new one. A minimum balance of 100 USD (Assets Under Management) is typically required to create an API key.

2. Add them to .dlt/secrets.toml

[sources.okx_source] api_key = "your_api_key_string" secret_key = "your_secret_key_string" passphrase = "your_passphrase_string"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.


What OKX data can I load into DuckDB?

These are the OKX endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
instruments/api/v5/account/instrumentsGETdataGet list of instruments
balance/api/v5/account/balanceGETdataGet account balance
positions/api/v5/account/positionsGETdataGet account positions
bills/api/v5/account/billsGETdataGet account bills
fills/api/v5/trade/fills-historyGETdataGet trade fills history

How do I load only new OKX records?

OKX exposes after on api/v5/account/bills, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

{"name": "bills", "endpoint": { "path": "api/v5/account/bills", "data_selector": "data", "incremental": {"cursor_path": "after", "initial_value": "2024-01-01T00:00:00Z"}, }}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.


What does the generated OKX pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /api/v5/market/tickers and /api/v5/account/balance from the OKX API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def okx_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://openapi.okx.com", "auth": {"type": "api_key", "api_key": api_key}, }, "resources": [ {"name": "bills", "endpoint": {"path": "api/v5/account/bills", "data_selector": "data"}}, {"name": "fills", "endpoint": {"path": "api/v5/trade/fills-history", "data_selector": "data"}} ], } yield from rest_api_resources(config) def load_okx_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="okx_pipeline", destination="duckdb", dataset_name="okx_data", ) load_info = pipeline.run(okx_source()) print(load_info) if __name__ == "__main__": load_okx_to_duckdb()

Run it with python okx_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.


How do I query OKX data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("okx_pipeline").dataset() df = data.bills.df() print(df.head())

SQL:

SELECT * FROM okx_data.bills LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the OKX to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

  • Deploy & schedule — run the pipeline as a managed job with automatic retries.
  • Monitor — observable job queues, alerting, and load metrics for every run.
  • Transform — promote raw OKX loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load OKX data to?

dlt loads into any of these — only the destination argument changes:

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

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.


Next steps

Was this page helpful?

Community Hub

Need more dlt context for OKX to DuckDB?

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