Sites API

Generating types

Generate TypeScript types for Sites API responses from the OpenAPI document.

Download the OpenAPI document from /openapi/sites.json and generate types from it:

npx openapi-typescript sites.json -o lib/resi/sites-api.d.ts

Every response schema lists all of its keys as required and sets additionalProperties: false, so the generated types have no optional response fields: a key is either a value or null.

Last updated on

Forms, tours & analytics

Render a form from its definition, create leads, book tours with the property's provider, and report what visitors do.

Sites API reference

Every Sites endpoint, generated from the OpenAPI document at /openapi/sites.json.