Error handling

The endpoints return standard HTTP status codes. These include:

CodeMeaning
200Success
400Bad request
401Unauthorized
403Forbidden
404Not found
429Rate limit exceeded
500Internal server error

In case of an error (4xx or 5xx status), the response body generally has the following structure:

FieldDescriptionType
messageDescription of the error condition intended for a human audiencestring
errorError categorystring
errorsMore detailed error messages, e. g. for invalid requestsstring

Example 400 responses

{
  "errors": {
    "field": ["can't be blank"]
  }
}
{ "error": "address or coordinate not found" }
{ "error": "building block not found" }

Example 401 response

{ "error": "not authorized" }

Rate limiting

The QUIS API rate limits your requests on a daily basis. The daily limit varies based on your contract.

HeaderDescription
X-RateLimit-LimitThe maximum number of requests you're permitted to make per day.
X-RateLimit-RemainingThe number of requests remaining in the current rate limit window.
X-RateLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.

Internal server error

The QUIS team will be notified if an internal server error is triggered (HTTP error 500). The response body can be ignored in this case.