Skip to content
For LLMsView as Markdown·

ScatterKings

iGaming RGS provider — list games, launch sessions, issue/cancel free rounds, and pull round history. Requests signed with an HMAC-SHA256 SK-Signature header; inbound bet/win/rollback/balance callbacks delivered as webhooks.

DetailValue
CategoryiGaming
Base URLhttps://{environment}/integrationservice/api/sk/v1/{operator_id}
AuthenticationHMAC-SHA256
Endpoints8
Connector keyscatter-kings

Using ScatterKings in a workflow

  1. Go to Connections and click New Connection.
  2. Pick ScatterKings from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

EndpointSummary
GET /gamesList available games
GET /games/{gameID}Get details for a specific game
POST /play/startLaunch a remote gaming session
POST /freerounds/issueIssue free rounds to a player
GET /freerounds/getRetrieve details of an issued set of free rounds
POST /freerounds/issuecustombetIssue custom-bet free rounds (Buy Bonus / Extra Bet)
POST /freerounds/cancelCancel a previously issued set of free rounds
GET /rounds/{roundID}Get the financial summary and replay link for a round

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /games

List available games

DetailValue
Operation IDlistGames
MethodGET
Path/games

Parameters

No parameters.

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your ScatterKings connection from the Connection dropdown.
  3. In the Operation dropdown, select listGames.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ScatterKings API reference.

GET /games/{gameID}

Get details for a specific game

DetailValue
Operation IDgetGameDetails
MethodGET
Path/games/{gameID}

Parameters

NameLocationTypeRequired
gameIDpathstringYes
currenciesquerystringNo

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your ScatterKings connection from the Connection dropdown.
  3. In the Operation dropdown, select getGameDetails.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ScatterKings API reference.

POST /play/start

Launch a remote gaming session

DetailValue
Operation IDstartSession
MethodPOST
Path/play/start

Parameters

No parameters.

Request Body

FieldType
GameIDstring
Modestring
Currencystring
Languagestring
PlayerIDstring
ClientTypestring

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your ScatterKings connection from the Connection dropdown.
  3. In the Operation dropdown, select startSession.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ScatterKings API reference.

POST /freerounds/issue

Issue free rounds to a player

DetailValue
Operation IDissueFreeRounds
MethodPOST
Path/freerounds/issue

Parameters

No parameters.

Request Body

FieldType
OperatorFreeRoundsIssueIDstring
PlayerIDstring
GameIDsarray
NumFreeRoundsinteger
FreeRoundValuenumber
FreeRoundCurrencystring
ValidUntilstring

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your ScatterKings connection from the Connection dropdown.
  3. In the Operation dropdown, select issueFreeRounds.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ScatterKings API reference.

GET /freerounds/get

Retrieve details of an issued set of free rounds

DetailValue
Operation IDgetFreeRounds
MethodGET
Path/freerounds/get

Parameters

NameLocationTypeRequired
FreeRoundsIssueIDquerystringNo
OperatorFreeRoundsIssueIDquerystringNo

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your ScatterKings connection from the Connection dropdown.
  3. In the Operation dropdown, select getFreeRounds.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ScatterKings API reference.

POST /freerounds/issuecustombet

Issue custom-bet free rounds (Buy Bonus / Extra Bet)

DetailValue
Operation IDissueCustomBetFreeRounds
MethodPOST
Path/freerounds/issuecustombet

Parameters

No parameters.

Request Body

FieldType
OperatorFreeRoundsIssueIDstring
PlayerIDstring
GameIDstring
NumFreeRoundsinteger
FreeRoundValuenumber
FreeRoundCurrencystring
ValidUntilstring
BetModeNamestring

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your ScatterKings connection from the Connection dropdown.
  3. In the Operation dropdown, select issueCustomBetFreeRounds.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ScatterKings API reference.

POST /freerounds/cancel

Cancel a previously issued set of free rounds

DetailValue
Operation IDcancelFreeRounds
MethodPOST
Path/freerounds/cancel

Parameters

No parameters.

Request Body

FieldType
FreeRoundsIssueIDstring
OperatorFreeRoundsIssueIDstring

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your ScatterKings connection from the Connection dropdown.
  3. In the Operation dropdown, select cancelFreeRounds.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ScatterKings API reference.

GET /rounds/{roundID}

Get the financial summary and replay link for a round

DetailValue
Operation IDgetRoundHistory
MethodGET
Path/rounds/{roundID}

Parameters

NameLocationTypeRequired
roundIDpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your ScatterKings connection from the Connection dropdown.
  3. In the Operation dropdown, select getRoundHistory.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream ScatterKings API reference.