JRGS Casino API
ReferenceLaunch API

List a player's awards in a game

The casino calls GET /players/{playerId}/free-rounds on the launch API, with a key that holds the free_rounds scope.

GET/players/{playerId}/free-rounds

The player's awards in the game, active first, then the newest first. An award ended more than 90 days ago is not listed.

Path Parameters

playerId*string

The casino's player id.

Query Parameters

gameId*string

The game. Required for now.

Header Parameters

X-Key-Id*string

The id of the signing key, as issued with it.

X-Timestamp*string

Unix seconds, within 60 s of the RGS clock. The first line of the signed payload.

Match^-?[0-9]+$
X-Signature*string

Base64 (standard, padded) Ed25519 signature of "{X-Timestamp}\n{METHOD}\n{path?query}\n{hex(sha256(body))}".

Formatbyte
X-Request-Id?string

Echoed as requestId in an error. One is generated when absent. On POST /sessions the body's requestId replaces it once the body has been read and signed.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/players/string/free-rounds?gameId=string" \  -H "X-Key-Id: string" \  -H "X-Timestamp: 1793707200" \  -H "X-Signature: string"
{  "items": [    {      "bonusId": "string",      "awardId": "3f696bdd-e4bc-4a03-b01a-16da5c324b35",      "marketId": "string",      "gameId": "string",      "player": {        "id": "string",        "currency": "string"      },      "rounds": 0,      "bet": 0,      "expiresAt": "2019-08-24T14:15:22Z",      "state": "active",      "played": 0,      "remaining": 0,      "totalWin": 0    }  ]}