Load Hostaway data to DuckDB

Hostaway is an AI-powered vacation rental management platform that provides a public REST API for managing property listings, reservations, calendars, and guest communications. Everything needed to build a working Hostaway → 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 Hostaway to DuckDB pipeline

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

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from Hostaway 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 Hostaway 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.

---

Hostaway API at a glance

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

---

How do I authenticate with the Hostaway API?

All requests to the Hostaway Public API require an OAuth 2.0 Bearer token, which must be included in the Authorization header as 'Authorization: Bearer {access_token}'. The access token is obtained via a Client Credentials grant flow by sending a POST request to the /v1/accessTokens endpoint with your client_id and client_secret.

1. Get your credentials

1. Log in to your Hostaway Dashboard. 2. Navigate to Settings > Hostaway API. 3. Click Create. 4. Enter a name and select a partner (or choose 'Hostaway Public API' for generic use). 5. Click Create. 6. Copy and store the Account ID and API Key immediately, as they will only be displayed once.

2. Add them to .dlt/secrets.toml

Copy
[sources.hostaway_source]
access_token = "REPLACE_ME"

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 Hostaway data can I load into DuckDB?

These are the Hostaway endpoints dlt can load into DuckDB:

---

How do I load only new Hostaway records?

Hostaway exposes afterId on v1/listings, 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.

Copy
{"name": "listings", "endpoint": {
    "path": "v1/listings",
    "data_selector": "result",
    "incremental": {"cursor_path": "afterId", "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 Hostaway pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /accessTokens and /listings (or other standard resource endpoints such as /reservations or /calendar) from the Hostaway API into DuckDB:

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

@dlt.source
def hostaway_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.hostaway.com/v1",
            "auth": {"type": "bearer", "token": access_token},
        },
        "resources": [
            {"name": "listings", "endpoint": {"path": "v1/listings", "data_selector": "result"}},
            {"name": "reservations", "endpoint": {"path": "v1/reservations", "data_selector": "result"}}
        ],
    }
    yield from rest_api_resources(config)


def load_hostaway_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="hostaway_pipeline",
        destination="duckdb",
        dataset_name="hostaway_data",
    )
    load_info = pipeline.run(hostaway_source())
    print(load_info)


if __name__ == "__main__":
    load_hostaway_to_duckdb()

Run it with python hostaway_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 Hostaway 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):

Copy
import dlt

data = dlt.pipeline("hostaway_pipeline").dataset()
df = data.reservations.df()
print(df.head())

SQL:

Copy
SELECT * FROM hostaway_data.reservations LIMIT 10;

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

---

How do I deploy the Hostaway 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 Hostaway 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 Hostaway data to?

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

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

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack