List accounts that own an app (highest playtime first). Donator perk — page size scales with Patreon tier.

POST/v1/app.listOwners

Authorization

AuthorizationBearer token · headerrequired

Request body

requiredapplication/json

appIdinteger<int32>required

App id

min 1

cursorstring

Opaque pagination cursor from the previous page's nextCursor. Omit for the first page.

limitinteger<int32>

Page size (capped by donator tier)

min 1 · max 500

pageinteger<int32>

1-based page to jump to. Use this or cursor, not both. Reaches at most 100000 owners deep; walk with cursor past that.

min 1

Responses

200

maxPageSizeinteger<int32>required

Largest page size your donator tier allows

min 0

nextCursorstring

Pass as cursor to fetch the next page. Absent when there are no more owners.

ownersAppListOwnersEntry[] | nullrequired

Show properties

Array of AppListOwnersEntry

animatedAvatarstringrequired

The animated avatar of the account

appsinteger<int32>required

The number of apps the account has

min 0

avatarstringrequired

The avatar hash of the account

avatarFramestringrequired

The avatar frame of the account

awardsGiveninteger<int32>required

The number of awards the account has

min 0

awardsReceivedinteger<int32>required

The number of awards the account has

min 0

backgroundstringrequired

The background of the account

badgesinteger<int32>required

The number of badges the account has

min 0

bansinteger<int32>required

The number of bans

min 0

cityLeaderboardCity | null

The city of the account

Show properties

namestringrequired

The name of the city

countryLeaderboardCountry | null

The country of the account

Show properties

codestring

The code of the country

namestringrequired

The name of the country

createdAtstring<date-time>required

The time the account was created

donatedinteger<int32>required

The total of donations the account has

min 0

economyBanstringrequired

The economy ban of the account

foilBadgesinteger<int32>required

The number of foil badges the account has

min 0

friendsinteger<int32>required

The number of friends the account has

min 0

gameBansinteger<int32>required

The number of game bans

min 0

levelinteger<int32>required

The level of the account

min 0

miniBackgroundstringrequired

The mini background of the account

namestringrequired

The name of the account

nameEffectstringrequired

Donator name effect, none when unset or the account no longer holds an entitling role

Allowed:nonerainbowglitchshadowneonretrostampedshattertypewritervaporwavesunken

normalBadgesinteger<int32>required

The number of normal badges the account has

min 0

playtimeinteger<int32>required

Minutes this account has played the app

min 0

pointsGiveninteger<int32>required

The number of points the account has

min 0

pointsReceivedinteger<int32>required

The number of points the account has

min 0

privacystringrequired

The privacy of the account

Allowed:publicprivatefriends_only

regionLeaderboardRegion | null

The region of the account

Show properties

namestringrequired

The name of the region

rolesRole[] | nullrequired

The roles of the account

Show properties

Array of Role

extrasobject | nullrequired

Extra data associated with the role

ratinginteger<int32>required

The higher the more presedence it has

rolestringrequired

Allowed:userdonatorstaffdeveloperpartnerowneramethystamberemeraldsapphirerubydiamondcontributorearly_supporterbetatranslatortop_100badge_scoutnitro_boosterastralnebula

stateLeaderboardState | null

The state of the account

Show properties

namestringrequired

The name of the state

steamIdstringrequired

The steam id

steamSetsScoreinteger<int32>required

The steam sets score

min 0

steamSetsVanitystringrequired

The vanity of the account

steamVanitystringrequired

The vanity of the account

themeColorstring | nullrequired

Donator profile theme color as #RRGGBB (no alpha), null when unset or the account no longer holds an entitling role

vacBansinteger<int32>required

The number of vac bans

min 0

xpinteger<int32>required

The number of xp the account has

min 0

pageinteger<int32>required

1-based page this response holds

min 0

pageSizeinteger<int32>required

Owners per page used for this response

min 0

totalPagesinteger<int32>required

Pages available at this page size, capped at the deepest page a page jump can reach

min 0

trackedOwnersinteger<int64>required

Owners steamsets tracks for this app

min 0

400

Bad Request

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

401

Unauthorized

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

403

Forbidden

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

422

Unprocessable Entity

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

500

Internal Server Error

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

503

Service Unavailable

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

appIdinteger*App idcursorstringOpaque pagination cursor from the previous page's nextCursor. Omit for the first page.limitintegerPage size (capped by donator tier)pageinteger1-based page to jump to. Use this or cursor, not both. Reaches at most 100000 owners deep; walk with cursor past that.

Request

curl -X POST 'https://api.steamsets.com/v1/app.listOwners' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "appId": 1,
  "cursor": "string",
  "limit": 1,
  "page": 1
}'

const response = await fetch("https://api.steamsets.com/v1/app.listOwners", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"appId\": 1,\n  \"cursor\": \"string\",\n  \"limit\": 1,\n  \"page\": 1\n}"
});

import requests

response = requests.post(
    "https://api.steamsets.com/v1/app.listOwners",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"appId\": 1,\n  \"cursor\": \"string\",\n  \"limit\": 1,\n  \"page\": 1\n}",
)

Response

{
  "maxPageSize": 0,
  "nextCursor": "string",
  "owners": [
    {
      "animatedAvatar": "string",
      "apps": 123456,
      "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
      "avatarFrame": "string",
      "awardsGiven": 123456,
      "awardsReceived": 123456,
      "background": "string",
      "badges": 123456,
      "bans": 0,
      "city": {
        "name": "Bad Krozingen"
      },
      "country": {
        "code": "DE",
        "name": "Germany"
      },
      "createdAt": "2023-01-01T00:00:00Z",
      "donated": 123456,
      "economyBan": "steam",
      "foilBadges": 123456,
      "friends": 123456,
      "gameBans": 0,
      "level": 123456,
      "miniBackground": "string",
      "name": "steamsets",
      "nameEffect": "rainbow",
      "normalBadges": 123456,
      "playtime": 0,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "region": {
        "name": "Europe"
      },
      "roles": [
        {
          "extras": {
            "property1": null,
            "property2": null
          },
          "rating": 0,
          "role": "user"
        }
      ],
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsScore": 0,
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "themeColor": "#FF5733",
      "vacBans": 0,
      "xp": 123456
    }
  ],
  "page": 0,
  "pageSize": 0,
  "totalPages": 0,
  "trackedOwners": 0
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}