API Resources

Resource URL

http://api.pathofexile.com/leagues

List leagues

GET /leagues

Get a list of current leagues.

Parameters

typeOptional

Possible values, "all" to retrieve all leagues (the default), or "event" to retrieve event leagues.

Example

http://api.pathofexile.com/leagues?type=event

Response

[
    {
        "id": "One Week Rampage\/Beyond",
        "description": "Please check the Event Forums for more details and prizes awarded.",
        "url": "http:\/\/www.pathofexile.com\/forum\/view-thread\/1111853",
        "event": true,
        "registerAt": "2014-11-29T00:30:00Z",
        "startAt": "2014-11-29T01:00:00Z",
        "endAt": "2014-12-06T01:00:00Z",
        "rules": [
            
        ],
        "ladder": [
            
        ]
    },
    {
        "id": "One Week HC Rampage\/Beyond",
        "description": "Please check the Event Forums for more details and prizes awarded.",
        "url": "http:\/\/www.pathofexile.com\/forum\/view-thread\/1111852",
        "event": true,
        "registerAt": "2014-11-29T00:30:00Z",
        "startAt": "2014-11-29T01:00:00Z",
        "endAt": "2014-12-06T01:00:00Z",
        "rules": [
            {
                "id": 4,
                "name": "Hardcore",
                "description": "A character killed in Hardcore is moved to its parent league."
            }
        ],
        "ladder": [
            
        ]
    }
]

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.

Example

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

Response

{
    "id": "Hardcore",
    "description": "A character killed in the Hardcore league is moved to the Standard league.",
    "url": "http:\/\/www.pathofexile.com\/forum\/view-thread\/71276",
    "event": false,
    "registerAt": null,
    "startAt": "2013-01-23T21:00:00Z",
    "endAt": null,
    "rules": [
        {
            "id": 4,
            "name": "Hardcore",
            "description": "A character killed in Hardcore is moved to its parent league."
        }
    ],
    "ladder": {
        "total": 15000,
        "entries": [
            {
                "online": false,
                "rank": 2,
                "dead": false,
                "character": {
                    "name": "exInfinite",
                    "level": 100,
                    "class": "Scion",
                    "experience": 4250334444
                },
                "account": {
                    "name": "xInfinite",
                    "challenges": {
                        "total": 0
                    },
                    "twitch": {
                        "name": "exinfinite"
                    }
                }
            },
            {
                "online": false,
                "rank": 3,
                "dead": false,
                "character": {
                    "name": "SirBaker",
                    "level": 100,
                    "class": "Shadow",
                    "experience": 4250334444
                },
                "account": {
                    "name": "Baker",
                    "challenges": {
                        "total": 0
                    },
                    "twitch": {
                        "name": "bakerlive"
                    }
                }
            }
        ]
    }
}