Glossary

A reference guide for terminology used throughout the API documentation.

Transaction Types

DEBIT

A bet placed by a player. Represents money flowing from the player to the platform. In financial summaries, the sum of all debits equals the total amount wagered.

CREDIT

A win or payout awarded to a player. Represents money flowing from the platform back to the player. Credits reduce the operator's profit.

ROLLBACK

A cancelled or reversed transaction. Rollbacks occur when a game round is voided or a transaction needs to be undone. Funds are returned to the player's balance. Rollbacks reduce the operator's profit.

FREE_SPIN

A promotional free spin transaction. These are promotional spins provided to players at no cost. Any winnings from free spins are paid out as credits. The free spin value represents the nominal bet amount assigned by the provider.

Financial Metrics

RTP (Return to Player)

The percentage of total bets that is returned to players as wins and rollbacks. A key metric for understanding game profitability from both the operator and player perspective.

Formula:

RTP = (total_wins + total_rollbacks) / total_bets * 100

Example: If a player bets $1,000, wins $850, and has $20 in rollbacks:

RTP = ($850 + $20) / $1,000 * 100 = 87.00%

A lower RTP means higher profitability for the operator.

Profit

Net revenue generated from gaming activity. This is the amount retained by the operator after paying out wins and processing rollbacks.

Formula:

Profit = total_bets - total_wins - total_rollbacks

Example: If total bets are $10,000, total wins are $8,500, and total rollbacks are $200:

Profit = $10,000 - $8,500 - $200 = $1,300

Game Rankings

Tier

A classification category for games based on their performance score. Games are ranked from best to worst and grouped into tiers:

Tier	Rankings	Meaning
Diamond	1-3	Top-performing games with the highest scores
Emerald	4-6	Excellent performance, near the top
Platinum	7-9	Solid performance, consistently good
Gold	10-12	Above-average performance
Silver	13-15	Average performance
Bronze	16-18	Below-average performance
Iron	19-21	Lowest-ranked games in the evaluation period

Score

A composite numeric metric calculated from multiple factors including total bets, unique players, transaction volume, and profit margin. The score determines the game's overall ranking and tier placement.

Acceptance Rate

The percentage of a provider's total player base that played a specific game during the evaluation period. This metric indicates how broadly appealing a game is within its provider's catalog.

Formula:

Acceptance Rate = (unique_players / total_provider_players) * 100

Example: If a provider has 200 total players and 50 of them played a specific game:

Acceptance Rate = (50 / 200) * 100 = 25.00%

Rank Change

The difference between a game's current ranking and its ranking in the previous period. A positive value indicates improvement; a negative value indicates decline.

Monetary Value Format

All monetary values in the API are returned in a consistent object format:

Field	Type	Description
raw	number	The raw numeric value, suitable for calculations
formatted	string	Formatted string with currency symbol (e.g., $5,000.00)
large_number	string	Human-readable abbreviated format (e.g., 5K, 1.2M)

General Terms

Client

An operator or platform that integrates with the gaming aggregator. Each client has a unique secret for API authentication.

Provider

A game content supplier (e.g., Pragmatic Play, Evolution Gaming). Providers supply the games available on the platform.

Currency ISO Code

A three-letter code following the ISO 4217 standard that identifies a currency. Common examples: USD (US Dollar), EUR (Euro), CRC (Costa Rican Colon).

Pagination

A method for splitting large result sets into smaller pages. The API returns a pagination object with current_page, total, per_page, and total_pages to help navigate through results.