GET players

Search for Steam players.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Offset

integer

Min value is 0

Default value is 0

Max value is 2147483647

Limit

integer

Min value is 1

Default value is 100

Max value is 500

sort

Comma-separated values of properties to sort by. Properties may be prefixed with "-" to sort descending. Valid properties are "id", "display_name", "updated_at", and "entries". If not provided, results will sorted using "-entries,display_name,id".

Object []

Required

q

A search query.

string

Response Information

Resource Description

Returns a list of Steam players that match the search query.

PlayersEnvelope
NameDescriptionTypeAdditional information
total

Total number of players.

integer

players

A collection of players.

Player[]

Response Formats

application/json, text/json

Sample:
{
  "total": 1,
  "players": [
    {
      "id": "sample string 1",
      "updated_at": "2020-07-12T11:05:32.0094124Z",
      "display_name": "sample string 2",
      "avatar": "sample string 3"
    },
    {
      "id": "sample string 1",
      "updated_at": "2020-07-12T11:05:32.0094124Z",
      "display_name": "sample string 2",
      "avatar": "sample string 3"
    }
  ]
}