This page was generated with Wiki Builder. Do not change the format!


Gets leaderboards with the signed in user's friends and the supplied destinyMembershipId as the focus. PREVIEW: This endpoint has not yet been implemented. It is being returned for a preview of future functionality, and for public comment/suggestion/preparation.


Path Parameters

Name Schema Required Description
destinyMembershipId integer:int64 Yes The Destiny membershipId of the user to retrieve.
membershipType BungieMembershipType:Enum Yes A valid non-BungieNet membership type.

Query String Parameters

Name Schema Required Description
maxtop integer:int32 No Maximum number of top players to return. Use a large number to get entire leaderboard.
modes string No List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.
statid string No ID of stat to return rather than returning all Leaderboard stats.





PlatformErrorCode: 200

    // Type: Dictionary<string,Dictionary<string,DestinyLeaderboard>>
    "Response": {
        "{string}": {
            "{string}": {
                // Type: string
                "statId": "",
                // Type: DestinyLeaderboardEntry[]
                "entries": [
                   // Type: DestinyLeaderboardEntry
                        // Type: integer:int32
                        "rank": 0,
                        // Type: DestinyPlayer
                        "player": {},
                        // Type: integer:int64
                        "characterId": 0,
                        // Type: DestinyHistoricalStatsValue
                        "value": {}
    // Type: PlatformErrorCodes:Enum
    "ErrorCode": 0,
    // Type: integer:int32
    "ThrottleSeconds": 0,
    // Type: string
    "ErrorStatus": "",
    // Type: string
    "Message": "",
    // Type: Dictionary<string,string>
    "MessageData": {
        "{string}": ""
    // Type: object