v1

latestOpenAPI 3.1.02026-07-1410021.9 KB

Leaderboard by GUID

Retrieves leaderboard information for one (or more) contracts

get/leaderboards-by-guid

Query parameters

platformsstring required

The platforms requested, separated by a comma. Possible values are Epic, PlayStation, Steam, Switch, Xbox.

contractGuidsstring required

The contract GUIDs, separated by comma

Response

200

contractIdsstring[]

{"stackTrail":"paths:/leaderboards-by-guid:get:responses:200:content:application/json:schema:properties:uniqueContractNames","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/leaderboards-by-guid:get:responses:200:content:application/json:schema:properties:uniqueContractLocations","oasType":"schema","type":"unknown"}

accessTimestring

Example response

{
  "contractIds": [
    "caf3fa91-38fe-46b5-bf8e-438380da0e21"
  ],
  "entries": [
    {
      "playerId": "00000000-0000-0000-0000-000000000000",
      "playerName": "Name",
      "compositeRank": 1,
      "platformRank": 1,
      "platform": "Epic",
      "elapsedTime": "00:00:04",
      "totalScore": 209440,
      "detailedScore": {
        "silentAssassin": true,
        "starCount": 5,
        "objectivesCompleted": true,
        "noNoticedKills": true,
        "noBodiesFound": true,
        "neverSpotted": true,
        "noRecordings": true,
        "timeBonus": 109440
      }
    }
  ],
  "accessTime": "2022-02-27T21:05:57.329457Z"
}