Data Integration

Below you can find the documentation on API methods. For each method the following information is provided:

List of parameters.
List of errors returned by the method.
Data model returned.

POST v2/app/reports/ad_hoc

This method provides a report with Ah Hoc data for all players over a period of time.

Request URL

POST http(s)://API_URL/v2/app/reports/ad_hoc

Parameter	Value	Description	Parameter Type	Data Type
clientId	(required)	Identifier that is sent in the request line	query	string
sign	(required)	Request signature	header	string
userId		User identifier	formData	string
currency		Currency ISO code	formData	string
dateFrom	(required)	The start date of the report. Example: 2017-12-01 00:00:00	formData	string
dateTo	(required)	The end date of the report. Example: 2017-12-01 00:00:00	formData	string
per-page		Parameter to specify the number of records per page	query	integer
page		Parameter to specify the page number to be retrieved	query	integer

Error codes

HTTP Code	Message
400	Bad Request
403	Forbidden
404	Not found
422	Incorrect data
500	Internal Server Error

Success response

{
  "data": [
    {
      "id": "116593-82-2018-04-23",
      "type": "ad-hoc-report",
      "attributes": {
        "user-id": "116593",
        "date": "2020-04-23",
        "money-type": 82,
        "currency": "USD",
        "win": 0,
        "loss": 0,
        "deposit": 0,
        "withdraw": 0,
        "bets": 0,
        "rake": 0,
        "jackpot": 0,
        "tournament-fee": 0,
        "tournament-bet": 0,
        "tournament-prize": 0,
        "cash-result": 0,
        "tournament-result": 0,
        "ticket-fee": 0,
        "ticket-bet": 0,
        "slot-credit": 0,
        "slot-debit": 0,
        "rakeback": 0,
        "rakeback-paid": 0,
        "rakeback-unpaid": 0,
        "rabbit-hunting": 0
      }
    }
  ],
  "links": {
    "self": {
      "href": "string"
    }
  },
  "meta": {
    "total-count": 0,
    "page-count": 0,
    "current-page": 0,
    "per-page": 0
  }
}

info

Monetary values are returned with the precision of the currency. For example, for USD (precision 2), ""rake": 28831" means 288.31 (288 dollars and 31 cents). If the precision is 4, the same value would be 2.8831 (2 dollars and 8831 fractional units). This format ensures accuracy for all currencies.

Data aggregation in the system takes place every 10 minutes for the specified parameters. The displayed data corresponds to the period defined in the request. For instance, if parameters such as dateFrom = 2024-03-24 00:00:00 and dateTo = 2024-03-25 00:00:00 are included in the request, the returned data will represent the Ad Hoc information for the 24th of March.

GET v2/app/users/rake

This method provides information regarding the player's rake. It includes rake from cash tables as well as entryFee, rebuyAddonFee.

Request URL

GET http(s)://API_URL/v2/app/users/rake

Parameter	Value	Description	Parameter Type	Data Type
clientId	(required)	Identifier that is sent in the request line	query	string
sign	(required)	Request signature	header	string
userId		User identifier	formData	string
currency		Currency ISO code	formData	string
dateFrom	(required)	The start date of the report. Example: 2017-12-01 00:00:00	formData	string
dateTo	(required)	The end date of the report. Example: 2017-12-01 00:00:00	formData	string
timeZone		Example: Asia/Calcutta, +03:00	query	string
convertToPreferredCurrency		Convert the rake data to the user's preferred currency. If the preferred currency is not set, the default system currency is used	query	string
per-page		Parameter to specify the number of records per page	query	integer
page		Parameter to specify the page number to be retrieved	query	integer
sort		Field for the parameter by which to sort the tables	query	string

Error codes

HTTP Code	Message
400	Bad Request
403	Forbidden
404	Not found
422	Incorrect data
500	Internal Server Error

Success response

{
  "data": [
    {
      "id": "string",
      "type": "players-rake",
      "attributes": {
        "user-id": "string",
        "currency": "string",
        "value": 0
      }
    }
  ],
  "links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    }
  },
  "meta": {
    "total-count": 0,
    "page-count": 0,
    "current-page": 0,
    "per-page": 0
  }
}

info

Data Integration

POST v2/app/reports/ad_hoc​

GET v2/app/users/rake​

POST v2/app/reports/ad_hoc

GET v2/app/users/rake