API reference · v1

Check coverage

Latest collection evidence per configured register. Summary inventory and fully detailed counts are distinct; history remains unverified.

GET/v1/coverage

Send a secret API key in Authorization: Bearer YOUR_API_KEY. Each successful request uses one of your 500 monthly requests.

Parameters

authorityquery · optional

Authority ID, for example local-authority-oxo. Omit to search all authorities.

Response fields

generatedAtstring

UTC timestamp in ISO 8601 format.

itemsarray

Array of the items described below.

Show item fields

registerIdstring

Source register identifier.

authorityIdstring

Authority identifier.

authorityNamestring

Authority name.

activeboolean

Collection enabled for this register; does not prove successful reads.

lastSuccessAtstring | null

UTC time of the latest successful collection cycle; null if none completed.

staleboolean

No successful read in the previous 36 hours, or none recorded.

operationalboolean

Seven successful daily cycles and a fresh read; does not prove historical completeness.

summariesinteger

Application summaries inventoried during collection; may exceed searchable detailed records.

detailedinteger

Inventory records with completed detail collection.

lastImportAtstring | null

Latest import progress update in UTC; null if no import exists.

historicalCompletenessstring

Historical completeness has not been independently established.

Errors

Error codes, request IDs, retry behaviour, and allowance headers apply to every endpoint. Invalid or repeated query parameters return 400; unavailable records return 404. Source failures never become successful empty results.