Read an award
The casino calls GET /free-rounds/{bonusId} on the launch API, with a key that holds the free_rounds scope.
/free-rounds/{bonusId}The award with its state and how far it is played. An award ended more than 90 days ago, and a bonusId never awarded, are 404.
Path Parameters
The casino's id of the award.
Query Parameters
The casino's player id.
The award's game.
Header Parameters
The id of the signing key, as issued with it.
Unix seconds, within 60 s of the RGS clock. The first line of the signed payload.
^-?[0-9]+$Base64 (standard, padded) Ed25519 signature of "{X-Timestamp}\n{METHOD}\n{path?query}\n{hex(sha256(body))}".
byteEchoed 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
application/json
curl -X GET "https://example.com/free-rounds/string?playerId=string&gameId=string" \ -H "X-Key-Id: string" \ -H "X-Timestamp: 1793707200" \ -H "X-Signature: string"{ "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}