Skip to content

REST API Guide

The REST API uses JSON over HTTPS. Base URL: https://api.steamdeals.example/v1. All dates are ISO 8601 UTC timestamps, money amounts are decimal strings, and resource IDs are opaque strings.

Public reads accept an API key. User actions require OAuth. Send Accept: application/json, and include User-Agent with an application name and version.

Method Meaning Retry guidance
GET Read a resource or collection retry transient failures
POST Create a resource or action retry only with Idempotency-Key
PATCH Replace supplied mutable fields retry only with Idempotency-Key
DELETE Delete a user-owned resource treat 404 as already deleted when appropriate

Use the OpenAPI document to generate clients. Versioning and backward compatibility are described in operations.