Load Real Estate API data to DuckDB
Build a Real Estate API to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Real Estate API API base URL, auth, endpoints, and incremental loading.
RealEstateAPI is a platform providing a comprehensive suite of real estate property data APIs for developers. Everything needed to build a working Real Estate API → 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 Real Estate API to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from Real Estate API 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 Real Estate API 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.
Real Estate API API at a glance
| Base URL | https://api.realestateapi.com |
| Example endpoint | GET v1/properties |
| Records found at | properties |
| Authentication | all requests require an API key passed as an HTTP header — sent in the x-api-key header |
| Pagination | Cursor-based via cursor, next cursor at metadata.nextCursor, page size via limit (default 50, max 100). For Realie.ai pagination: cursor mode is opt-in; include the cursor query parameter (even cursor= on the first request). Pass metadata.nextCursor back as cursor to fetch the next page; when there are no more results nextCursor is null. For Reliocrm (related real-estate listing example): cursor is provided as meta.pagination.nextCursor and limit controls page size (1-100, default 50). |
| Incremental field | nextCursor |
| Record id | id |
| API reference | https://developer.realestateapi.com/reference/welcome-to-realestateapi |
These values come from the Real Estate API API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the Real Estate API API?
All RealEstateAPI endpoints require an API key passed as an HTTP header named x-api-key. The key is obtained from the RealEstateAPI dashboard.
1. Get your credentials
- Sign up or log in to your account at RealEstateAPI.com or developer.realestateapi.com. 2. Navigate to your user dashboard or the dedicated 'API Keys' or 'Credentials' section. 3. Generate a new API key or copy an existing one. Ensure you note any specific custom header requirements (typically x-api-key).
2. Add them to .dlt/secrets.toml
[sources.real_estate_api_source] api_key = "your_api_key_here"
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 Real Estate API data can I load into DuckDB?
These are the Real Estate API endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| properties | /v1/properties | GET | properties | Retrieve a paginated list of properties. |
| properties_records | /v1/properties/records | GET | Access raw property data records. | |
| portfolios | /v1/portfolios | GET | List user portfolios. | |
| documents_search | /v1/documents/search | GET | Search property-related documents. | |
| chats_messages | /v1/chats/{chat_id}/messages | GET | Retrieve messages for a specific chat. |
How do I load only new Real Estate API records?
Real Estate API exposes nextCursor on v1/properties, 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": "properties", "endpoint": { "path": "v1/properties", "data_selector": "properties", "incremental": {"cursor_path": "nextCursor", "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 Real Estate API pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading v3/PropertyComps and v2/MLSSearch from the Real Estate API API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def real_estate_api_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.realestateapi.com", "auth": {"type": "api_key", "api_key": api_key, "name": "x-api-key", "location": "header"}, }, "resources": [ {"name": "properties", "endpoint": {"path": "v1/properties", "data_selector": "properties"}}, {"name": "properties_records", "endpoint": {"path": "v1/properties/records", "data_selector": "data"}} ], } yield from rest_api_resources(config) def load_real_estate_api_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="real_estate_api_pipeline", destination="duckdb", dataset_name="real_estate_api_data", ) load_info = pipeline.run(real_estate_api_source()) print(load_info) if __name__ == "__main__": load_real_estate_api_to_duckdb()
Run it with python real_estate_api_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 Real Estate API 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("real_estate_api_pipeline").dataset() df = data.properties.df() print(df.head())
SQL:
SELECT * FROM real_estate_api_data.properties LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the Real Estate API 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 Real Estate API loads into governed, documented models.
- Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.
What other destinations can I load Real Estate API data to?
dlt loads into any of these — only the destination argument changes:
| Destination | Example 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 Real Estate API to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.