Skip to content

Requests, Responses, and Errors

Request context

region is required for price-bearing endpoints. currency is optional. Send the locale with Accept-Language for translated category labels. The service returns X-Request-Id; include it in support requests.

Envelope

Collections respond with data and meta; a single-resource read uses the same shape. Successful writes also include data.

{"data":{"id":"alert_01J4Q8BAVP4E","status":"active"},"meta":{"request_id":"req_01J3KZ6VPG8J"}}

Errors follow RFC 9457-style problem details:

{"type":"https://docs.steamdeals.example/errors/invalid-parameter","title":"Invalid parameter","status":400,"detail":"region must be an ISO 3166-1 alpha-2 code","code":"invalid_parameter","request_id":"req_01J3KZ6VPG8J","errors":[{"field":"region","reason":"invalid_format"}]}
Status Code Client action
400 invalid_parameter Correct request input.
401 invalid_token Obtain or refresh a credential.
403 insufficient_scope Request required consent or key scope.
404 not_found Do not retry.
409 conflict Read current state and reconcile.
422 validation_failed Correct semantic input.
429 rate_limited Wait for Retry-After.
5xx upstream_unavailable Retry with backoff.