Table of Contents



Introduction

Necro Lab's API is RESTful and can be completely accessed via GET requests. It's base URL is:

https://api.necrolab.com

Https is required for all requests.



Response Codes
Http Code Description
200 The request was successful.
400 A request parameter was incorrect. The request body should provide a description of which parameter was incorrect.
500 An internal error was encountered on the server. Please contact the site's administrator with the incident number specified in the response body to help resolve this error.
503 The site is down for maintenance. Please check back later.


Response Structure

All requests have a json response structure in the following format:

Property Description
request Contains all of the parameters passed into the request.
record_count The total number of records that this resultset contains. Can be used with start and limit for pagination.
response Contains the resultset of the request.


An example json response structure looks similar to this:

{
    "request": {
        "release": "amplified_dlc",
        "date": "2017-03-01",
        "start": 0,
        "limit": 100,
        "sort_by": "rank",
        "sort_direction": "asc",
        ...
    },
    "record_count": 0,
    "data": [
        ...
    ]
}


Common Parameters
Parameter Description Valid Values
release The name of the release that the data applies to. An always up to date list of releases can be found via the /releases endpoint.
  • alpha
  • early_access
  • original
  • amplified_dlc
mode The name of the mode that the data applies to. An always up to date list of modes can be found via the /modes endpoint.
  • normal
  • hard
  • no_return
site Specifying a site name only pulls data for players that have linked their respective account to Necro Lab. An always up to date list of sites can be found via the /external_sites endpoint. Defaults to null, which assumes steam.
  • beampro
  • discord
  • reddit
  • twitch
  • twitter
  • youtube
character The character that the result will apply to. An always up to date list of characters can be found via the /characters endpoint.
  • cadence
  • bard
  • aria
  • bolt
  • monk
  • dove
  • eli
  • melody
  • dorian
  • coda
  • nocturna
  • diamond
  • all
  • story
date The date that the resultset will be pulled for. A date in the YYYY-MM-DD format.
start The offset that the data will begin from. This can be used in conjunction with limit for pagination. Defaults to 0. A valid integer between 0 and the value found in request.record_count
limit Limits the result to a specified number of rows. This can be used in conjunction with start for pagination. Defaults to 100. A valid integer between 0 and 10000.
sort_by Sorts the result by the specified column. Please see specific endpoint documentation for list of fields to sort by as it varies. Defaults to null for the default sort.
sort_direction The direction to sort the result by. Defaults to asc.
  • asc for ascending order.
  • desc for descending order.
lbid The leaderboard's unique ID. A valid integer greater than 0. Values can be found by using the lbid property in the results of the following endpoints:
steamid The steamid of the player. A valid integer greater than 0. steamids that exist in NecroLab can be obtained via the /players endpoint.
number_of_days The timeframe in days to view daily rankings for.
  • 30 for a 30 day view.
  • 100 for a 100 day view.
  • 0 for all days since the beginning of the release.
start_date The date that the result will start at. A date in the YYYY-MM-DD format.
end_date The date that the result will end at. A date in the YYYY-MM-DD format. Defaults to today's date, or the corresponding release end date if that is before today's date.
search Filters records in the result to only include usernames containing this value. Username filtering applies to the corresponding site Any string. Value is case-insensitive.


Top Level Endpoints

GET /releases

  • Retrieves all releases that are currently active.


    Required Parameters

    None

    Optional Parameters

    None

    Example Request

    https://api.necrolab.com/releases

    Example Response

    {
        "request": {},
        "record_count": 4
        "data": [
            {
                "name": "alpha",
                "display_name": "Alpha",
                "start_date": "2000-01-01",
                "end_date": "2014-07-30"
            },
            {
                "name": "early_access",
                "display_name": "Early Access",
                "start_date": "2014-07-30",
                "end_date": "2015-04-22"
            },
            {
                "name": "original",
                "display_name": "Original Release",
                "start_date": "2015-04-23",
                "end_date": null
            },
            {
                "name": "amplified_dlc",
                "display_name": "Amplified DLC",
                "start_date": "2017-01-24",
                "end_date": null
            }
        ]
    }


GET /modes

  • Retrieves all modes that are currently active.


    Required Parameters

    None

    Optional Parameters

    None

    Example Request

    https://api.necrolab.com/modes

    Example Response

    {
        "request": [],
        "record_count": 3,
        "data": [
            {
                "name": "normal",
                "display_name": "Normal"
            },
            {
                "name": "hard",
                "display_name": "Hard"
            },
            {
                "name": "no_return",
                "display_name": "No Return"
            }
        ]
    }


GET /characters

  • Retrieves all characters that are currently active.


    Required Parameters

    None


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/characters


    Example Response

    {
        "request": {},
        "record_count": 13,
        "data": [
            {
                "name": "cadence",
                "display_name": "Cadence"
            },
            {
                "name": "bard",
                "display_name": "Bard"
            },
            {
                "name": "aria",
                "display_name": "Aria"
            },
            {
                "name": "bolt",
                "display_name": "Bolt"
            },
            
                "name": "monk",
                "display_name": "Monk"
            },
            {
                "name": "dove",
                "display_name": "Dove"
            },
            {
                "name": "eli",
                "display_name": "Eli"
            },
            {
                "name": "melody",
                "display_name": "Melody"
            },
            {
                "name": "dorian",
                "display_name": "Dorian"
            },
            {
                "name": "coda",
                "display_name": "Coda"
            },
            {
                "name": "nocturna",
                "display_name": "Nocturna"
            },
            {
                "name": "story",
                "display_name": "Cadence, Melody, and Aria"
            },
            {
                "name": "all",
                "display_name": "All"
            }
        ]
    }


GET /external_sites

  • Retrieves all active external sites that results in other endpoints can be filtered by.


    Required Parameters

    None


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/external_sites


    Example Response

    {
        "request": {},
        "record_count": 6
        "data": [
            {
                "name": "beampro",
                "display_name": "Beam.pro"
            },
            {
                "name": "discord",
                "display_name": "Discord"
            },
            {
                "name": "reddit",
                "display_name": "Reddit"
            },
            {
                "name": "twitch",
                "display_name": "Twitch"
            },
            {
                "name": "twitter",
                "display_name": "Twitter"
            },
            {
                "name": "youtube",
                "display_name": "Youtube"
            }
        ]
    }



Leaderboard Endpoints

GET/leaderboards/xml

  • Retrieves the urls for all leaderboard XML downloaded.


    Required Parameters

    None


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/leaderboards/xml


    Example Response

    {
        "request": [],
        "record_count": 81,
        "data": [
            "https://necrolab.s3.amazonaws.com/leaderboard_xml/2017-01-01.zip",
            "https://necrolab.s3.amazonaws.com/leaderboard_xml/2017-01-02.zip",
            "https://necrolab.s3.amazonaws.com/leaderboard_xml/2017-01-03.zip",
            "https://necrolab.s3.amazonaws.com/leaderboard_xml/2017-01-04.zip",
            "https://necrolab.s3.amazonaws.com/leaderboard_xml/2017-01-05.zip",
            "https://necrolab.s3.amazonaws.com/leaderboard_xml/2017-01-06.zip",
            ...
        ]
    }


GET /leaderboards

  • Retrieves all leaderboards for the specified release and mode.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    • name
    • display_name
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/leaderboards?release=amplified_dlc&mode=normal


    Example Response

    {
        "request": {
            "release": "amplified_dlc",
            "mode": "normal",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 73,
        "data": [
            {
                "lbid": 1694062,
                "name": "DLC HARDCORE_PROD",
                "display_name": "Cadence Score (Amplified)",
                "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/1694062/?xml=1",
                "character": "cadence",
                "character_number": 1,
                "is_daily": 0,
                "daily_date": null,
                "is_score_run": 1,
                "is_speedrun": 0,
                "is_deathless": 0,
                "is_seeded": 0,
                "is_co_op": 0,
                "is_custom": 0,
                "is_power_ranking": 1,
                "is_daily_ranking": 0,
                "mode": {
                    "name": "normal",
                    "display_name": "Normal"
                }
            },
            ...
        ]
    }


GET /leaderboards/score

  • An alias for /leaderboards that only retrieves score leaderboards.


GET /leaderboards/speed

  • An alias for /leaderboards that only retrieves speed leaderboards.


GET /leaderboards/deathless

  • An alias for /leaderboards that only retrieves deathless leaderboards.


GET /leaderboards/daily

  • An alias for /leaderboards that only retrieves daily leaderboards.


GET /leaderboards/leaderboard

  • Retrieves the properties of a single specified leaderboard.


    Required Parameters

    Parameter Description Valid Values
    lbid Please see the lbid section under common parameters.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/leaderboards/leaderboard?lbid=1694062


    Example Response

    {
        "request": {
            "lbid": "1694062"
        },
        "record_count": 1,
        "data": [
            {
                "lbid": "1694062",
                "leaderboard_name": "DLC HARDCORE_PROD",
                "leaderboard_display_name": "Cadence Score (Amplified)",
                "url": "http://steamcommunity.com/stats/247080/leaderboards/1694062/?xml=1",
                "is_speedrun": 0,
                "is_custom": 0,
                "is_co_op": 0,
                "is_seeded": 0,
                "is_daily": 0,
                "daily_date": null,
                "is_score_run": 1,
                "is_deathless": 0,
                "is_power_ranking": 1,
                "is_daily_ranking": 0,
                "release_id": 4,
                "character_id": 1,
                "character_name": "cadence",
                "character_number": 1,
                "mode": {
                    "name": "normal",
                    "display_name": "Normal"
                }
            }
        ]
    }


GET /leaderboards/snapshots

  • Retrieves all of the dates that a specified leaderboard has entries for.


    Required Parameters

    Parameter Description Valid Values
    lbid Please see the lbid section under common parameters.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/leaderboards/snapshots?lbid=1701929


    Example Response

    {
        "request": {
                "lbid": 1701929,
                "record_count": 48
        },
        "data": [
                "2017-01-27",
                "2017-01-28",
                "2017-01-30",
                "2017-01-31",
                ...
            }
        ]
    }


GET /leaderboards/entries

  • Retrieves entries for a leaderboard on a specified date and criteria.


    Required Parameters

    Parameter Description Valid Values
    lbid Please see the lbid section under common parameters.
    date Please see the date section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    site Please see the site section under common parameters.
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.
    search Please see the search section under common parameters.


    Example Request

    https://api.necrolab.com/leaderboards/entries?lbid=1694062&date=2017-03-08


    Example Response

    {
        "request": {
            "lbid": 1694062,
            "site": "",
            "date": "2017-03-08",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 6265,
        "data": [
            {
                "player": {
                    "steamid": "76561198171801786",
                    "personaname": "asinoura48",
                    "linked": {
                        "steam": {
                            "personaname": "asinoura48",
                            "profile_url": "http://steamcommunity.com/profiles/76561198171801786/"
                        },
                        "twitch": null,
                        "discord": {
                            "username": null,
                            "discriminator": null
                        },
                        "reddit": null,
                        "youtube": null,
                        "twitter": {
                            "nickname": null,
                            "name": null
                        },
                        "beampro": null
                    }
                },
                "rank": 1,
                "details": "0500000006000000",
                "zone": 5,
                "level": 6,
                "win": 1,
                "score": 31233,
                "replay": {
                    "ugcid": 91599028255190178,
                    "version": null,
                    "seed": 1640128,
                    "run_result": null,
                    "file_url": https://necrolab.s3.amazonaws.com/replays/91599028255190178.zip
                }
            },
            ...
        ]
    }


GET /leaderboards/daily/entries

  • Retrieves entries for a daily leaderboard on a specified release, date, and other criteria.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.
    date Please see the date section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    site Please see the site section under common parameters.
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.
    search Please see the search section under common parameters.


    Example Request

    https://api.necrolab.com/leaderboards/daily/entries?release=original&mode=normal&date=2016-02-10


    Example Response

    {
        "request": {
            "release": "original",
            "mode": "normal",
            "site": "",
            "date": "2016-02-10",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null,
            "search": ""
        },
        "record_count": 6265,
        "data": [
            {
                "player": {
                    "steamid": "76561198051520646",
                    "personaname": "Merzon",
                        "linked": {
                            "steam": {
                                "personaname": "Merzon",
                                "profile_url": "http://steamcommunity.com/profiles/76561198051520646/"
                            },
                            "twitch": null,
                            "discord": {
                                "username": null,
                                "discriminator": null
                            },
                            "reddit": null,
                            "youtube": null,
                            "twitter": {
                                "nickname": null,
                                "name": null
                            },
                            "beampro": null
                        }
                    },
                "rank": 1,
                "details": "0400000006000000",
                "zone": 4,
                "level": 6,
                "win": 1,
                "score": 15903,
                "replay": {
                    "ugcid": 312241798833947815,
                    "version": null,
                    "seed": 42496,
                    "run_result": null,
                    "file_url": "https://necrolab.s3.amazonaws.com/replays/312241798833947815.zip"
                }
            },
            ...
        ]
    }


GET /leaderboards/replays

  • Retrieves all leaderboard entry replays for the specified release.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/leaderboards/replays?release=amplified_dlc


    Example Response

    {
        "request": {
            "release": "amplified_dlc",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 55306,
        "data": [
            {
                "steamid": 76561197979118640,
                "leaderboard": {
                    "lbid": 1700534,
                    "name": "DLC HARDCORE All Chars_PROD",
                    "display_name": "All Characters Score (Amplified)",
                    "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/1700534/?xml=1",
                    "character": "all",
                    "character_number": 14,
                    "is_daily": 0,
                    "daily_date": null,
                    "is_score_run": 1,
                    "is_speedrun": 0,
                    "is_deathless": 0,
                    "is_seeded": 0,
                    "is_co_op": 0,
                    "is_custom": 0,
                    "is_power_ranking": 1,
                    "is_daily_ranking": 0,
                    "mode": {
                        "name": "normal",
                        "display_name": "Normal"
                    }
                },
                "pb": {
                    "date": "2017-03-20",
                    "rank": 649,
                    "details": "0000000001000000",
                    "zone": 0,
                    "level": 1,
                    "win": 0,
                    "score": 0,
                    "replay": {
                        "ugcid": "80342832064696717",
                        "version": null,
                        "seed": null,
                        "run_result": null,
                        "file_url": null
                    }
                },
                "replay": {
                    "ugcid": "80342832064696717",
                    "version": null,
                    "seed": null,
                    "run_result": null,
                    "file_url": null
                }
            },
            ...
        ]
    }


GET /leaderboards/replays/replay

  • Retrieves a single replay by its unique id.


    Required Parameters

    Parameter Description Valid Values
    ugcid The unique id of the replay. Must be a valid 64-bit integer greater than 0.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/leaderboards/replays/replay?ugcid=82590571760664522


    Example Response

    {
        "request": {
            "ugcid": "82590571760664522"
        },
        "record_count": 1,
        "data": {
            "steamid": 76561197979118640,
            "leaderboard": {
                "lbid": 1700534,
                "name": "DLC HARDCORE All Chars_PROD",
                "display_name": "All Characters Score (Amplified)",
                "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/1700534/?xml=1",
                "character": "all",
                "character_number": 14,
                "is_daily": 0,
                "daily_date": null,
                "is_score_run": 1,
                "is_speedrun": 0,
                "is_deathless": 0,
                "is_seeded": 0,
                "is_co_op": 0,
                "is_custom": 0,
                "is_power_ranking": 1,
                "is_daily_ranking": 0,
                "mode": {
                    "name": "normal",
                    "display_name": "Normal"
                }
            },
            "pb": {
                "date": "2017-03-07",
                "rank": 549,
                "details": "0000000001000000",
                "zone": 0,
                "level": 1,
                "win": 0,
                "score": 0,
                "replay": {
                    "ugcid": "82590571760664522",
                    "version": null,
                    "seed": null,
                    "run_result": null,
                    "file_url": null
                }
            },
            "replay": {
                "ugcid": "82590571760664522",
                "version": null,
                "seed": null,
                "run_result": null,
                "file_url": null
            }
        }
    }



Ranking Endpoints

GET /rankings/power

  • Retrieves all dates that power rankings are generated on for the specified release and mode.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/rankings/power?release=amplified_dlc&mode=normal


    Example Response

    {
        "request": {
            "release": "amplified_dlc",
            "mode": "normal",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 50,
        "data": [
            "2017-03-13",
            "2017-03-14",
            "2017-01-25",
            "2017-01-26",
            ...
        ]
    }


GET /rankings/power/score


GET /rankings/power/speed


GET /rankings/power/deathless


GET /rankings/power/character


GET /rankings/power/entries

  • Retrieves all power ranking entries for a specified release, mode, and date.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.
    date Please see the date section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    site Please see the site section under common parameters.
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.
    search Please see the search section under common parameters.


    Example Request

    https://api.necrolab.com/rankings/power/entries?release=original&mode=normal&date=2017-03-10


    Example Response

    {
        "request": {
            "release": "original",
            "mode": "normal",
            "date": "2017-03-10",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null,
            "site": ""
        },
        "record_count": 232028,
        "data": [
            {
                "player": {
                    "steamid": "76561198000263514",
                    "personaname": "incnone",
                    "linked": {
                        "steam": {
                            "personaname": "incnone",
                            "profile_url": "http://steamcommunity.com/id/incnone/"
                        },
                        "twitch": null,
                        "discord": {
                            "username": null,
                            "discriminator": null
                        },
                        "reddit": null,
                        "youtube": null,
                        "twitter": {
                            "nickname": null,
                            "name": null
                        },
                        "beampro": null
                    }
                },
                "cadence": {
                    "score": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "score": 23814
                    },
                    "speed": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "time": "244.812"
                    },
                    "deathless": {
                        "rank": 9,
                        "rank_points": 34.54019295720166,
                        "win_count": null
                    },
                    "rank": 1,
                    "rank_points": 194.99854454202045
                },
                "bard": {
                    "score": {
                        "rank": 1,
                        "rank_points": 99.80427033011223,
                        "score": 25959
                    },
                    "speed": {
                        "rank": 3,
                        "rank_points": 67.17810208081157,
                        "time": null
                    },
                    "deathless": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "win_count": null
                    },
                    "rank": 1,
                    "rank_points": 247.2115482033332
                },
                "aria": {
                    "score": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "score": 14608
                    },
                    "speed": {
                        "rank": 1,
                        "rank_points": 99.80427033011223,
                        "time": "258.121"
                    },
                    "deathless": {
                        "rank": 5,
                        "rank_points": 50.8620283757091,
                        "win_count": null
                    },
                    "rank": 1,
                    "rank_points": 230.89547449823073
                },
                "bolt": {
                    "score": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "score": 16653
                    },
                    "speed": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "time": "152.557"
                    },
                    "deathless": {
                        "rank": 4,
                        "rank_points": 57.855052478691185,
                        "win_count": null
                    },
                    "rank": 1,
                    "rank_points": 218.31340406350998
                },
                "monk": {
                    "score": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "score": 12661
                    },
                    "speed": {
                        "rank": 1,
                        "rank_points": 99.80427033011223,
                        "time": "297.821"
                    },
                    "deathless": {
                        "rank": 48,
                        "rank_points": 9.498429969393491,
                        "win_count": null
                    },
                    "rank": 1,
                    "rank_points": 189.53187609191514
                },
                "dove": {
                    "score": {
                        "rank": 26,
                        "rank_points": 15.372135394874483,
                        "score": 2340
                    },
                    "speed": {
                        "rank": 1,
                        "rank_points": 99.80427033011223,
                        "time": "115.661"
                    },
                    "deathless": {
                        "rank": 9,
                        "rank_points": 34.54019295720166,
                        "win_count": null
                    },
                    "rank": 3,
                    "rank_points": 149.7165986821884
                },
                "eli": {
                    "score": {
                        "rank": 14,
                        "rank_points": 24.931854734470637,
                        "score": 11981
                    },
                    "speed": {
                        "rank": 3,
                        "rank_points": 67.17810208081157,
                        "time": "251.533"
                    },
                    "deathless": {
                        "rank": 32,
                        "rank_points": 13.043434710975438,
                        "win_count": null
                    },
                    "rank": 9,
                    "rank_points": 105.15339152625764
                },
                "melody": {
                    "score": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "score": 18609
                    },
                    "speed": {
                        "rank": 1,
                        "rank_points": 99.80427033011223,
                        "time": "232.152"
                    },
                    "deathless": {
                        "rank": 47,
                        "rank_points": 9.654085098354873,
                        "win_count": null
                    },
                    "rank": 2,
                    "rank_points": 189.6875312208765
                },
                "dorian": {
                    "score": {
                        "rank": 11,
                        "rank_points": 29.874430036695323,
                        "score": 10274
                    },
                    "speed": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "time": "177.01"
                    },
                    "deathless": {
                        "rank": 15,
                        "rank_points": 23.64986821751062,
                        "win_count": null
                    },
                    "rank": 4,
                    "rank_points": 133.75347404661534
                },
                "coda": {
                    "score": {
                        "rank": 7,
                        "rank_points": 41.07005847776454,
                        "score": 3208
                    },
                    "speed": {
                        "rank": 13,
                        "rank_points": 26.373767168183036,
                        "time": null
                    },
                    "deathless": {
                        "rank": 5,
                        "rank_points": 50.8620283757091,
                        "win_count": 1
                    },
                    "rank": 5,
                    "rank_points": 118.30585402165669
                },
                "nocturna": {
                    "score": {
                        "rank": null,
                        "rank_points": null,
                        "score": null
                    },
                    "speed": {
                        "rank": null,
                        "rank_points": null,
                        "time": null
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": null,
                    "rank_points": 0
                },
                "diamond": {
                    "score": {
                        "rank": null,
                        "rank_points": null,
                        "score": null
                    },
                    "speed": {
                        "rank": null,
                        "rank_points": null,
                        "time": null
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": null,
                    "rank_points": 0
                },
                "story": {
                    "score": {
                        "rank": 1,
                        "rank_points": 99.80427033011223,
                        "score": 46300
                    },
                    "speed": {
                        "rank": 1,
                        "rank_points": 99.80427033011223,
                        "time": "961.715"
                    },
                    "deathless": [],
                    "rank": 1,
                    "rank_points": 199.60854066022446
                },
                "all": {
                    "score": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "score": 88904
                    },
                    "speed": {
                        "rank": 2,
                        "rank_points": 80.2291757924094,
                        "time": "2959.463"
                    },
                    "deathless": [],
                    "rank": 1,
                    "rank_points": 160.4583515848188
                },
                "score": {
                    "total_score": 275311,
                    "rank": 1,
                    "rank_points": 792.2320740584858
                },
                "speed": {
                    "total_time": 5650.845,
                    "rank": 1,
                    "rank_points": 980.6680261500047
                },
                "deathless": {
                    "total_win_count": 1,
                    "rank": 4,
                    "rank_points": 364.7344889331565
                },
                "rank": 1,
                "total_points": 2137.634589141647
            },
            ...
        ]
    }


GET /rankings/power/score/entries


GET /rankings/power/speed/entries


GET /rankings/power/deathless/entries


GET /rankings/power/character/entries

  • An alias for /rankings/power/entries that only retrieves entries that have a ranking for the specified character.


    Required Parameters

    In addition to the required parameters in /rankings/power/entries, the following is also required:

    Parameter Description Valid Values
    character Please see the character section under common parameters.


GET /rankings/daily

  • Retrieves all dates that daily rankings are generated on for the specified release, mode, and number of days.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.
    number_of_days Please see the number_of_days section under common parameters.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/rankings/daily?release=original&mode=normal&number_of_days=0


    Example Response

    {
        "request": {
            "release": "original",
            "mode": "normal",
            "number_of_days": 0
        },
        "record_count": 677,
        "data": [
            "2015-10-04",
            "2015-10-05",
            "2015-10-06",
            "2015-05-04",
            "2015-05-05",
            ...
        ]
    }


GET /rankings/daily/number_of_days

  • Retrieves all day periods that are supported for daily rankings.


    Required Parameters

    None


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/rankings/daily/number_of_days


    Example Response

    {
        "request": {},
        "record_count": 3
        "data": [
            30,
            100,
            0
        ]
    }


GET /rankings/daily/entries

  • Retrieves all daily ranking entries for a specified release, mode, and date.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.
    date Please see the date section under common parameters.
    number_of_days Please see the number_of_days section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    site Please see the site section under common parameters.
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.
    search Please see the search section under common parameters.


    Example Request

    https://api.necrolab.com/rankings/daily/entries?release=original&mode=normal&date=2016-02-10&number_of_days=0


    Example Response

    {
        "request": {
            "release": "original",
            "mode": "normal",
            "date": "2016-02-10",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null,
            "site": "",
            "number_of_days": 0
        },
        "record_count": 120025
        "data": [
            {
                "player": {
                    "steamid": "76561198004612980",
                    "personaname": "wilarseny",
                    "linked": {
                        "steam": {
                            "personaname": "wilarseny",
                            "profile_url": "http://steamcommunity.com/id/wilarseny/"
                        },
                        "twitch": null,
                        "discord": {
                            "username": null,
                            "discriminator": null
                        },
                        "reddit": null,
                        "youtube": null,
                        "twitter": {
                            "nickname": null,
                            "name": null
                        },
                        "beampro": null
                    }
                },
                "first_place_ranks": 19,
                "top_5_ranks": 90,
                "top_10_ranks": 42,
                "top_20_ranks": 23,
                "top_50_ranks": 26,
                "top_100_ranks": 11,
                "total_points": "10467.8913974662",
                "points_per_day": "42.901194251911",
                "total_dailies": 244,
                "total_wins": 4,
                "average_rank": "94.040983606557",
                "sum_of_ranks": 22946,
                "rank": 1
            },
            ...
        ]
    }



Player Endpoints

GET /players

  • Retrieves all general info for all players.


    Required Parameters

    None


    Optional Parameters

    Parameter Description Valid Values
    site Please see the site section under common parameters.
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.
    search Please see the search section under common parameters.


    Example Request

    https://api.necrolab.com/players


    Example Response

    {
        "request": {
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null,
            "site": ""
        },
        "record_count": 374223
        "data": [
            {
                "steamid": "76561198029239987",
                "personaname": "``",
                "linked": {
                    "steam": {
                        "personaname": "``",
                        "profile_url": "http://steamcommunity.com/profiles/76561198029239987/"
                    },
                    "twitch": null,
                    "discord": {
                        "username": null,
                        "discriminator": null
                    },
                    "reddit": null,
                    "youtube": null,
                    "twitter": {
                        "nickname": null,
                        "name": null
                    },
                    "beampro": null
                }
            },
            ...
        ]
    }


GET /players/player

  • Retrieves all general information for a specified player.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/players/player?steamid=76561198004612980


    Example Response

    {
        "request": {
            "steamid": 76561198004612980,
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 1
        "data": {
            "steamid": "76561198004612980",
            "personaname": "wilarseny",
            "linked": {
                "steam": {
                    "personaname": "wilarseny",
                    "profile_url": "http://steamcommunity.com/id/wilarseny/"
                },
                "twitch": null,
                "discord": {
                    "username": null,
                    "discriminator": null
                },
                "reddit": null,
                "youtube": null,
                "twitter": {
                    "nickname": null,
                    "name": null
                },
                "beampro": null
            }
        }
    }



Achievements Endpoints

GET /achievements

  • Retrieves all achievements available.


    Required Parameters

    None

    Optional Parameters

    None

    Example Request

    https://api.necrolab.com/achievements

    Example Response

    {
        "request": [],
        "record_count": 30,
        "data": [
            {
                "name": "ACH_KILL_3_GREEN_BATS",
                "display_name": "Bat Trick",
                "description": "Kill three green bats",
                "icon_url": "http://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/247080/b272cda3cf5dc6d752e212a5519e3057bab13c09.jpg",
                "icon_gray_url": "http://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/247080/ef58d8c12cb3105bf3843f5697738361f11e554e.jpg"
            },
            ...
        ]
    }


GET /players/player/achievements

  • Retrieves all achievements for a specified player.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/players/player/achievements?steamid=76561198280004888


    Example Response

    {
        "request": {
            "steamid": "76561198280004888"
        },
        "record_count": 30,
        "data": [
            {
                "name": "ACH_KILL_3_GREEN_BATS",
                "display_name": "Bat Trick",
                "description": "Kill three green bats",
                "achieved": 1,
                "achieved_date": "2017-02-24 20:29:43",
                "icon_url": "http://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/247080/b272cda3cf5dc6d752e212a5519e3057bab13c09.jpg"
            },
            ...
        ]
    }



PB Endpoints

GET /players/pbs

  • Retrieves all PBs for all players.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.
    character Please see the character section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/players/pbs?release=original&mode=normal&character=cadence


    Example Response

    {
        "request": {
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null,
            "release": "original",
            "mode": "normal",
            "character": "cadence"
        },
        "record_count": 769194,
        "data": [
            {
                "player": {
                    "steamid": "76561198165350197",
                    "personaname": "Roland",
                    "linked": {
                        "steam": {
                            "personaname": "Roland",
                            "profile_url": "http://steamcommunity.com/profiles/76561198165350197/"
                        },
                        "twitch": null,
                        "discord": {
                            "username": null,
                            "discriminator": null
                        },
                        "reddit": null,
                        "youtube": null,
                        "twitter": {
                            "nickname": null,
                            "name": null
                        },
                        "beampro": null
                    }
                },
                "leaderboard": {
                    "lbid": 1143488,
                    "name": "1/2/2016_PROD",
                    "display_name": null,
                    "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/1143488/?xml=1",
                    "character": "cadence",
                    "character_number": 1,
                    "is_daily": 1,
                    "daily_date": "2016-02-01",
                    "is_score_run": 1,
                    "is_speedrun": 0,
                    "is_deathless": 0,
                    "is_seeded": 0,
                    "is_co_op": 0,
                    "is_custom": 0,
                    "is_power_ranking": 0,
                    "is_daily_ranking": 1
                },
                "pb": {
                    "date": "2016-02-01",
                    "rank": 3,
                    "details": "0400000006000000",
                    "zone": null,
                    "level": null,
                    "win": 0,
                    "score": 15142,
                    "replay": {
                        "ugcid": "357276631073900215",
                        "version": null,
                        "seed": null,
                        "run_result": null,
                        "file_url": null
                    }
                }
            },
            ...
        ]
    }


GET /players/pbs/score


GET /players/pbs/speed


GET /players/pbs/deathless

  • An alias for /players/pbs that only retrieves deathless PBs.


GET /players/player/pbs

  • Retrieves all PBs for a specified player.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.
    character Please see the character section under common parameters.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/players/player/pbs?steamid=76561197987716503&release=original&mode=normal&character=all


    Example Response

    {
        "request": {
            "steamid": 76561197987716500,
            "release": "original",
            "mode": "normal",
            "character": "all",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 53,
        "data": [
            {
                "leaderboard": {
                    "lbid": 741312,
                    "name": "hardcore all chars_prod",
                    "display_name": "all characters score",
                    "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/741312/?xml=1",
                    "character": "all",
                    "character_number": 14,
                    "is_daily": 0,
                    "daily_date": null,
                    "is_score_run": 1,
                    "is_speedrun": 0,
                    "is_deathless": 0,
                    "is_seeded": 0,
                    "is_co_op": 0,
                    "is_custom": 0,
                    "is_power_ranking": 1,
                    "is_daily_ranking": 0
                },
                "entry": {
                    "date": "2016-02-01",
                    "rank": 349,
                    "details": "0900000004000000",
                    "zone": null,
                    "level": null,
                    "win": 0,
                    "score": 4451,
                    "replay": {
                        "ugcid": "359526421598130565",
                        "version": null,
                        "seed": null,
                        "run_result": null,
                        "file_url": null
                    }
                },
            },
            ...
        ]
    }


GET /players/player/pbs/score


GET /players/player/pbs/speed


GET /players/player/pbs/deathless



Player Leaderboard Endpoints

GET /players/player/leaderboards

  • Retrieves all of a player's leaderboards for the specified release and mode.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    • name
    • display_name
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/players/player/leaderboards/score?steamid=76561197987716503&release=original&mode=normal


    Example Response

    {
        "request": {
            "steamid": 76561197987716503,
            "release": "original",
            "mode": "normal",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 23,
        "data": [
            {
                "lbid": 740390,
                "name": "HARDCORE Melody_PROD",
                "display_name": "Melody Score",
                "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/740390/?xml=1",
                "character": "melody",
                "character_number": 8,
                "is_daily": 0,
                "daily_date": null,
                "is_score_run": 1,
                "is_speedrun": 0,
                "is_deathless": 0,
                "is_seeded": 0,
                "is_co_op": 0,
                "is_custom": 0,
                "is_power_ranking": 1,
                "is_daily_ranking": 0,
                "mode": {
                    "name": "normal",
                    "display_name": "Normal"
                }
            },
            ...
        ]
    }


GET /players/player/leaderboards/score


GET /players/player/leaderboards/speed


GET /players/player/leaderboards/deathless


GET /players/player/leaderboards/daily


GET /players/player/leaderboards/snapshots

  • Retrieves all of the dates that a specified player and leaderboard has entries for.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.
    lbid Please see the lbid section under common parameters.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/players/player/leaderboards/snapshots?steamid=76561197987716503&lbid=1694062


    Example Response

    {
        "request": {
            "steamid": 76561197987716500,
            "lbid": 1694062,
        },
        "record_count": 52,
        "data": [
                "2017-01-25",
                "2017-01-26",
                "2017-01-27",
                "2017-01-28",
                ...
            }
        ]
    }


GET /players/player/leaderboards/entries

  • Retrieves a player's entries for a leaderboard on a specified date and criteria.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.
    date Please see the date section under common parameters.
    release Please see the release section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/players/player/leaderboards/entries?steamid=76561198171801786&date=2017-03-07&release=amplified_dlc


    Example Response

    {
        "request": {
            "steamid": 76561198171801800,
            "date": "2017-03-07",
            "release": "amplified_dlc",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 20,
        "data": [
            {
                "leaderboard": {
                    "lbid": 1694068,
                    "name": "DLC HARDCORE Aria_PROD",
                    "display_name": "Aria Score (Amplified)",
                    "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/1694068/?xml=1",
                    "character": "aria",
                    "character_number": 3,
                    "is_daily": 0,
                    "daily_date": null,
                    "is_score_run": 1,
                    "is_speedrun": 0,
                    "is_deathless": 0,
                    "is_seeded": 0,
                    "is_co_op": 0,
                    "is_custom": 0,
                    "is_power_ranking": 1,
                    "is_daily_ranking": 0,
                    "mode": {
                        "name": "normal",
                        "display_name": "Normal"
                    }
                },
                "entry": {
                    "rank": 152,
                    "details": "0100000006000000",
                    "zone": 1,
                    "level": 6,
                    "win": 0,
                    "score": 3314,
                    "replay": {
                        "ugcid": 91597306689706578,
                        "version": null,
                        "seed": 2939030907,
                        "run_result": null,
                        "file_url": "https://necrolab.s3.amazonaws.com/replays/91597306689706578.zip"
                    }
                }
            },
            ...
        ]
    }


GET /players/player/leaderboards/score/entries


GET /players/player/leaderboards/speed/entries


GET /players/player/leaderboards/deathless/entries


GET /players/player/leaderboards/daily/entries

  • Retrieves a player's entries for a daily leaderboard on a specified release, date range, and other criteria.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.
    release Please see the release section under common parameters.
    start_date Please see the start_date section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    end_date Please see the end_date section under common parameters.
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/players/player/leaderboards/daily/entries?steamid=76561198051520646&release=original&start_date=2016-02-01


    Example Response

    {
        "request": {
            "steamid": "76561198051520646",
            "start_date": "2016-02-01",
            "end_date": "2017-03-18",
            "release": "original",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 2,
        "data": [
            {
                "leaderboard": {
                    "lbid": 1114962,
                    "name": "2/2/2016_PROD",
                    "display_name": null,
                    "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/1114962/?xml=1",
                    "character": "cadence",
                    "character_number": 1,
                    "is_daily": 1,
                    "daily_date": "2016-02-02",
                    "is_score_run": 1,
                    "is_speedrun": 0,
                    "is_deathless": 0,
                    "is_seeded": 0,
                    "is_co_op": 0,
                    "is_custom": 0,
                    "is_power_ranking": 0,
                    "is_daily_ranking": 1,
                    "mode": {
                        "name": "normal",
                        "display_name": "Normal"
                    }
                },
                "entry": {
                    "rank": 7,
                    "details": "0400000002000000",
                    "zone": null,
                    "level": null,
                    "win": 0,
                    "score": 9460,
                    "replay": {
                        "ugcid": null,
                        "version": null,
                        "seed": null,
                        "run_result": null,
                        "file_url": null
                    }
                }
            },
            ...
        ]
    }


GET /players/player/leaderboards/replays

  • Retrieves all of a player's leaderboard entry replays for the specified release.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    steamid Please see the steamid section under common parameters.


    Optional Parameters

    None


    Example Request

    https://api.necrolab.com/players/player/leaderboards/replays?release=amplified_dlc&steamid=76561197979118640


    Example Response

    {
        "request": {
            "release": "amplified_dlc",
            "steamid": 76561197979118640,
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 55306,
        "data": [
            {
                "leaderboard": {
                    "lbid": 1700534,
                    "name": "DLC HARDCORE All Chars_PROD",
                    "display_name": "All Characters Score (Amplified)",
                    "entries_url": "http://steamcommunity.com/stats/247080/leaderboards/1700534/?xml=1",
                    "character": "all",
                    "character_number": 14,
                    "is_daily": 0,
                    "daily_date": null,
                    "is_score_run": 1,
                    "is_speedrun": 0,
                    "is_deathless": 0,
                    "is_seeded": 0,
                    "is_co_op": 0,
                    "is_custom": 0,
                    "is_power_ranking": 1,
                    "is_daily_ranking": 0,
                    "mode": {
                        "name": "normal",
                        "display_name": "Normal"
                    }
                },
                "pb": {
                    "date": "2017-03-20",
                    "rank": 649,
                    "details": "0000000001000000",
                    "zone": 0,
                    "level": 1,
                    "win": 0,
                    "score": 0,
                    "replay": {
                        "ugcid": "80342832064696717",
                        "version": null,
                        "seed": null,
                        "run_result": null,
                        "file_url": null
                    }
                },
                "replay": {
                    "ugcid": "80342832064696717",
                    "version": null,
                    "seed": null,
                    "run_result": null,
                    "file_url": null
                }
            },
            ...
        ]
    }



Player Ranking Endpoints

GET /players/player/rankings/power

  • Retrieves all of the dates that a player has power rankings for in a specified release and mode.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.


    Example Request

    https://api.necrolab.com/api/players/player/rankings/power/score?steamid=76561197987716503&release=amplified_dlc&mode=normal


    Example Response

    {
        "request": {
            "steamid": 76561197987716500,
            "release": "amplified_dlc",
            "mode": "normal",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 35,
        "data": [
            "2017-01-25",
            "2017-01-26",
            "2017-01-27",
            "2017-01-28",
            ...
        ]
    }


GET /players/player/rankings/power/score


GET /players/player/rankings/power/speed


GET /players/player/rankings/power/deathless


GET /players/player/rankings/power/character

  • An alias for /players/player/rankings/power that only retrieves dates that the player has a ranking in the specified character.


    Required Parameters

    In addition to the required parameters in /players/player/rankings/power, the following is also required:

    Parameter Description Valid Values
    character Please see the character section under common parameters.


GET /players/player/rankings/power/entries

  • Retrieves all of a player's power ranking entries for a specified release and date.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.
    release Please see the release section under common parameters.
    start_date Please see the start_date section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    end_date Please see the end_date section under common parameters.
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/api/players/player/rankings/power/entries?steamid=76561197987716503&release=amplified_dlc&start_date=2017-03-01


    Example Response

    {
        "request": {
            "steamid": "76561197987716503",
            "release": "amplified_dlc",
            "start_date": "2017-03-01",
            "end_date": "2017-03-18",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 18,
        "data": [
            {
                "date": "2017-03-10",
                "steamid": 76561197987716500,
                "mode": {
                    "name": "normal",
                    "display_name": "Normal"
                },
                "cadence": {
                    "score": {
                        "rank": 1253,
                        "rank_points": 1.5014223465856145,
                        "score": 4726
                    },
                    "speed": {
                        "rank": 25,
                        "rank_points": 15.85673427185604,
                        "time": "414.681"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 80,
                    "rank_points": 17.358156618441654
                },
                "bard": {
                    "score": {
                        "rank": 868,
                        "rank_points": 1.7220085959614224,
                        "score": 3445
                    },
                    "speed": {
                        "rank": 14,
                        "rank_points": 24.931854734470637,
                        "time": "234.696"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 49,
                    "rank_points": 26.65386333043206
                },
                "aria": {
                    "score": {
                        "rank": 225,
                        "rank_points": 3.2953793271793153,
                        "score": 2407
                    },
                    "speed": {
                        "rank": 47,
                        "rank_points": 9.654085098354873,
                        "time": "787.118"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 141,
                    "rank_points": 12.949464425534188
                },
                "bolt": {
                    "score": {
                        "rank": 253,
                        "rank_points": 3.0827817685178776,
                        "score": 1651
                    },
                    "speed": {
                        "rank": 20,
                        "rank_points": 18.908824790745232,
                        "time": "312.067"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 63,
                    "rank_points": 21.99160655926311
                },
                "monk": {
                    "score": {
                        "rank": null,
                        "rank_points": null,
                        "score": null
                    },
                    "speed": {
                        "rank": null,
                        "rank_points": null,
                        "time": null
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": null,
                    "rank_points": 0
                },
                "dove": {
                    "score": {
                        "rank": 860,
                        "rank_points": 1.728298666122134,
                        "score": 108
                    },
                    "speed": {
                        "rank": 19,
                        "rank_points": 19.685077966428707,
                        "time": "226.02"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 56,
                    "rank_points": 21.413376632550843
                },
                "eli": {
                    "score": {
                        "rank": 308,
                        "rank_points": 2.7694431031178897,
                        "score": 1756
                    },
                    "speed": {
                        "rank": 18,
                        "rank_points": 20.535029238882288,
                        "time": "599.181"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 48,
                    "rank_points": 23.304472342000178
                },
                "melody": {
                    "score": {
                        "rank": 1031,
                        "rank_points": 1.611965632944191,
                        "score": 2379
                    },
                    "speed": {
                        "rank": 14,
                        "rank_points": 24.931854734470637,
                        "time": "399.742"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 46,
                    "rank_points": 26.543820367414828
                },
                "dorian": {
                    "score": {
                        "rank": 182,
                        "rank_points": 3.7375381134749834,
                        "score": 1787
                    },
                    "speed": {
                        "rank": 18,
                        "rank_points": 20.535029238882288,
                        "time": "302.668"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 50,
                    "rank_points": 24.27256735235727
                },
                "coda": {
                    "score": {
                        "rank": null,
                        "rank_points": null,
                        "score": null
                    },
                    "speed": {
                        "rank": null,
                        "rank_points": null,
                        "time": null
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": null,
                    "rank_points": 0
                },
                "nocturna": {
                    "score": {
                        "rank": 2160,
                        "rank_points": 1.254904689831439,
                        "score": 3780
                    },
                    "speed": {
                        "rank": 32,
                        "rank_points": 13.043434710975438,
                        "time": "407.38"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 100,
                    "rank_points": 14.298339400806878
                },
                "diamond": {
                    "score": {
                        "rank": 358,
                        "rank_points": 2.561394650763757,
                        "score": 1656
                    },
                    "speed": {
                        "rank": 35,
                        "rank_points": 12.15335361230221,
                        "time": "484.532"
                    },
                    "deathless": {
                        "rank": null,
                        "rank_points": null,
                        "win_count": null
                    },
                    "rank": 84,
                    "rank_points": 14.714748263065967
                },
                "story": {
                    "score": {
                        "rank": null,
                        "rank_points": null,
                        "score": null
                    },
                    "speed": {
                        "rank": null,
                        "rank_points": null,
                        "time": null
                    },
                    "deathless": [],
                    "rank": null,
                    "rank_points": 0
                },
                "all": {
                    "score": {
                        "rank": null,
                        "rank_points": null,
                        "score": null
                    },
                    "speed": {
                        "rank": null,
                        "rank_points": null,
                        "time": null
                    },
                    "deathless": [],
                    "rank": null,
                    "rank_points": 0
                },
                "score": {
                    "total_score": 23695,
                    "rank": 526,
                    "rank_points": 23.26513689449862
                },
                "speed": {
                    "total_time": 4168.085,
                    "rank": 20,
                    "rank_points": 180.23527839736835
                },
                "deathless": {
                    "total_win_count": null,
                    "rank": null,
                    "rank_points": null
                },
                "rank": 66,
                "total_points": 203.50041529186694
            },
            ...
        ]
    }


GET /players/player/rankings/power/score/entries


GET /players/player/rankings/power/speed/entries


GET /players/player/rankings/power/deathless/entries


GET /players/player/rankings/power/character/entries


GET /players/player/rankings/daily

  • Retrieves all of the dates that a player has daily rankings in a given release, mode, and timeframe.


    Required Parameters

    Parameter Description Valid Values
    steamid Please see the steamid section under common parameters.
    release Please see the release section under common parameters.
    mode Please see the mode section under common parameters.
    number_of_days Please see the number_of_days section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.


    Example Request

    https://api.necrolab.com/players/player/rankings/daily?steamid=76561198051520646&release=original&mode=normal&number_of_days=0


    Example Response

    {
        "request": {
            "steamid": 76561198051520640,
            "release": "original",
            "mode": "normal",
            "number_of_days": 0,
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null
        },
        "record_count": 639,
        "data": [
            "2015-04-26",
            "2015-04-27",
            "2015-04-28",
            "2015-04-29",
            "2015-04-30",
            ...
        ]
    }


GET /players/player/rankings/daily/entries

  • Retrieves all of a player's daily ranking entries for a specified release, mode, and timeframe.


    Required Parameters

    Parameter Description Valid Values
    release Please see the release section under common parameters.
    date Please see the date section under common parameters.
    number_of_days Please see the number_of_days section under common parameters.


    Optional Parameters

    Parameter Description Valid Values
    start Please see the start section under common parameters.
    limit Please see the limit section under common parameters.
    sort_by Please see the sort_by section under common parameters.
    sort_direction Please see the sort_direction section under common parameters.


    Example Request

    https://api.necrolab.com/players/player/rankings/daily/entries?steamid=76561198051520646&release=original&number_of_days=0&start_date=2016-02-01


    Example Response

    {
        "request": {
            "steamid": 76561198051520640,
            "release": "original",
            "start": 0,
            "limit": 100,
            "sort_by": null,
            "sort_direction": null,
            "number_of_days": 0,
            "start_date": "2016-02-01",
            "end_date": "2017-03-18"
        },
        "record_count": 358,
        "data": [
            {
                "date": "2016-02-01",
                "steamid": 76561198051520640,
                "mode": {
                    "name": "normal",
                    "display_name": "Normal"
                },
                "first_place_ranks": 19,
                "top_5_ranks": 76,
                "top_10_ranks": 27,
                "top_20_ranks": 18,
                "top_50_ranks": 16,
                "top_100_ranks": 14,
                "total_points": "8912.35030015233",
                "points_per_day": "40.327376923766",
                "total_dailies": 221,
                "total_wins": 4,
                "average_rank": "106.51131221719",
                "sum_of_ranks": 23539,
                "rank": 2
            },
            ...
        ]
    },