Igratech Websocket API 1.0.0 documentation

Igratech Websocket API 1.0.0

Igratech Websocket API.

Servers

ws://ws.igratech.webspark.dev/wspublic

Operations

PUB connected
On socket connected
- #connected
- #publish
Accepts the following message:
publish-connected
object
channel
string
response_id
string
Unique request Id from Request -> request_id

object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
Additional properties are allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "connected", "response_id": "", "status": { "code": 200, "message": "OK" }, "data": {} }

This example has been generated automatically.
PUB logout
SCLP-25 Information about login from another Client and close connection
- #logout
- #publish
Accepts the following message:
publish-logout
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
Additional properties are allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "logout", "response_id": "", "status": { "code": 200, "message": "OK" }, "data": {} }

This example has been generated automatically.
PUB ping-pong
Maintain conection response
- #ping-pong
- #publish
Accepts the following message:
publish-pong
object
channel
string
response_id
string
Unique request Id from Request -> request_id

object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
message
string
Default value:"pong"
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "ping", "response_id": "aaa-sll-asdasdjj-s11-ssd-1", "status": { "code": 200, "message": "OK" }, "data": { "message": "pong" } }

This example has been generated automatically.
SUB ping-pong
Maintain conection message
- #ping-pong
- #subscribe
Accepts the following message:
subscribe-ping
object
channel
string
request_id
string
Unique request Id. Used for send response on this request

Additional properties are NOT allowed.
Examples
{ "channel": "ping", "request_id": "aaa-sll-asdasdjj-s11-ssd-1" }

This example has been generated automatically.
PUB settings
Response information about settings
- #settings
- #publish
Accepts the following message:
publish-settings
object
channel
string
response_id
string
Unique request Id from Request -> request_id

object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
object
ping_pong
integer
Time for send ping to server, in ms

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "settings", "response_id": "aaa-sll-asdasdjj-s11-ssd", "status": { "code": 200, "message": "OK" }, "data": { "time": { "ping_pong": 15000 } } }

This example has been generated automatically.
SUB settings
Server info about settings
- #settings
- #subscribe
Accepts the following message:
subscribe-settings
object
channel
string
request_id
string
Unique request Id. Used for send response on this request

Additional properties are NOT allowed.
Examples
{ "channel": "settings", "request_id": "aaa-sll-asdasdjj-s11-ssd" }

This example has been generated automatically.
PUB incident
Info about upcomint incidents for certain game
- #incident
- #publish
Accepts the following message:
publish-incident
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
uid: incident-data
gameId
integer
Id of game to which current incident belongs

teamId
integer
NULLABLE. Id of the team to which the current bet update is relevant

text
string
The text that describes current incident and it will be shown to user

type
string
Type of current incident

Allowed values:
"cardYellow"
"cardRed"
"goal"
"ownGoal"
"corner"
"var"
"substitution"
"penalty"
"offside"
"freeKick"
"start"
"halfTime"
"extraTime"
"finish"
"overTime"
videoUrl
string
A link to the video that should be played when an incident occurs

minute
integer
second
integer
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "incident", "response_id": "", "status": { "code": 200, "message": "OK" }, "data": { "gameId": 0, "teamId": 0, "text": "string", "type": "cardYellow", "videoUrl": "string", "minute": 0, "second": 0 } }

This example has been generated automatically.
PUB bet
Info about bets for certain game
- #bet
- #publish
Accepts the following message:
publish-bet
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
array<object>
uid: bet-data-item
teamId
integer
gameId
integer
text
string
type
string
Type of current incident

Allowed values:
"cardYellow"
"сardYellowTeam"
"cardRedNember"
"cardRedTeam"
"goalNextScorer"
"totalScoreOver"
"totalScoreUnder"
"cornerTeam"
"var"
"substitutions"
"substitutionsTeam"
"penaltyNextScored"
"winner"
array<object>
id
integer
outcome
string
Examples values:
"over 2.5"
odds
number
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "bet", "response_id": "", "status": { "code": 200, "message": "OK" }, "data": { "bets": [ { "teamId": 0, "gameId": 0, "text": "string", "type": "cardYellow", "outcomes": [ { "id": 0, "outcome": "over 2.5", "odds": 1.66 } ] } ] } }

This example has been generated automatically.
PUB bets-result
Updates the status of bets
- #bet
- #result
- #publish
Accepts the following message:
publish-bets-result
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
uid: bets-result-data
array<object>
Array of bets, that caused the balance change. Can be empty.

id
integer
Id of the bet, that changed it's status

status
integer
Updated status of the bet. Can be 0 if failed and 1 if succeeded

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "bets-result", "response_id": "", "status": { "code": 200, "message": "OK" }, "data": { "betResults": [ { "id": 0, "status": 0 } ] } }

This example has been generated automatically.
PUB balance
Updates the balance of the user
- #balance
- #publish
Accepts the following message:
publish-balance
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
balance
number
Updated value of the balance. This update can occur when admin updates the balance of the user manually.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "balance", "response_id": "", "status": { "code": 200, "message": "OK" }, "data": { "balance": 0 } }

This example has been generated automatically.
PUB stats
Updates a set of stats
- #stats
- #publish
Accepts the following message:
publish-stats
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
uid: stats-data
isEnabled
boolean
gameId
integer
text
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "channel": "stats", "response_id": "", "status": { "code": 200, "message": "OK" }, "data": { "isEnabled": true, "gameId": 0, "text": "string" } }

This example has been generated automatically.

Messages

#1publish-stats
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
uid: stats-data
isEnabled
boolean
gameId
integer
text
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
#2publish-balance
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
balance
number
Updated value of the balance. This update can occur when admin updates the balance of the user manually.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
#3publish-bets-result
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
uid: bets-result-data
array<object>
Array of bets, that caused the balance change. Can be empty.

id
integer
Id of the bet, that changed it's status

status
integer
Updated status of the bet. Can be 0 if failed and 1 if succeeded

Additional properties are NOT allowed.
Additional properties are NOT allowed.
#4publish-bet
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
array<object>
uid: bet-data-item
teamId
integer
gameId
integer
text
string
type
string
Type of current incident

Allowed values:
"cardYellow"
"сardYellowTeam"
"cardRedNember"
"cardRedTeam"
"goalNextScorer"
"totalScoreOver"
"totalScoreUnder"
"cornerTeam"
"var"
"substitutions"
"substitutionsTeam"
"penaltyNextScored"
"winner"
array<object>
id
integer
outcome
string
Examples values:
"over 2.5"
odds
number
Additional properties are NOT allowed.
Additional properties are NOT allowed.
#5publish-incident
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
uid: incident-data
gameId
integer
Id of game to which current incident belongs

teamId
integer
NULLABLE. Id of the team to which the current bet update is relevant

text
string
The text that describes current incident and it will be shown to user

type
string
Type of current incident

Allowed values:
"cardYellow"
"cardRed"
"goal"
"ownGoal"
"corner"
"var"
"substitution"
"penalty"
"offside"
"freeKick"
"start"
"halfTime"
"extraTime"
"finish"
"overTime"
videoUrl
string
A link to the video that should be played when an incident occurs

minute
integer
second
integer
Additional properties are NOT allowed.
Additional properties are NOT allowed.
#6publish-connected
object
channel
string
response_id
string
Unique request Id from Request -> request_id

object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
Additional properties are allowed.
Additional properties are NOT allowed.
#7publish-logout
object
channel
string
response_id
string
object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
Additional properties are allowed.
Additional properties are NOT allowed.
#8subscribe-settings
object
channel
string
request_id
string
Unique request Id. Used for send response on this request

Additional properties are NOT allowed.
#9publish-settings
object
channel
string
response_id
string
Unique request Id from Request -> request_id

object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
object
ping_pong
integer
Time for send ping to server, in ms

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
#10subscribe-ping
object
channel
string
request_id
string
Unique request Id. Used for send response on this request

Additional properties are NOT allowed.
#11publish-pong
object
channel
string
response_id
string
Unique request Id from Request -> request_id

object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
message
string
Default value:"pong"
Additional properties are NOT allowed.
Additional properties are NOT allowed.

Schemas

object
uid: status
code
integer
[ 200 .. 599 ]
message
string
Examples values:
"OK"
"Invalid entry"
"Internal server error"
Additional properties are NOT allowed.
object
uid: incident-data
gameId
integer
Id of game to which current incident belongs

teamId
integer
NULLABLE. Id of the team to which the current bet update is relevant

text
string
The text that describes current incident and it will be shown to user

type
string
Type of current incident

Allowed values:
"cardYellow"
"cardRed"
"goal"
"ownGoal"
"corner"
"var"
"substitution"
"penalty"
"offside"
"freeKick"
"start"
"halfTime"
"extraTime"
"finish"
"overTime"
videoUrl
string
A link to the video that should be played when an incident occurs

minute
integer
second
integer
Additional properties are NOT allowed.
object
uid: bet-data-item
teamId
integer
gameId
integer
text
string
type
string
Type of current incident

Allowed values:
"cardYellow"
"сardYellowTeam"
"cardRedNember"
"cardRedTeam"
"goalNextScorer"
"totalScoreOver"
"totalScoreUnder"
"cornerTeam"
"var"
"substitutions"
"substitutionsTeam"
"penaltyNextScored"
"winner"
array<object>
id
integer
outcome
string
Examples values:
"over 2.5"
odds
number
Additional properties are NOT allowed.
object
uid: bets-result-data
array<object>
Array of bets, that caused the balance change. Can be empty.

id
integer
Id of the bet, that changed it's status

status
integer
Updated status of the bet. Can be 0 if failed and 1 if succeeded

Additional properties are NOT allowed.
object
uid: stats-data
isEnabled
boolean
gameId
integer
text
string
Additional properties are NOT allowed.

Igratech Websocket API 1.0.0

Servers

Operations

PUB connected

Examples

This example has been generated automatically.

PUB logout

Examples

This example has been generated automatically.

PUB ping-pong

Examples

This example has been generated automatically.

SUB ping-pong

Examples

This example has been generated automatically.

PUB settings

Examples

This example has been generated automatically.

SUB settings

Examples

This example has been generated automatically.

PUB incident

Examples

This example has been generated automatically.

PUB bet

Examples

This example has been generated automatically.

PUB bets-result

Examples

This example has been generated automatically.

PUB balance

Examples

This example has been generated automatically.

PUB stats

Examples

This example has been generated automatically.

Messages

Schemas