Rankings

List Player Rankings

GET

/v1/data/partner_rankings

💡

This request requires “PB-API-TOKEN” from the platforms.

Query Parameters

Name	Description
partner(string)	Currently supported value is only 'PPA'.
division_type (int)	Enum Lookup Table below.
race (int)	This query param can not be used with start_date param. It should be year of race like race=2023.
start_date (int)	Unix timestamp value in UTC, can not be used with race parameter.
current_page (int)	Pagination current page
page_size (int)	Pagination page size
show_all_info (bool)	lists additional information for each player
gender	used with "division_type"=3 query param (Mixed Doubles rankings) to sort out only the male and female rankings out of the mixed doubles rankings, it can be either "M" (male) or F(female)

Request

Empty

Note: Response is sorted by player ranking.

{
   total_records: 3,
   results: [
{
            "player_uuid": "d7003c83-228e-4265-88f6-308d729a2338",
            "player_full_name": "John Doe",
            "points": 110350,
            "ranking": "32",
            "profile_image":"https://image.url",
            "age": "35",
            "gender": "F",
            "city": "GILBERT",
            "state": "Arizona",
            "country": "United States",
            "is_tied": false,
            "is_adjusted": false,
            "total_tournaments_played": 10,
            "pb_uuid": "test-pb-uuid",
            "player_first_name": "John",
            "player_last_name": "Doe",
            "player_country_abbreviation": "USA"
        },
        {
            "player_uuid": "74fcc97d-964d-44e7-8d0f-20334f8eb7f3",
            "player_full_name": "John Doe",
            "points": 110150,
            "ranking": "33",
            "profile_image":"https://image.url",
            "age": "35",
            "gender": "M",
            "city": "Kearns",
            "state": "Utah",
            "country": "United States",
            "is_tied": false,
            "is_adjusted": false,
            "total_tournaments_played": 10,
            "pb_uuid": "test-pb-uuid",
            "player_first_name": "John",
            "player_last_name": "Doe",
            "player_country_abbreviation": "USA"
        },
        {
            "player_uuid": "63FD86A5-A7E7-4716-ABA7-EC9DFE457ABA",
            "player_full_name": "John Doe",
            "points": 110100,
            "ranking": "34",
            "profile_image":"https://image.url",
            "age": "47",
            "gender": "F",
            "city": "Middletown",
            "state": "Connecticut",
            "country": "United States",
            "is_tied": false,
            "is_adjusted": false,
            "total_tournaments_played": 10,
            "pb_uuid": "test-pb-uuid",
            "player_first_name": "John",
            "player_last_name": "Doe",
            "player_country_abbreviation": "USA",
            "playerSlug": "test-slug"
            
        }
]
}

List Tournament Event Awarded Points

GET

/v1/data/tournament_events/{uuid}/points

💡

This request requires “PB-API-TOKEN” from the platforms.

Request

Empty

Note: Response is sorted by most amount of points.

Response

{
   total_records: 2,
   results: [
     {
       "player_uuid":"uuid-of-player-1",
       "player_full_name":"Ben Johns",
       "points": 1000,
       "last_match_round": 4,
       "last_match_round_text": "Finals",
       "last_match_uuid": "xyz-ijk"
     },
      {
      "player_uuid":"uuid-of-player-1",
       "player_full_name":"Tyson McGuffin",
       "points": 800,
       "last_match_round": 4,
       "last_match_round_text": "Finals",
       "last_match_uuid": "xyz-ijk"
     }
   ]
}

Last Rankings Algorithm Run

GET

/v1/data/partner_rankings_stats

💡

This request requires “PB-API-TOKEN” from the platforms.

Query Parameters

Name	Description
partner (string)	Partner abbreviation for eg. 'PPA

Request

Empty

Response

{
   result:
     {
       "last_update": 1693069385 // Unix timestamp
     }
}

List of Table Enums

{
  UNDEFINED_PPA_DIVISION_TYPE = 0;
  WOMENS_SINGLES_DIVISION_TYPE = 1;
  MENS_SINGLES_DIVISION_TYPE = 2;
  MIXED_DOUBLES_DIVISION_TYPE = 3;
  WOMENS_DOUBLES_DIVISION_TYPE = 4;
  MENS_DOUBLES_DIVISION_TYPE = 5;
}

Upsert PPA Ranking

POST

/v1/admin/rankings/upsert

💡

This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.

Request

{
    "payload": {
        "playerUuid": "test-uuid",
        "playerFullName": "",
        "tournamentUuid": "",
        "tournamentTitle": "",
        "eventUuid": "d2a2f139-b513-4f0f-9911-d8c99b43fa1c",
        "eventTitle": "",
        "eventDate": "2024-01-03T22:47:18.968732Z",
        "bracketLevelId": 0,
        "pointsType": 0,
        "points": 1000,
        "lastMatchRound": 0,
        "lastMatchRoundText": "",
        "lastMatchDateCompleted": "2024-01-03T22:47:18.968732Z",
        "lastMatchUuid": "",
        "tier": "",
        "cancelsOutTournamentUuid": "",
        "ignoreInFinalCalculation": false,
        "isLocked": false
    }
}

Response

{
    "result": {
        "playerUuid": "test-uuid",
        "playerFullName": "",
        "tournamentUuid": "",
        "tournamentTitle": "",
        "eventUuid": "d2a2f139-b513-4f0f-9911-d8c99b43fa1c",
        "eventTitle": "",
        "eventDate": "2024-01-03T22:47:18.968732Z",
        "bracketLevelId": 0,
        "pointsType": 0,
        "points": 1000,
        "lastMatchRound": 0,
        "lastMatchRoundText": "",
        "lastMatchDateCompleted": "2024-01-03T22:47:18.968732Z",
        "lastMatchUuid": "",
        "tier": "",
        "cancelsOutTournamentUuid": "",
        "ignoreInFinalCalculation": false,
        "isLocked": false
    }
}

Print Spooler Sponsors