AuctiOn Documentation

Appearance

v1.0.0

Lobby service​

Lobby service API

Add a lobby​

POST
/lobbies/create

Create a new lobby

Request Body​

application/json
JSON
{
"maxPlayers": 0,
"rounds": 0,
"startAmount": 0,
"startInventory": {
"items": [
{
"item": "string",
"quantity": 0
}
]
},
"bidTime": 0
}

Responses​

Lobby created successfully

Playground​

Body

Samples​

cURL
JavaScript
PHP
Python

Join a lobby by ID​

POST
/lobbies/{id}/join

Join an existing lobby

Parameters​

Path Parameters

id*
Typestring
Required
minLength24
maxLength24

Responses​

Successfully joined the lobby

Playground​

Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Update player status​

PUT
/lobbies/status

Set the status of a player in a lobby

Request Body​

application/json
JSON
{
"status": "string"
}

Responses​

Player status updated successfully

Playground​

Body

Samples​

cURL
JavaScript
PHP
Python

Leave the current lobby​

POST
/lobbies/leave

Leave a lobby

Responses​

Successfully left the lobby

Playground​

Samples​

cURL
JavaScript
PHP
Python

Remove a player from the lobby​

POST
/lobbies/kick/{userId}

Kick a player from the lobby

Parameters​

Path Parameters

userId*
Typestring
Required
minLength1

Responses​

Player kicked successfully

Playground​

Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Begin the match​

POST
/lobbies/start

Start a match in the lobby

Responses​

Match started successfully

Playground​

Samples​

cURL
JavaScript
PHP
Python

Retrieve active lobby information​

GET
/lobbies

Get the current active lobby for the user

Responses​

Active lobby retrieved successfully

Playground​

Samples​

cURL
JavaScript
PHP
Python
Powered by VitePress OpenAPI

Marco Frattarola