Glossary¶
- ExtraDataSchema¶
The ExtraDataSchema data transfer object contains additional information about the provider, usually passed with requests and responses for provider data.
Parameter
Type
Description
currencies
[string(2)]
A list of currency codes
See also
- GameSchema¶
The GameSchema data transfer object contains information about a single game.
Param
Type
Description
gameId
string
The unique identifier of the game
providerId
string
The unique identifier of the provider
name
string
The name of the game to be displayed to players
deviceType
string
The type of device. The following values are permitted:
DESKTOP
MOBILE
DESKTOP_AND_MOBILE
category
string
A general category that this game belongs to, such as online slots, live casino, crash and so on.
volatility
string
The volatility level - how often the winning combination or number happens. The following volatility levels apply:
LOW
MEDIUM
HIGH
null
rtp
number
The RTP (return to player) of this game, which refers to the ratio of all wagered money that eventually returns to players in the form of winnings.
hasDemoMode
boolean
An indicator that informs that this game can be run by using the start-demo method
hasFreeBets
boolean
An indicator that informs that this game offers free bets
- GetProvidersRequestSchema¶
This data transfer object contains parameters for obtaining information about the providers available to the specified brand.
Param
Type
Description
brandId
string
The identifier of the casino brand
extraData (optional)
boolean
Additional information about the provider, such as supported currencies.
Default: false
size (optional)
number
The maximum number of providers to return on a single page.
Default: 20
page (optional)
number
The requested page, (counting from 1).
Default: 1
See also
- GetProvidersResponseSchema¶
This data transfer object contains data about providers assigned to the selected brand.
Optionally, GetProvidersResponseSchema may contain information about the paged output of the providers in its catalogue.
Param
Type
Description
items
[ProviderInfoDto]
A list of instances of the ProviderInfoSchema object which contain information about the providers that satisfy the criteria in the matching request.
meta
PaginationMetaDto
If the list of providers is long then details about the portion of providers returned in this response are included in this element as an instance of the PaginationMetaSchema object.
See also
- PaginationMetaSchema¶
The PaginationMetaSchema data transfer object informs how a collection of requested items is to be delivered by equal portions.
Param
Type
Description
totalItems
number
The total number of items in the collection that matches the request.
itemCount
number
The number of items returned in this particular response
itemsPerPage
number
The maximum number of items from the data set that may fit in a page.
totalPages
number
The total number of pages required to deliver the whole collection.
currentPage
number
The current page number for this particular response.
- ProviderGamesRequestSchema¶
The ProviderGamesRequestSchema data transfer object contains information about requesting the games associated with the selected provider.
Parameter
Type
Description
brandId
string
The identifier of the casino brand
providerId
string
The unique identifier of the provider
size (optional)
number
The maximum number of games to return on a single page.
Default: 20
page (optional)
number
The requested page (counting from 1).
Default: 1
- ProviderGamesResponseSchema¶
The ProviderGamesResponseSchema data transfer object contains data about the games associated with the requested provider.
Optionally, ProviderGamesResponseSchema may contain information about the paged output of the providers in its catalogue.
Parameter
Type
Description
items
[GameEntity]
A list of instances of the GameSchema object which contain information about the games that satisfy the criteria in the matching provider games request.
meta (optional)
[PaginationMetaDto]
If the list of games is long then details about the portion of games returned in this response are included in this element as an instance of the PaginationMetaSchema object.
See also
- ProviderInfoSchema¶
The ProviderInfoSchema data transfer object contains information about an individual provider.
Parameter
Type
Description
providerId
string
The unique identifier of the provider
providerName
string
The name of the provider in the format that it should appear in the interface.
logoForDark
string
The path to the provider’s logo which should appear on a dark background
logoForLight
string
The path to the provider’s logo which should appear on a light background
extraData
ExtraDataDto
Additional information about the provider, such as supported currencies.
Footnotes