API reference
Public & system API
No API key needed: access requests, health and readiness probes, OpenAPI.
Endpoints that do not require an API key: requesting access, liveness and readiness probes, and the OpenAPI document.
Endpoints
- POSTaccess_requestRequest accessAsk for an account. No API key required.Free
- GEThealthHealth checkLiveness probe for load balancers and uptime monitors.Free
- GETreadyReadiness checkReadiness probe: the database is reachable and migrations are applied.Free
- GETopenapi.jsonOpenAPI documentMachine-readable OpenAPI 3 description of the API, with interactive docs at /docs.Free
Access request receipt
Confirms that the request was stored.
idId of the stored request.
statusAlways received.
created_atWhen the request was stored, ISO 8601 in UTC.
Health object
Liveness report. Not wrapped in the response envelope.
statusok, or degraded when the database cannot be reached.
databaseWhether the database answered.
queueOpen internal collection jobs per state: queued and, while jobs are being processed, running.
rate_limitsCurrent pause in seconds between two requests to each marketplace, as paced by the collector of this process. Empty when the process does not run the collector.
Readiness object
Readiness report. Not wrapped in the response envelope.
statusready or not_ready.
databaseWhether the database answered.
pending_migrationsDatabase migrations that are not applied yet (empty when ready).