Screenshot

Read screenshot quota and usage

Available in every package. Initializes access if needed using Screenshot limits or the package Global fallback. Separate screenshot request counters; render retries and result retrieval also count. Day/month windows use UTC calendar boundaries. total covers retained usage history, not necessarily lifetime usage. Load on demand and respect Retry-After; do not poll for every screenshot.

get/steam/api/screenshot/usage

Request

  • Base URL: https://www.steamwebapi.com
  • URL: https://www.steamwebapi.com/steam/api/screenshot/usage
  • Auth: one of:
    • API key in query parameter key
    • API key in header X-Api-Key
    • API key in header Key

Query parameters

keystring

SteamWebAPI API key; alternatively X-Api-Key or Key.

Response

Current screenshot quota and consumption. A null limit means unlimited.

status'success' required
activeboolean required
timezone'UTC' required
period'calendar' required
unit'authenticated_requests' required

Example response

{
  "active": true,
  "limits": {
    "minute": 100,
    "day": 1000,
    "month": 10000
  },
  "usage": {
    "minute": 1,
    "day": 25,
    "month": 240,
    "total": 500
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.