Mashvisor Python API Docs | dltHub
Build a Mashvisor-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Mashvisor API provides real estate data for investment analysis; it includes rental income, occupancy rates, and market trends. The API is REST-based and returns JSON responses. Current data is from March 2026. The REST API base URL is https://api.mashvisor.com/v1.1/client/ and All requests require an API key for 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 pip install "dlt[workspace]" and start loading Mashvisor data in under 10 minutes.
What data can I load from Mashvisor?
Here are some of the endpoints you can load from Mashvisor:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| city_listings | /city/listings | GET | content | Retrieve listings for a specific city. |
| property_lookup | /property/lookup | GET | content | Look up property details. |
| list_comps | /list-comps | GET | content | Get comparable properties. |
| property | /property | GET | content | Retrieve details for a specific property. |
| property_estimates | /property/estimates | GET | content | Get property estimates. |
| neighborhood_details | /neighborhood/details | GET | content | Retrieve details for a specific neighborhood. |
How do I authenticate with the Mashvisor API?
Authentication is done via an API key, which must be passed in the 'x-api-key' header for all requests.
1. Get your credentials
- Create a Mashvisor account. 2. Book a free consultation. 3. Generate an API key from your user dashboard. 4. Review API documentation.
2. Add them to .dlt/secrets.toml
[sources.mashvisor_source] api_key = "your_api_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:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt 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:
dlt ai toolkit rest-api-pipeline install
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 Mashvisor 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:
python mashvisor_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline mashvisor_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset mashvisor_data The duckdb destination used duckdb:/mashvisor.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline mashvisor_pipeline 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 city_listings and property from the Mashvisor 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 mashvisor_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.mashvisor.com/v1.1/client/", "auth": { "type": "api_key", "x-api-key": api_key, }, }, "resources": [ {"name": "city_listings", "endpoint": {"path": "city/listings", "data_selector": "content"}}, {"name": "property", "endpoint": {"path": "property", "data_selector": "content"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="mashvisor_pipeline", destination="duckdb", dataset_name="mashvisor_data", ) load_info = pipeline.run(mashvisor_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("mashvisor_pipeline").dataset() sessions_df = data.city_listings.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM mashvisor_data.city_listings LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("mashvisor_pipeline").dataset() data.city_listings.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 Mashvisor data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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 Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Mashvisor?
Request dlt skills, commands, AGENT.md files, and AI-native context.