Quick Start

This walkthrough searches the catalog, gets live offers, and creates a price alert. It requires a production API key and an OAuth access token for the last step.

1. Search a game

curl -G https://api.steamdeals.example/v1/games \
  --data-urlencode "query=Hades II" --data "region=US" \
  -H "Authorization: Bearer $STEAMDEALS_API_KEY"

{"data":[{"id":"game_01J2M4T5K7HADES2","name":"Hades II","release_date":"2024-05-06","platforms":["windows","macos"],"lowest_price":{"amount":"20.99","currency":"USD","store_id":"store_steam"}}],"meta":{"request_id":"req_01J3KZ6VPG8J","next_cursor":null}}

2. Compare offers

curl "https://api.steamdeals.example/v1/games/game_01J2M4T5K7HADES2/prices?region=US" \
  -H "Authorization: Bearer $STEAMDEALS_API_KEY"

The response is ordered by sale price and contains observed_at. Display that timestamp near the price; freshness is store-specific.

3. Create an alert

curl -X POST https://api.steamdeals.example/v1/alerts \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f638342-3de8-4f8c-a6e4-1bd961015f09" \
  -d '{"game_id":"game_01J2M4T5K7HADES2","region":"US","target_amount":"18.00","currency":"USD","channels":["email","webhook"]}'

See idempotency before retrying writes.