FareHarbor Python API Docs | dltHub

FareHarbor is a booking and management software platform that provides an external REST API for partner integrations to access supplier and booking data. The REST API base URL is https://fareharbor.com/api/external/v1/ and all requests require API key authentication via custom HTTP headers.

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 FareHarbor data in under 10 minutes.

---

What data can I load from FareHarbor?

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

---

How do I authenticate with the FareHarbor API?

Authentication is performed using API keys provided by FareHarbor, which must be included as header values in every request. The required headers are 'X-FareHarbor-API-App' and 'X-FareHarbor-API-User'.

1. Get your credentials

Access to the FareHarbor External API is restricted to approved partners. To obtain your API credentials, you must email support@fareharbor.com to request access. Once approved, you will be provided with an 'App Key' and a 'User Key' through your FareHarbor dashboard or via your account manager. Ensure you store these securely, as they are required for all API authentication.

2. Add them to .dlt/secrets.toml

Copy
[sources.fareharbor_source]
api_app_key = "your_api_app_key_here"
api_user_key = "your_api_user_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:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

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

Copy
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 FareHarbor 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:

Copy
uv run python fareharbor_pipeline.py

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

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

Inspect your pipeline and data:

Copy
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 /availabilities/date-range/ and /items/ from the FareHarbor API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def fareharbor_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://fareharbor.com/api/external/v1/",
            "auth": {"type": "api_key", "api_key": api_key, "name": "token", "location": "header"},
        },
        "resources": [
            {"name": "companies", "endpoint": {"path": "companies/", "data_selector": "companies"}},
            {"name": "items", "endpoint": {"path": "companies/{shortname}/items/", "data_selector": "items"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="fareharbor_pipeline",
        destination="duckdb",
        dataset_name="fareharbor_data",
    )
    load_info = pipeline.run(fareharbor_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):

Copy
import dlt

data = dlt.pipeline("fareharbor_pipeline").dataset()
sessions_df = data.items.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM fareharbor_data.items LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("fareharbor_pipeline").dataset()
data.items.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 FareHarbor data to?

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

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.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack