Status codes

SOSfinder uses standard HTTP status codes. 2xx means success; 4xx means a problem with the request; 5xx means a problem on our side.

Quick reference

CodeMeaningWhat to do
200OKRequest succeeded — read the results.
400Bad RequestCheck required fields (query, state).
401UnauthorizedMissing or invalid API key.
403ForbiddenKey lacks access to this resource.
404Not FoundNo entity matched the query.
429Too Many RequestsSlow down and retry with backoff.
500Server ErrorRetry shortly; contact support if it persists.
503Service UnavailableTemporary outage — retry with backoff.

Error shape

Errors return a consistent JSON body with a machine-readable code and message.

{
  "success": false,
  "error": {
    "code": "invalid_state",
    "message": "\"ZZ\" is not a valid state code."
  }
}