# Huispedia Data Intelligence API

> Home values and property data for every address in the Netherlands, in one REST API: valuations, characteristics, WOZ, energy labels, transactions, areas and market. Base URL https://huispedia.dev/v5, key in `X-API-Key`, prepaid credits; only successful (2xx) answers are charged.

Every docs page is also Markdown: add `.md` to its URL, or ask for `Accept: text/markdown`. The docs are in English (`/en/`) and Dutch (`/nl/`) with the same paths. All English docs in one file: https://huispedia.dev/llms-full.txt.

## Getting started

- [Quickstart](https://huispedia.dev/en/docs/quickstart.md): From signing in to your first home value.
- [Data catalogue](https://huispedia.dev/en/docs/catalogue.md): What each endpoint returns and what it costs.
- [Authentication](https://huispedia.dev/en/docs/authentication.md): How to send your API key.
- [Credits and pricing](https://huispedia.dev/en/docs/credits.md): What a call costs and which credits go first.
- [Payments and invoices](https://huispedia.dev/en/docs/billing.md): Plans, buying credits, auto top-up, invoices and refunds.
- [Addresses and areas](https://huispedia.dev/en/docs/locators.md): Pointing at a home or an area in the path.

## API

- [Endpoints](https://huispedia.dev/en/docs/endpoints.md): Every endpoint with its parameters and answers, ready to try.
- [Errors](https://huispedia.dev/en/docs/errors.md): Every error code and what to do about it.
- [Rate limits](https://huispedia.dev/en/docs/rate-limits.md): Calls per second per plan, and how long you may keep an answer.
- [Changelog](https://huispedia.dev/en/docs/changelog.md): What changes. Within v5, fields and endpoints are only added.
- [Versioning](https://huispedia.dev/en/docs/versioning.md): What may change within v5, and what never does.
- [Claude Code plugin](https://huispedia.dev/en/docs/claude.md): Skills that teach Claude Code this API and the move from Altum or Matrixian.

## Migrate

- [Migrating from Altum](https://huispedia.dev/en/docs/migrate/altum.md): What you do on Altum and how you do it here.
- [Migrating from Matrixian](https://huispedia.dev/en/docs/migrate/matrixian.md): What you do on Matrixian and how you do it here.

## Machine-readable

- [OpenAPI 3.1](https://huispedia.dev/openapi.json): every endpoint with its parameters, answers and credits (Dutch: https://huispedia.dev/openapi.nl.json)
- [Catalogue](https://huispedia.dev/v5/catalog): credits per endpoint, plans, free tier, limits and sources; JSON, no key needed
- [Claude Code plugin](https://huispedia.dev/en/docs/claude.md): skills for this API and for migrating from Altum or Matrixian (marketplace Housepedia/claude-plugins)

## Optional

- [API terms of use](https://huispedia.dev/en/voorwaarden.md): The terms for using the Huispedia Data Intelligence API, with Annex A (contract endpoints) and Annex B (fair use).
- [Documentatie in het Nederlands](https://huispedia.dev/nl/llms-full.txt): all docs in Dutch, in one file