Skip to content
Back office

Player List

Lists the users of your agent who are playing a slot game right now, with their game, bet, balance and RTP. This is the list the Playing Users table of the Free Spins page shows.

Markdown

A user is listed once they send a slot transaction, and drops off when they leave the game or stop playing for a short while. A user playing two games shows up once for each game. Only your own users are listed, not those of your sub-agents.

Endpoint

POST https://api.nexusggr.com

Content-Type: application/json

Request

Method: player_list

JSON
{
    "method": "player_list",
    "agent_code": "your_agent_code",
    "agent_token": "your_agent_token"
}
Field Type Required Description
method string Yes Must be player_list
agent_code string Yes Your agent code
agent_token string Yes Your agent API token

Response

Success

JSON
{
    "status": 1,
    "code": 7777777,
    "msg": "SUCCESS",
    "data": [
        {
            "user_code": "test",
            "provider_code": "PRAGMATIC",
            "game_code": "vs20doghouse",
            "bet": 2000,
            "balance": 228500,
            "total_debit": 1520000,
            "total_credit": 1398000,
            "target_rtp": 92,
            "real_rtp": 91.97,
            "updated_at": 1792022400000
        }
    ]
}
Field Type Description
data array One entry per user and game. Empty when nobody is playing
user_code string The user
provider_code string The provider of the game the user is playing
game_code string The game the user is playing
bet number The user's total bet per spin in that game, as of their last transaction
balance number The user's balance. In Seamless mode, the balance your site last returned
total_debit number Everything the user has bet
total_credit number Everything the user has won
target_rtp number The user's target RTP, in percent (see Control RTP)
real_rtp number The user's RTP so far, in percent: total_credit ÷ total_debit × 100
updated_at integer Time of the user's last transaction in that game, in milliseconds since 1970-01-01 (UTC)

Failure

JSON
{
    "status": 0,
    "code": 7770500,
    "msg": "Internal Error"
}

See Response Codes for the codes every method can return.