Conventions

Enum values

All enum values are expressed in uppercase with underscores (e.g. FLAT, HOUSE, NEW_MATCH), both in request parameters and in responses.

The only exception is the GeoJSON geometry type (the type field), which follows the exact casing of the RFC 7946 standard — Point, Polygon, MultiPolygon — and is therefore case-sensitive.

Dates and timezone

All date and time formats in the API are expressed in UTC (UTC+0).

Always convert any local DateTime instance to UTC before sending it in a request. Responses must also be interpreted as UTC, then converted to the user's timezone client-side if needed.

// ✅ Correct — send in UTC
const since = new Date().toISOString(); // "2026-04-29T14:32:00.000Z"

// ❌ Avoid — local date with no conversion
const since = "2026-04-29 16:32:00";

API responses

Dates and times returned by the API use ISO 8601 in UTC. The offset is expressed either with a Z suffix or as +00:00 (equivalent) — which one depends on the field and endpoint. A few purely calendar fields (publication dates, analytics windows) may be returned as a date only (YYYY-MM-DD).

{
  "createdAt": "2026-04-29T14:32:00+00:00",
  "updatedAt": "2026-04-29T15:01:42.000Z"
}

Client-side, convert to the user's timezone:

const localStr = new Date(item.createdAt).toLocaleString();

See also

• Rate limits — per-IP quotas and X-RateLimit-* headers