---
title: "Use when a complete overview of a Steam player is needed. Steam summary + FACEIT + friends (size controlled by include / friends_limit)"
method: GET
path: "/summary/{id}"
---

# Use when a complete overview of a Steam player is needed. Steam summary + FACEIT + friends (size controlled by include / friends_limit)

`GET /summary/{id}`

## Request

- Base URL: `https://steamgpt.net`
- URL: `https://steamgpt.net/summary/{id}`
- Auth: one of:
  - none
  - OAuth 2 (client credentials, token URL `https://steamgpt.net/oauth/token`, scopes: `rate-boost`)

## Path parameters

- `id` string, required

## Query parameters

- `include` string
- `preset` 'identity' | 'competitive' | 'full'
- `friends_limit` integer
- `friends_detail` 'short' | 'medium' | 'full'

## Response `200`

Full aggregate: Steam + FACEIT + friends

- Summary
  - `result` 'success'
  - `data` object
    - `steamid64` string
    - `ids` Ids: All SteamID representations of the player
      - `steamid64` string
      - `steamid` string, nullable
      - `steamid3` string, nullable
    - `steam` SteamPlayer, nullable: Raw Steam GetPlayerSummaries player object, unmodified field names
      - `steamid` string
      - `personaname` string
      - `profileurl` string
      - `avatar` string
      - `avatarmedium` string
      - `avatarfull` string
      - `personastate` integer: 0 offline, 1 online, 2 busy, 3 away, 4 snooze, 5 looking to trade, 6 looking to play
      - `communityvisibilitystate` integer: 3 = public
      - `timecreated` integer: unixtime
      - `lastlogoff` integer: unixtime
      - `gameextrainfo` string
      - `loccountrycode` string
    - `faceit` object, nullable
    - `faceit_bans` object[]
    - `steam_bans` object, nullable: GetPlayerBans object; absent when include excludes bans
    - `friends` FriendsData
      - `count` integer: total known friends (may exceed shown list)
      - `friends` union[]
        - union
          - string: detail=short: plain steamid64
          - object: detail=medium
            - `steamid64` string
            - `personaname` string, nullable
          - object: detail=full (default)
            - `steamid64` string
            - `steam` SteamPlayer, nullable: Raw Steam GetPlayerSummaries player object, unmodified field names
              - …
    - `canonical` Canonical: Stable resource identity: vanity and steamid64 URLs are the same resource
      - `steamid64` string
      - `url` string
    - `provenance` object: keys follow include: faceit / steam_bans absent when their blocks are excluded
      - `steam` SourceProvenance
        - `source` string
        - `retrieved_at` integer, nullable: unixtime of the cached snapshot
        - `age_seconds` integer, nullable: snapshot age at response time
        - `fresh` boolean: age within cache_ttl; false when unknown
        - `cache_ttl` integer, nullable: refresh policy in seconds
        - `refreshed_with` string: steam_bans only: bans refresh together with this source snapshot
      - `faceit` SourceProvenance
        - `source` string
        - `retrieved_at` integer, nullable: unixtime of the cached snapshot
        - `age_seconds` integer, nullable: snapshot age at response time
        - `fresh` boolean: age within cache_ttl; false when unknown
        - `cache_ttl` integer, nullable: refresh policy in seconds
        - `refreshed_with` string: steam_bans only: bans refresh together with this source snapshot
      - `steam_bans` SourceProvenance
        - `source` string
        - `retrieved_at` integer, nullable: unixtime of the cached snapshot
        - `age_seconds` integer, nullable: snapshot age at response time
        - `fresh` boolean: age within cache_ttl; false when unknown
        - `cache_ttl` integer, nullable: refresh policy in seconds
        - `refreshed_with` string: steam_bans only: bans refresh together with this source snapshot
    - `sources` object: per-source status: ok (data present), empty (no such data), unavailable (source did not answer - absence is NOT a fact), excluded (not requested)
      - `steam` 'ok' | 'empty' | 'unavailable' | 'excluded'
      - `faceit` 'ok' | 'empty' | 'unavailable' | 'excluded'
      - `friends` 'ok' | 'empty' | 'unavailable' | 'excluded'
      - `bans` 'ok' | 'empty' | 'unavailable' | 'excluded'
    - `partial` boolean: true when at least one source is unavailable

## Other responses

- `400`: Unknown include value
- `404`: Not found
- `429`: Rate limited, honor Retry-After

---

[API](https://skmtc.dev/steamgpt/apis/steamgpt-api.md) · [All operations](https://skmtc.dev/steamgpt/apis/steamgpt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/steamgpt/apis/steamgpt-api/revisions/e104f6425018?raw)
