Screenshot

Render a CS2 item screenshot

Available in every package, including Free and Free+. Screenshot-specific limits take precedence; otherwise the package Global limits apply. Render front, back or both sides as AVIF using your existing SteamWebAPI key. game defaults to cs2. Transparent cutouts support front/back; use background_color for a solid background. with_float requires width >= 960. Each authenticated screenshot request, including result retrieval and retries, consumes a separate screenshot quota with UTC calendar day/month windows. Ordinary SteamWebAPI credits are not charged. A 202 response contains job_id: retrieve it through this same route after Retry-After. Reuse Idempotency-Key after a timeout. See examples and response formats.

get/steam/api/screenshot

Request

  • Base URL: https://www.steamwebapi.com
  • URL: https://www.steamwebapi.com/steam/api/screenshot
  • 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 use X-Api-Key or Key. Conflicting credentials are rejected.

urlstring

URL-encoded CS2 inspect link. Required for rendering; omit when retrieving job_id.

game'cs2'
mode'front' | 'back' | 'both'

Defaults to front. Use both explicitly for both sides. bothsides is not accepted.

widthinteger

Image width in pixels; height scales proportionally. Widths below 960 require with_float=false; float information is enabled by default except for transparent cutouts.

view'transparent'

Omit to use the default background image. transparent defaults to front, disables the default background and float information, and cannot be combined with mode=both, background_color, color, background_url, background_vertical_align or with_float=true.

background_colorstring

Optional solid #RRGGBB background instead of the default top-aligned background image. URL-encode the # character.

colorstring
Example:blue

Legacy background color alias. Accepts black, blue, green, orange, purple, red, white, yellow, gray, #RRGGBB or #RRGGBBAA. Explicit background_url or background_color takes precedence. Incompatible with transparency; URL-encode #.

background_urlstring uri

Custom HTTP(S) background image URL without credentials or a fragment. Cannot be combined with background_color or transparent output.

background_vertical_align'top' | 'center' | 'bottom'

Vertical alignment of the default or custom background image. Cannot be combined with background_color or transparent output.

logo_urlstring uri

Custom HTTP(S) logo image URL without credentials or a fragment. Use a publicly accessible image.

logo_offset_start'top left' | 'top right' | 'bottom left' | 'bottom right'

Corner used to position the custom logo; requires logo_url to display a logo.

logo_offset_xinteger

Horizontal logo offset in pixels.

logo_offset_yinteger

Vertical logo offset in pixels.

logo_opacitynumber

Logo opacity: 0 is invisible, 1 is opaque.

logo_widthinteger

Custom logo width in pixels.

with_floatboolean

Show float information; defaults to true, or false with view=transparent. Requires width >= 960 when enabled. Set false to omit it.

item_namestring

Custom item label instead of the original name.

paint_namestring

Custom finish label instead of the original name.

format'screen' | 'download' | 'base64'

screen displays AVIF inline; download returns an AVIF attachment; base64 returns a JSON data URI.

as_base64boolean

Compatibility alias: true or 1 selects format=base64; false or 0 keeps screen. An explicit format takes precedence.

idempotency_keystring

Reuse with unchanged render options after a timeout. Also accepted via Idempotency-Key. Returned in that response header for accepted requests.

job_idstring

Retrieve a pending result using the same key. Expires after three hours. Omit url and render options; only authentication, game, format, as_base64 and idempotency_key may accompany job_id.

Headers

Idempotency-Keystring

Alternative to idempotency_key; use the same value if both are supplied.

Response

Rendered screenshot. download uses filename screenshot.avif.

status'success' required
imagestring required

Example response

{
  "image": "data:image/avif;base64,..."
}

Changes

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