FourKites Python API Docs | dltHub

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

Last updated:

FourKites provides real-time supply-chain visibility and shipment-tracking APIs, including tracking assignment and shipment status data. The REST API base URL is https://tracking-api.fourkites.com and API credentials are product/endpoint-specific; documented tracking-assignment endpoints support HTTP Basic or Digest authentication.

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 add "dlt[hub]" and start loading FourKites data in under 10 minutes.


What data can I load from FourKites?

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

ResourceEndpointMethodData selectorDescription
shipments/shipmentsGETRetrieve list of shipments
tracking/trackingGETRetrieve tracking events for a shipment
appointments/appointmentsGETRetrieve Dynamic Yard appointments
carriers/carriersGETRetrieve list of carriers
authenticate/authenticatePOSTAuthenticate to obtain a session

How do I authenticate with the FourKites API?

For the documented Tracking Information Assignment API, send HTTP Basic Authentication using the FourKites-provided username and password; the example sets Content-Type: application/json. FourKites also documents Digest/nonce authentication as an alternative, and credentials are supplied by FourKites rather than represented as a documented bearer token. The endpoint example is https://tracking-api.fourkites.com/api/v1/tracking/truck_assignment.

1. Get your credentials

To obtain your FourKites API credentials, log in to your account at https://app.FourKites.com. Navigate to 'Settings' in the upper right corner, then select '3rd Party Integration' from the sidebar. Under the '3rd Party Integration Settings' header, click 'View API Credentials' to retrieve your Client ID and Secret key. Note that some integrations may require contacting FourKites carrier operations or support directly to provision specific endpoint access or API user credentials.

2. Add them to .dlt/secrets.toml

[sources.fourkites_source] fourkites_client_id = "your_client_id_here" fourkites_secret = "your_secret_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 init uv add "dlt[hub]"

1. Install the dlt AI harness:

uv run dlthub 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:

uv run dlthub ai toolkit install rest-api-pipeline

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 FourKites 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:

uv run python fourkites_pipeline.py

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

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

Inspect your pipeline and data:

uv run dlthub 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 truck_assignment and dispatcher_updates from the FourKites 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 fourkites_source(username_password=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://tracking-api.fourkites.com", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": username_password}, }, "resources": [ {"name": "shipments", "endpoint": {"path": "shipments"}}, {"name": "tracking", "endpoint": {"path": "tracking"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="fourkites_pipeline", destination="duckdb", dataset_name="fourkites_data", ) load_info = pipeline.run(fourkites_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("fourkites_pipeline").dataset() sessions_df = data.shipments.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM fourkites_data.shipments LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("fourkites_pipeline").dataset() data.shipments.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 FourKites 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 harness:

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

Was this page helpful?

Community Hub

Need more dlt context for FourKites?

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