Response headers
Every successful response carries these headers:
Error responses carry
Cache-Control, Content-Type: application/problem+json and X-Request-Id, but no ETag.
Conditional requests with ETags
TheETag changes whenever the response body changes, and only then. To check whether data changed without downloading it again, send the last ETag you received in If-None-Match:
304 Not Modified with no body, along with the same ETag, X-Request-Id, X-Api-Version and X-RateLimit-* headers. Otherwise you get a normal 200 with the new body and a new ETag.
If-None-Matchaccepts a comma-separated list of ETags, weak (W/"…") or strong, and*.- The ETag is a hash of the body alone. Store one ETag per URL, including its query string, and send it only with that URL.
- A
304still counts toward your rate limit. It saves bandwidth and parsing, not requests.
Request IDs
Every response, success or error, carries anX-Request-Id header. Error bodies repeat it as instance: "urn:request:<id>".
- Send your own. If your request includes an
X-Request-Idof 1 to 128 characters using only letters, digits,.,_,:or-, the response echoes it back. Use your trace or span id to follow a request end to end. - Or let us assign one. If you don’t send one, or yours doesn’t match that format, Quotable assigns a fresh id, usually a UUID.
Log the
X-Request-Id of every failed request. When you contact support, include it: it lets us find the exact request.Next steps
Versioning
What X-Api-Version means and which changes count as breaking.
Errors
Every problem type the API returns.