item

Find owners of one or more trading cards or booster packs. Friend paths from the requester are included for logged-in callers.

post/v1/item.findOwners

Request body

$schemastring uri

A URL to the JSON Schema for this object.

cursorstring

Opaque pagination cursor from the previous page's nextCursor. Pages to any depth at constant cost, and requires exactly one entry in itemIds. Omit for the first page.

itemIdsinteger[] nullable required

Trading item class IDs to look up

maxDepthinteger

Friend-path depth limit (default 4, max 6); ignored when not logged in

offsetinteger

Number of owners to skip per item, for pagination. Random access, but only one item at a time past owner 100 and never past 10000 — use cursor to page deeper.

ownersPerIteminteger

Page size, max owners returned per item (default 10, max 25)

sort'owned' | 'closest'

Owner order. 'owned' (default) returns the most copies owned first. 'closest' reranks a wider slice of owners by friend path length, nearest first; it needs a logged-in caller and the first page (no offset, no cursor), and never returns a nextCursor.

Example request

{
  "$schema": "https://api.steamsets.com/schemas/FindOwnersRequestBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "https://api.steamsets.com/schemas/FindOwnersResponseBody.json",
  "items": [
    {
      "owners": [
        {
          "account": {
            "apps": 123456,
            "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
            "awardsGiven": 123456,
            "awardsReceived": 123456,
            "badges": 123456,
            "city": {
              "name": "Bad Krozingen"
            },
            "country": {
              "code": "DE",
              "name": "Germany"
            },
            "createdAt": "2023-01-01T00:00:00Z",
            "donated": 123456,
            "economyBan": "steam",
            "foilBadges": 123456,
            "friends": 123456,
            "level": 123456,
            "name": "steamsets",
            "nameEffect": "rainbow",
            "normalBadges": 123456,
            "playtime": 123456,
            "pointsGiven": 123456,
            "pointsReceived": 123456,
            "privacy": "public",
            "region": {
              "name": "Europe"
            },
            "state": {
              "name": "Baden-Wurttemberg"
            },
            "steamId": "76561198842603734",
            "steamSetsVanity": "steamsets",
            "steamVanity": "steamsets",
            "themeColor": "#FF5733",
            "xp": 123456
          },
          "path": [
            {
              "apps": 123456,
              "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
              "awardsGiven": 123456,
              "awardsReceived": 123456,
              "badges": 123456,
              "city": {
                "name": "Bad Krozingen"
              },
              "country": {
                "code": "DE",
                "name": "Germany"
              },
              "createdAt": "2023-01-01T00:00:00Z",
              "donated": 123456,
              "economyBan": "steam",
              "foilBadges": 123456,
              "friends": 123456,
              "level": 123456,
              "name": "steamsets",
              "nameEffect": "rainbow",
              "normalBadges": 123456,
              "playtime": 123456,
              "pointsGiven": 123456,
              "pointsReceived": 123456,
              "privacy": "public",
              "region": {
                "name": "Europe"
              },
              "state": {
                "name": "Baden-Wurttemberg"
              },
              "steamId": "76561198842603734",
              "steamSetsVanity": "steamsets",
              "steamVanity": "steamsets",
              "themeColor": "#FF5733",
              "xp": 123456
            }
          ]
        }
      ]
    }
  ]
}

Changes

Changed in 4 of the 11 revisions of this API.87

    • added the new optional request property sort

      new-optional-request-property

    • removed the required property items/items/owners/items/account/appCost from the response with the 200 status

      response-required-property-removed

    • removed the required property items/items/owners/items/account/foilBadgeCost from the response with the 200 status

      response-required-property-removed

    • removed the required property items/items/owners/items/account/normalBadgeCost from the response with the 200 status

      response-required-property-removed

    • removed the required property items/items/owners/items/path/items/appCost from the response with the 200 status

      response-required-property-removed

    • removed the required property items/items/owners/items/path/items/foilBadgeCost from the response with the 200 status

      response-required-property-removed

    • removed the required property items/items/owners/items/path/items/normalBadgeCost from the response with the 200 status

      response-required-property-removed

    • added the required property items/items/owners/items/account/nameEffect to the response with the 200 status

      response-required-property-added

    • added the required property items/items/owners/items/account/themeColor to the response with the 200 status

      response-required-property-added

    • added the required property items/items/owners/items/path/items/nameEffect to the response with the 200 status

      response-required-property-added

    • added the required property items/items/owners/items/path/items/themeColor to the response with the 200 status

      response-required-property-added

    • added the new optional request property cursor

      new-optional-request-property

    • added the optional property items/items/nextCursor to the response with the 200 status

      response-optional-property-added

    • removed the required property items/items/owners/items/account/images from the response with the 200 status

      response-required-property-removed

    • removed the required property items/items/owners/items/path/items/images from the response with the 200 status

      response-required-property-removed

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 11 revisions, 1 has no diff computed.