Skip to main content
GET
Nightly rows

Authorizations

Authorization
string
header
required

Personal API key, created in the app under Account → API. Send it as Authorization: Bearer apn_.... Keys are read-only, Pro-gated, and revocable. A revoked, expired, or non-Pro key returns 401.

Query Parameters

from
string<date>

Inclusive lower bound on the night date, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string<date>

Inclusive upper bound on the night date, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
limit
integer
default:100

Maximum number of (most recent) rows to return. Clamped to the range 1–1000. Defaults to 100.

Required range: 1 <= x <= 1000

Response

A page of nightly rows.

nights
object[]
required

The returned page of nights, oldest first.

count
integer
required

Number of rows in this page.

total
integer
required

Total rows matching the filter before limit was applied.

limit
integer
required

The effective limit used (after clamping).