Skip to content
PeekSeekPeekSeek Docs

Join Queue

PUT
/server/v1/players/{steam64}/queue
curl --request PUT \
  --url 'https://example.com/server/v1/players/1/queue?gamemodes=1&region=paris'

Put this player in the matchmaking queue, or keep them in it.

Called on a timer for everyone in a lobby, so it is both “join” and “still here”. gamemodes is a bitmask and ip the address they play from. Answers like GET /players/{steam64}. A barred player is refused, and the ban comes back on the ban field.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
steam64
required
Steam64
integer

Query Parameters

Section titled “Query Parameters”
gamemodes
Gamemodes
integer
default: 1
region
Region
string
default: paris
ip
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PlayerState

One player as every player-facing route here reports them. A matchId with no relayTo means matched and still choosing.

object
steam64
required
Steam64
string
name
required
Name
string
avatar
required
Any of:
string
elo
required
Elo
integer
rankIcon
required
Rankicon
string
matchId
required
Any of:
integer
relayTo
required
Any of:
string
choose
required
Any of:
Choices

What a player still gets to decide, and what they have decided so far. A list with one entry is not a choice and comes back empty.

object
kits
required
Kits
Array<string>
powerups
required
Powerups
Array<string>
kit
required
Any of:
string
powerup
required
Any of:
string
ban
required
Any of:
Ban
object
reason
required
Reason
string
expires
required
Any of:
integer
permanent
required
Permanent
boolean
Examplegenerated
{
  "steam64": "example",
  "name": "example",
  "avatar": "example",
  "elo": 1,
  "rankIcon": "example",
  "matchId": 1,
  "relayTo": "example",
  "choose": {
    "kits": [
      "example"
    ],
    "powerups": [
      "example"
    ],
    "kit": "example",
    "powerup": "example"
  },
  "ban": {
    "reason": "example",
    "expires": 1,
    "permanent": true
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}