Skip to main content
A property's nights in a window (to is exclusive, at most 365 nights), 404 once withdrawn or deleted
Preview. This operation is not served yet: it is part of the released contract (version 1.0.0). Build against a mock of the contract until the sandbox serves it; see Testing: mock and sandbox.

Autorizzazioni

Authorization
string
header
obbligatorio

A key starts with gbd_live_ (production) or gbd_test_ (sandbox) and ends in a CRC32 checksum of its secret part, so a mistyped or truncated key is refused before any lookup, as is a key of the other environment. The prefix is registered with public secret scanners (GitHub secret scanning, TruffleHog, GitGuardian): a key found in a public repository is revoked at once and your technical contact is told. Gridbeds stores only a hash of each key. One partner may hold two keys per environment during a rotation. Operations list the scopes they need; the scopes are OAuth 2.0 scope tokens, so short-lived access tokens from a client-credentials grant can be offered later beside keys, with the same scopes and no change to any operation.

Parametri del percorso

property_id
string
obbligatorio
Pattern: ^prp_[0-7][0-9a-hjkmnp-tv-z]{25}$
Esempio:

"prp_1qnykkykp69yv8d59hxk5410m9"

Parametri della query

from
string<date>
obbligatorio

First night, the property's local date.

to
string<date>
obbligatorio

Exclusive; at most 365 nights after from and no later than the property's horizon_end, which is at least 365 nights after its today.

Risposta

The nights. A from before the property's today is served from today; the response echoes the window it served.

property_id
string
obbligatorio
Pattern: ^prp_[0-7][0-9a-hjkmnp-tv-z]{25}$
Esempio:

"prp_1qnykkykp69yv8d59hxk5410m9"

currency
string
obbligatorio

ISO 4217.

Pattern: ^[A-Z]{3}$
version
integer<int64>
obbligatorio

Grows on every change visible to this channel; ignore a lower one. Not a counter — do not expect consecutive values.

Intervallo richiesto: x >= 1
updated_at
string<date-time>
obbligatorio
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Esempio:

"2026-10-16T09:30:00Z"

from
string<date>
obbligatorio
to
string<date>
obbligatorio
horizon_end
string<date>
obbligatorio

Additive. Exclusive: the property publishes every night before it, from its today, and it is at least 365 nights after its today. The window rolls daily with the property's local date.

data
object[]
obbligatorio

One entry per night of the window: a night inside the horizon is never missing, and one with no rate has every rate closed.