Skip to main content
This page is written for AI agents and LLMs consuming this portal at inference time. If you’re a human, it also explains why pages are structured the way they are.

Read this first

Every capability page in this portal is written to be parsed, not just read. Pages follow a consistent, high-signal structure so an agent can extract facts without ambiguity and plan tool calls without hallucinating capabilities.

Structure you can rely on

Each product and data page surfaces these blocks in a predictable order:

Rules for planning tool calls

1

Resolve identity before data

If the user provides an address, call the CLIP resolver first — clip-find_property_by_full_address — then use the returned CLIP for all downstream data tools. Never guess or fabricate a CLIP. See Identifiers.
2

Check exclusions before calling

Every data-returning page has an Exclusions row in its data scope table. Do not send commercial or non-U.S. queries to U.S. residential tools. Check before calling.
3

Honour temporal limits

Market and HPI data is monthly. Do not request real-time or daily values from a monthly asset. Check the Update frequency and Historical depth rows in the data scope table, or see Data freshness.
4

Iterate structure arrays

A parcel can contain multiple structures. If summaryNumberOfBuildings > 1, iterate the structure array — do not assume a single building. See Property Characteristics.
5

Always check the envelope

Read success, count, and messages on every response before reading data. Surface messages to the user — they carry freshness warnings, partial-match notices, and deprecation signals. See Response envelope.
6

Never fabricate on 404

If CLIP resolution or a data query returns no results, report that to the user. Do not invent a value. See Error handling.

Token efficiency

Pages use key-value tables and bullets over prose so agents spend fewer tokens and parse with higher accuracy. When summarising back to a user, prefer the same structured format.

Machine-readable index

The portal exposes standard discovery files:
  • /llms.txt — concise map of all pages and their purpose for LLM navigation
  • /sitemap.xml — full page listing
  • Per-tool JSON schemas are linked from each MCP reference page

Prompting and orchestration

For ready-to-use agent instructions per workflow: