API docs by Redocly

ThrillConnect API Documentation (0.1.26)

Download OpenAPI specification:

License:

The ThrillConnect API is used as the integration point between an operator's frontend and the ThrillTech platform and services. The API has been designed to support the most common use cases that operators have when integrating the ThrillTech Products with their gaming frontends and portals.

Health

Health check endpoint

Health check endpoint

Responses

Response samples

Content type
application/json
{
  • "version": "string"
}

Cors

List CORS rules

List CORS rules

Responses

Response samples

Content type
application/json
{
  • "cors_origin_list": [
    ]
}

Modify CORS rules

Modify CORS rules

Request Body schema: application/json
required
required
Array of objects (CorsOriginDoc)

Responses

Request samples

Content type
application/json
{
  • "cors_origin_list": [
    ]
}

Response samples

Content type
application/json
{
  • "cors_origin_list": [
    ]
}

Remove CORS rules

Remove CORS rules

Request Body schema: application/json
required
cors_origin_list
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "cors_origin_list": [
    ]
}

Response samples

Content type
application/json
{
  • "removed": 0,
  • "cors_origin_list": [
    ]
}

Reload CORS rules from DB

Reload CORS rules from DB

Responses

Response samples

Content type
application/json
{
  • "cors_origin_list": [
    ]
}

Currencies

Retrieve system exchange rates

Retrieve system exchange rates

Responses

Response samples

Content type
application/json
{
  • "last_updated": 0,
  • "base_currency": "string",
  • "multipliers": {
    }
}

Service Event Stream

Subscribe a service to events regarding Jackpots, campaigns, drops and more

Subscribe a service to events regarding Jackpots, campaigns, drops and more

The process of subscribing to events works as follows:

  1. Open a websocket connection to the /events/service?token=SERVICE_JWT_TOKEN endpoint
  2. Subscribe to events of interest

Subscribing to Events

Once the service has connected to the WS, you need to subscribe to events of interest. This subscription will depend on the type of events you are interested in receiving, but for this example, we will subscribe to all events from the ThrillPots platform.

To subscribe to events, you need to send a SubscribeRequest on the WebSocket connection:

{
"SubscribeRequest": {
"events": [{
"source": "thrillpots",
"event_type": "*"
}]
}
}

The above message will subscribe to all events from the ThrillPots platform. There is no acknowledgement response to subscriptions, but if the subscription was successful, you should start receiving events in due time. ThrillPots for example has a JackpotUpdate event which is sent every few seconds.

query Parameters
token
required
string

Service JWT token

Responses

Response samples

Content type
application/json
null

Player Event Stream

Subscribe a player to events regarding Jackpots, campaigns, drops and more

Subscribe a player to events regarding Jackpots, campaigns, drops and more

The process of subscribing to events works as follows:

  1. Open a websocket connection to the /events/{operator_id}/{brand_id}?token={player_token}&currency={player_currency} endpoints (eg wss://THRILLCONNECT_HOST/event/thrilltech/brand1?token=player-auth-token&currency=USD)
  2. Subscribe to events of interest

Subscribing to Events

Once the player has connected to the WS, you need to subscribe to events of interest. This subscription will depend on the type of events you are interested in receiving, but for this example, we will subscribe to all events from the ThrillPots platform.

To subscribe to events, you need to send a SubscribeRequest on the WebSocket connection:

{
"SubscribeRequest": {
"events": [{
"source": "thrillpots",
"event_type": "*"
}]
}
}

The above message will subscribe to all events from the ThrillPots platform. There is no acknowledgement response to subscriptions, but if the subscription was successful, you should start receiving events in due time. ThrillPots for example has a JackpotUpdate event which is sent every few seconds.

path Parameters
operator_id
required
string

The ID of the operator to authenticate against

brand_id
required
string

ID of the brand to authenticate against

query Parameters
token
required
string

Player token to use for wallet authentication

currency
required
string

Player currency

Responses

Response samples

Content type
application/json
null

ThrillPots/Instances

Retrieve the jackpot instance that is available for a specific game, brand and country

Retrieve the jackpot instance that is available for a specific game, brand and country

path Parameters
source_id
required
string

ID of the source to retrieve a jackpot for

brand_id
required
string

ID of the brand of the source

query Parameters
player_id
required
string

ID of the player

country_code
required
string

Country of the player

segments
required
string

Comma separated list of segments the player belongs to

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "currency": "string",
  • "opt_in_required": true,
  • "contribution_type": {
    },
  • "optin_status": {
    },
  • "pots": [
    ],
  • "timestamp_start": 0,
  • "timestamp_end": 0,
  • "status": "Pending"
}

Opt-in / Opt-out for players

Opt-in / Opt-out for players

Request Body schema: application/json
required
instance_id
required
string

The jackpot id for the opt-in/opt-out request

player_id
required
string (OperatorPlayerID)

Represents a player's ID on an operator or aggregators system)

brand_id
required
string

The brand path (operator_id:brand_id) that the player/contribution originates from

player_country
required
string

The country that the player is playing from (ISO-3166-2 country code)

opt_in
required
boolean

Flag indicating whether the player is opting in or out of the jackpot contributions

contribution_value
string or null

[Optional] Indicates the value of the bet the player wishes to make on each contribution

contribution_currency
string or null

[Optional] Indicates the currency of the preferred contribution value. If contribution_value is set but contribution_currency is not, the currency will default to the jackpot base currency

Responses

Request samples

Content type
application/json
{
  • "instance_id": "string",
  • "player_id": "string",
  • "brand_id": "string",
  • "player_country": "string",
  • "opt_in": true,
  • "contribution_value": "string",
  • "contribution_currency": "string"
}

Response samples

Content type
application/json
null

ThrillPots/Sources

Retrieve sources for a specific brand.

Retrieve sources for a specific brand.

A source represents a unique point in the player journey from where a jackpot contribution can originate from.

For example, a source could be a game code (for game-driven contributions), or 'sportsbook' or event 'deposit-flow' for non-gaming related jackpot contributions.

query Parameters
owner_id
required
string

The owner/brand ID to retrieve sources for

name
required
string

An optional name filter for the source

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ThrillPots/Tickers

ticker_by_id

path Parameters
instance_id
required
string

The jackpot instance ID to fetch the ticker for

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "jackpot_type": "Jackpot",
  • "currency": "string",
  • "pots": [
    ],
  • "allowed_brands": [
    ],
  • "allowed_sources": [
    ],
  • "status": "Pending",
  • "timestamp_start": 0,
  • "timestamp_end": 0,
  • "last_updated": 0
}