API Resources

Resource URL

http://api.pathofexile.com/leagues

List leagues

GET /leagues

Get a list of current and past leagues.

Parameters

typeOptional

Possible values:
-"all": retrieves all leagues (the default)
-"main": retrieves main leagues (ones from the character screen)
-"event": retrieves event leagues
-"season": retrieves leagues in a particular season

seasonOptional

A particular season id. Required when type=season.

compactOptional

Possible values:
-"0": Displays the full info for leagues retrieved (will only retrieve a maximum of 50 leagues) (the default)
-"1": Display compact info for leagues retrieved (will retrieve up to 230 leagues)

limitOptional

This specifies the number of league entries to include. By default this is the maximum, which depends on the setting above.

offsetOptional

This specifies the offset to the first league entry to include. Default: 0.

Example

http://api.pathofexile.com/leagues?type=season&season=GarenaSG11Medallion&compact=1

Response

[
    {
        "id": "SG_30 Min Endless Ledge (MDC001)",
        "url": null,
        "startAt": "2016-08-04T02:00:00Z",
        "endAt": "2016-08-04T02:30:00Z"
    },
    {
        "id": "SG_Cutthroat (MDC002)",
        "url": null,
        "startAt": "2016-08-04T07:00:00Z",
        "endAt": "2016-08-04T11:00:00Z"
    },
    {
        "id": "SG_stress of Flame Kill (MDC003)",
        "url": null,
        "startAt": "2016-08-04T12:00:00Z",
        "endAt": "2016-08-04T13:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS004)",
        "url": null,
        "startAt": "2016-08-04T14:00:00Z",
        "endAt": "2016-08-04T15:00:00Z"
    },
    {
        "id": "SG_Act 2 Solo (MDV005)",
        "url": null,
        "startAt": "2016-08-05T02:00:00Z",
        "endAt": "2016-08-05T02:45:00Z"
    },
    {
        "id": "SG_Act 2 Dominus Kill (MDC006)",
        "url": null,
        "startAt": "2016-08-05T07:00:00Z",
        "endAt": "2016-08-05T09:00:00Z"
    },
    {
        "id": "SG_DC Gravicius Kill (MDC007)",
        "url": null,
        "startAt": "2016-08-05T10:00:00Z",
        "endAt": "2016-08-05T11:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS008)",
        "url": null,
        "startAt": "2016-08-05T12:00:00Z",
        "endAt": "2016-08-05T13:00:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC009A)",
        "url": null,
        "startAt": "2016-08-05T14:00:00Z",
        "endAt": "2016-08-05T14:12:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC009B)",
        "url": null,
        "startAt": "2016-08-05T14:20:00Z",
        "endAt": "2016-08-05T14:32:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC009C)",
        "url": null,
        "startAt": "2016-08-05T14:40:00Z",
        "endAt": "2016-08-05T14:52:00Z"
    },
    {
        "id": "SG_Exiles Everywhere (MDC010)",
        "url": null,
        "startAt": "2016-08-06T02:00:00Z",
        "endAt": "2016-08-06T03:00:00Z"
    },
    {
        "id": "SG_OHAA Malachai Kill (MDC011)",
        "url": null,
        "startAt": "2016-08-06T04:00:00Z",
        "endAt": "2016-08-06T09:00:00Z"
    },
    {
        "id": "SG_1h BLAMT Party (MDC012)",
        "url": null,
        "startAt": "2016-08-06T10:00:00Z",
        "endAt": "2016-08-06T11:00:00Z"
    },
    {
        "id": "SG_stress of Flame Kill (MDC013)",
        "url": null,
        "startAt": "2016-08-06T12:00:00Z",
        "endAt": "2016-08-06T13:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS014)",
        "url": null,
        "startAt": "2016-08-06T14:00:00Z",
        "endAt": "2016-08-06T15:00:00Z"
    },
    {
        "id": "SG_One Hour Solo (MDV015)",
        "url": null,
        "startAt": "2016-08-07T02:00:00Z",
        "endAt": "2016-08-07T03:00:00Z"
    },
    {
        "id": "SG_A2TMP Piety Kill (MDC016)",
        "url": null,
        "startAt": "2016-08-07T07:00:00Z",
        "endAt": "2016-08-07T09:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS017)",
        "url": null,
        "startAt": "2016-08-07T10:00:00Z",
        "endAt": "2016-08-07T11:00:00Z"
    },
    {
        "id": "SG_Merveil Kill (MDV018)",
        "url": null,
        "startAt": "2016-08-07T12:00:00Z",
        "endAt": "2016-08-07T13:00:00Z"
    },
    {
        "id": "SG_DC Gravicius Kill (MDC019)",
        "url": null,
        "startAt": "2016-08-07T14:00:00Z",
        "endAt": "2016-08-07T15:00:00Z"
    },
    {
        "id": "SG_stress of Flame Kill (MDC020)",
        "url": null,
        "startAt": "2016-08-08T02:00:00Z",
        "endAt": "2016-08-08T03:00:00Z"
    },
    {
        "id": "SG_Two Hour Solo (MDV021)",
        "url": null,
        "startAt": "2016-08-08T07:00:00Z",
        "endAt": "2016-08-08T09:00:00Z"
    },
    {
        "id": "SG_Brutus Kill (MDV022)",
        "url": null,
        "startAt": "2016-08-08T10:00:00Z",
        "endAt": "2016-08-08T11:00:00Z"
    },
    {
        "id": "SG_1 Hour Endless Ledge (MDC023)",
        "url": null,
        "startAt": "2016-08-08T12:00:00Z",
        "endAt": "2016-08-08T13:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS024)",
        "url": null,
        "startAt": "2016-08-08T14:00:00Z",
        "endAt": "2016-08-08T15:00:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC025A)",
        "url": null,
        "startAt": "2016-08-09T02:00:00Z",
        "endAt": "2016-08-09T02:12:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC025B)",
        "url": null,
        "startAt": "2016-08-09T02:20:00Z",
        "endAt": "2016-08-09T02:32:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC025C)",
        "url": null,
        "startAt": "2016-08-09T02:40:00Z",
        "endAt": "2016-08-09T02:52:00Z"
    },
    {
        "id": "SG_DC Gravicius Kill (MDC026)",
        "url": null,
        "startAt": "2016-08-09T07:00:00Z",
        "endAt": "2016-08-09T08:00:00Z"
    },
    {
        "id": "SG_Headhunter (MDC027)",
        "url": null,
        "startAt": "2016-08-09T10:00:00Z",
        "endAt": "2016-08-09T11:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS028)",
        "url": null,
        "startAt": "2016-08-09T12:00:00Z",
        "endAt": "2016-08-09T13:00:00Z"
    },
    {
        "id": "SG_Act 3 Solo (MDV029)",
        "url": null,
        "startAt": "2016-08-09T14:00:00Z",
        "endAt": "2016-08-09T14:50:00Z"
    },
    {
        "id": "SG_One Hour Party (MDV030)",
        "url": null,
        "startAt": "2016-08-10T02:00:00Z",
        "endAt": "2016-08-10T03:00:00Z"
    },
    {
        "id": "SG_Onslaught Cutthroat (MDC031)",
        "url": null,
        "startAt": "2016-08-10T07:00:00Z",
        "endAt": "2016-08-10T09:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS032)",
        "url": null,
        "startAt": "2016-08-10T10:00:00Z",
        "endAt": "2016-08-10T11:00:00Z"
    },
    {
        "id": "SG_laught Mistress Kill (MDC033)",
        "url": null,
        "startAt": "2016-08-10T12:00:00Z",
        "endAt": "2016-08-10T13:00:00Z"
    },
    {
        "id": "SG_Eternal Torment (MDC034)",
        "url": null,
        "startAt": "2016-08-10T14:00:00Z",
        "endAt": "2016-08-10T15:00:00Z"
    },
    {
        "id": "SG_Arctic Merveil Kill (MDC035)",
        "url": null,
        "startAt": "2016-08-11T02:00:00Z",
        "endAt": "2016-08-11T03:00:00Z"
    },
    {
        "id": "SG_Cutthroat (MDC036)",
        "url": null,
        "startAt": "2016-08-11T05:00:00Z",
        "endAt": "2016-08-11T09:00:00Z"
    },
    {
        "id": "SG_Headhunter (MDC037)",
        "url": null,
        "startAt": "2016-08-11T10:00:00Z",
        "endAt": "2016-08-11T11:00:00Z"
    },
    {
        "id": "SG_DCO Gravicius Kill (MDC038)",
        "url": null,
        "startAt": "2016-08-11T12:00:00Z",
        "endAt": "2016-08-11T13:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS039)",
        "url": null,
        "startAt": "2016-08-11T14:00:00Z",
        "endAt": "2016-08-11T15:00:00Z"
    },
    {
        "id": "SG_BLMST Izaro Kill (MDC040)",
        "url": null,
        "startAt": "2016-08-12T00:00:00Z",
        "endAt": "2016-08-13T00:00:00Z"
    },
    {
        "id": "SG_Exile Onslaught (MDC041)",
        "url": null,
        "startAt": "2016-08-13T07:00:00Z",
        "endAt": "2016-08-13T09:00:00Z"
    },
    {
        "id": "SG_0m Winterheart Ledge (MDC042)",
        "url": null,
        "startAt": "2016-08-13T10:00:00Z",
        "endAt": "2016-08-13T10:30:00Z"
    },
    {
        "id": "SG_Medallion (MDS043)",
        "url": null,
        "startAt": "2016-08-13T12:00:00Z",
        "endAt": "2016-08-13T13:00:00Z"
    },
    {
        "id": "SG_stress of Flame Kill (MDC044)",
        "url": null,
        "startAt": "2016-08-13T14:00:00Z",
        "endAt": "2016-08-13T15:00:00Z"
    },
    {
        "id": "SG_DC Gravicius Kill (MDC045)",
        "url": null,
        "startAt": "2016-08-14T02:00:00Z",
        "endAt": "2016-08-14T03:00:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC046A)",
        "url": null,
        "startAt": "2016-08-14T05:00:00Z",
        "endAt": "2016-08-14T05:12:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC046B)",
        "url": null,
        "startAt": "2016-08-14T05:20:00Z",
        "endAt": "2016-08-14T05:32:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC046C)",
        "url": null,
        "startAt": "2016-08-14T05:40:00Z",
        "endAt": "2016-08-14T05:52:00Z"
    },
    {
        "id": "SG_ Lethal Dominus Kill (MDC047)",
        "url": null,
        "startAt": "2016-08-14T07:00:00Z",
        "endAt": "2016-08-14T09:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS048)",
        "url": null,
        "startAt": "2016-08-14T10:00:00Z",
        "endAt": "2016-08-14T11:00:00Z"
    },
    {
        "id": "SG_One Hour Party (MDV049)",
        "url": null,
        "startAt": "2016-08-14T12:00:00Z",
        "endAt": "2016-08-14T13:00:00Z"
    },
    {
        "id": "SG_Act 2 Solo (MDV050)",
        "url": null,
        "startAt": "2016-08-14T14:00:00Z",
        "endAt": "2016-08-14T14:45:00Z"
    },
    {
        "id": "SG_One Hour Solo (MDV051)",
        "url": null,
        "startAt": "2016-08-15T02:00:00Z",
        "endAt": "2016-08-15T03:00:00Z"
    },
    {
        "id": "SG_stress of Flame Kill (MDC052)",
        "url": null,
        "startAt": "2016-08-15T07:00:00Z",
        "endAt": "2016-08-15T08:00:00Z"
    },
    {
        "id": "SG_Brutus Kill (MDV053)",
        "url": null,
        "startAt": "2016-08-15T10:00:00Z",
        "endAt": "2016-08-15T11:00:00Z"
    },
    {
        "id": "SG_Exiles Everywhere (MDC054)",
        "url": null,
        "startAt": "2016-08-15T12:00:00Z",
        "endAt": "2016-08-15T13:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS055)",
        "url": null,
        "startAt": "2016-08-15T14:00:00Z",
        "endAt": "2016-08-15T15:00:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC056A)",
        "url": null,
        "startAt": "2016-08-16T02:00:00Z",
        "endAt": "2016-08-16T02:12:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC056B)",
        "url": null,
        "startAt": "2016-08-16T02:20:00Z",
        "endAt": "2016-08-16T02:32:00Z"
    },
    {
        "id": "SG_12 Min Burst (MDC056C)",
        "url": null,
        "startAt": "2016-08-16T02:40:00Z",
        "endAt": "2016-08-16T02:52:00Z"
    },
    {
        "id": "SG_2h BLAMT Party (MDC057)",
        "url": null,
        "startAt": "2016-08-16T07:00:00Z",
        "endAt": "2016-08-16T09:00:00Z"
    },
    {
        "id": "SG_DC Gravicius Kill (MDC058)",
        "url": null,
        "startAt": "2016-08-16T10:00:00Z",
        "endAt": "2016-08-16T11:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS059)",
        "url": null,
        "startAt": "2016-08-16T12:00:00Z",
        "endAt": "2016-08-16T13:00:00Z"
    },
    {
        "id": "SG_Act 3 Solo (MDV060)",
        "url": null,
        "startAt": "2016-08-16T14:00:00Z",
        "endAt": "2016-08-16T14:50:00Z"
    },
    {
        "id": "SG_1h Winterheart Ledge (MDC061)",
        "url": null,
        "startAt": "2016-08-17T02:00:00Z",
        "endAt": "2016-08-17T03:00:00Z"
    },
    {
        "id": "SG_A2TMP Piety Kill (MDC062)",
        "url": null,
        "startAt": "2016-08-17T07:00:00Z",
        "endAt": "2016-08-17T09:00:00Z"
    },
    {
        "id": "SG_Medallion (MDS063)",
        "url": null,
        "startAt": "2016-08-17T10:00:00Z",
        "endAt": "2016-08-17T11:00:00Z"
    },
    {
        "id": "SG_stress of Flame Kill (MDC064)",
        "url": null,
        "startAt": "2016-08-17T12:00:00Z",
        "endAt": "2016-08-17T13:00:00Z"
    },
    {
        "id": "SG_rnal Torment Nemesis (MDC065)",
        "url": null,
        "startAt": "2016-08-17T14:00:00Z",
        "endAt": "2016-08-17T15:00:00Z"
    }
]

Get a league

GET /leagues/:id

Get a single league by id.

Parameters

idRequired

The id (name) of the league.

ladderOptional

Set to 1 to include the ladder in the response. The ladder will be in included in the "ladder" key. Defaults to 0, excluding the ladder. Please note that the ladder can be retrieved using the ladder resource, and that retrieving it using the league API is just an optimization that can be used if you are requesting the league anyway.

ladderLimitOptional

When including the ladder with ladder=1, this specifies the number of ladder entries to include. Default: 20, Max: 200.

ladderOffsetOptional

When including the ladder with ladder=1, this specifies the offset to the first ladder entry to include. Default: 0.

ladderTrackOptional

When including the ladder with ladder=1, this setting adds unique IDs for each character returned. These can be used when name conflicts occur.

Example

http://api.pathofexile.com/leagues/Hardcore?ladder=1&ladderOffset=1&ladderLimit=2

Response

{
    "id": "Standard",
    "description": "The default game mode.",
    "registerAt": null,
    "event": false,
    "url": "http:\/\/pathofexile.com\/forum\/view-thread\/71278",
    "startAt": "2013-01-23T21:00:00Z",
    "endAt": null,
    "rules": [
        
    ],
    "ladder": {
        "total": 15000,
        "entries": [
            {
                "rank": 2,
                "dead": false,
                "online": false,
                "character": {
                    "name": "TaylorSwiftVEVO",
                    "level": 100,
                    "class": "Scion",
                    "experience": 4250334444
                },
                "account": {
                    "name": "PeakingDuck",
                    "challenges": {
                        "total": 12
                    },
                    "twitch": {
                        "name": "peakingduck"
                    }
                }
            },
            {
                "rank": 3,
                "dead": false,
                "online": false,
                "character": {
                    "name": "Fuck_One_Point_Two",
                    "level": 100,
                    "class": "Berserker",
                    "experience": 4250334444
                },
                "account": {
                    "name": "Hizbas",
                    "challenges": {
                        "total": 5
                    },
                    "twitch": {
                        "name": "hizbas"
                    }
                }
            }
        ]
    }
}

Example

http://api.pathofexile.com/leagues/Standard?ladder=1&ladderLimit=5&ladderTrack=true

Response

{
    "id": "Standard",
    "description": "The default game mode.",
    "registerAt": null,
    "event": false,
    "url": "http:\/\/pathofexile.com\/forum\/view-thread\/71278",
    "startAt": "2013-01-23T21:00:00Z",
    "endAt": null,
    "rules": [
        
    ],
    "ladder": {
        "total": 15000,
        "entries": [
            {
                "rank": 2,
                "dead": false,
                "online": false,
                "character": {
                    "name": "TaylorSwiftVEVO",
                    "level": 100,
                    "class": "Scion",
                    "id": "b23f488245ffebc87616c9acf76fbbb3d534e0490a8b30a9be48f8fcc3941be0",
                    "experience": 4250334444
                },
                "account": {
                    "name": "PeakingDuck",
                    "challenges": {
                        "total": 12
                    },
                    "twitch": {
                        "name": "peakingduck"
                    }
                }
            },
            {
                "rank": 3,
                "dead": false,
                "online": false,
                "character": {
                    "name": "Fuck_One_Point_Two",
                    "level": 100,
                    "class": "Berserker",
                    "id": "46427575f1d5a3bcf44b533c790fb46a6f3d4ad1751cbd6046a105f85a38733a",
                    "experience": 4250334444
                },
                "account": {
                    "name": "Hizbas",
                    "challenges": {
                        "total": 5
                    },
                    "twitch": {
                        "name": "hizbas"
                    }
                }
            }
        ]
    }
}