API docs by Redocly

LobbyScanner API (1.0.0)

Download OpenAPI specification:

API for accessing poker providers, clubs, and tables data

Clubs

Get list of clubs

Retrieves a paginated list of all poker clubs with optional sorting and filtering

query Parameters
sortBy
string
Enum: "clubId" "clubName" "providerId"

Column name to sort by

sortOrder
string
Default: "asc"
Enum: "asc" "desc"

Sort order (ascending or descending)

q
string

Keyword to search for in club names or IDs

providerId
string
Enum: "PokerBros" "ClubGG" "PPPoker"

Filter clubs by provider ID

page
integer >= 1
Default: 1

Page number (1-based)

limit
integer [ 1 .. 100 ]
Default: 50

Number of items per page (max 100)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Health

Check provider health status

Checks if the provider's lastParsed timestamp is within the last 5 minutes

path Parameters
providerId
required
string
Enum: "PokerBros" "ClubGG" "PPPoker"

Provider ID to check

Responses

Response samples

Content type
application/json
{
  • "healthy": true
}

Providers

Get list of providers

Retrieves a list of all poker providers with optional sorting and filtering

query Parameters
sortBy
string
Enum: "providerId" "lastParsed"

Column name to sort by

sortOrder
string
Default: "asc"
Enum: "asc" "desc"

Sort order (ascending or descending)

q
string

Keyword to search for in provider names

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tables

Get list of tables

Retrieves a paginated list of all poker tables with optional sorting and filtering

query Parameters
sortBy
string
Enum: "id" "clubId" "tableName" "gameVariant" "gameMode" "blinds" "buyIn" "prize" "jackpot" "playersSeated" "playersRemaining" "playersRegistered" "tableMaxSeats" "waitingListCount" "startTime" "registrationClosesAt" "status"

Column name to sort by

sortOrder
string
Default: "asc"
Enum: "asc" "desc"

Sort order (ascending or descending)

q
string

Keyword to search for in table names, game variants, or game modes

clubId
string

Filter tables by club ID

providerId
string
Enum: "PokerBros" "ClubGG" "PPPoker"

Filter tables by provider ID

page
integer >= 1
Default: 1

Page number (1-based)

limit
integer [ 1 .. 100 ]
Default: 50

Number of items per page (max 100)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}