Docs
Sites APIInventory

Unit price matrix

Rent by move-in date and lease term, from stored data only. This endpoint never calls the property's management system; a unit with no stored matrix returns an empty list. Empty too when the property's pricing display settings hide the price. At most 120 rows. Rate limited more tightly than other reads. Tag: `inventory:{property_id}`.

GET/api/sites/v1/units/{unit}/price-matrix

Rent by move-in date and lease term, from stored data only. This endpoint never calls the property's management system; a unit with no stored matrix returns an empty list. Empty too when the property's pricing display settings hide the price. At most 120 rows. Rate limited more tightly than other reads. Tag: inventory:{property_id}.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Path Parameters

unit*string

The unit's slug.

Query Parameters

from?string

First move-in date. Defaults to today.

Formatdate
to?string

Last move-in date.

Formatdate

Header Parameters

X-Resi-Website?string

Website id. Overrides Host resolution for builds running where Host is meaningless. The token must still be scoped to this website.

If-None-Match?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sites/v1/units/string/price-matrix"
{  "data": [    {      "start_date": "string",      "best_term": {        "months": 0,        "rent": 0      },      "terms": [        {          "months": 0,          "rent": 0        }      ]    }  ],  "meta": {    "unit": {      "id": "string",      "slug": "string",      "number": "string"    },    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

One unit GET

A unit by slug. Tag: `inventory:{property_id}`.

Availability feed GET

The part of a unit that moves: availability, date and price. Cache the heavy unit and floor-plan payloads for long, and re-read this often. Join on `id` or `slug`. `meta.cache.ttl` is 60. Tags: `inventory:{property_id}`.