ExileData documentation

ExileData serves Path of Exile 1 and 2 game data over HTTP. Each game patch becomes its own dataset of normalized records, so your tool reads JSON instead of parsing game files. Query the data through the API with a key, or download whole patches without one.

ExileData is in preview. The API can change between releases, and every change is listed in the changelog.

Quick start#

1. Get an API key#

Every request under /v1 needs a key. Keys are issued by hand during the preview, so ask @juddisjudd for one.

Keep the key out of client-side code and public repositories. The examples in these docs read it from an environment variable:

$ export EXILEDATA_KEY="exd_..."

2. Make a request#

Ask for the first amulet base in the latest Path of Exile 2 patch:

$ curl -H "x-api-key: $EXILEDATA_KEY" \
    "https://api.exiledata.dev/v1/poe2/bases?itemClass=Amulet&limit=1"

{
  "data": [
    {
      "id": "Metadata/Items/Amulets/FourAmulet1",
      "name": "Crimson Amulet",
      "itemClass": "Amulet",
      "version": { "schemaVersion": "0.2.0", "game": "poe2", "gameVersion": "0.5.5.4" },
      "source": [ … ],
      "ext": { "drop_level": 1, "implicit_text": ["(2-4) Life Regeneration per second"], … }
    }
  ],
  "meta": { "game": "poe2", "gameVersion": "0.5.5.4", "total": 25 }
}

3. Pin the patch#

meta.gameVersion names the patch that answered. Without ?version=, you always get the newest patch, so the data can change under you when a new patch ships. To keep it fixed, send the patch you tested against:

$ curl -H "x-api-key: $EXILEDATA_KEY" \
    "https://api.exiledata.dev/v1/poe2/bases?version=0.5.5.4&itemClass=Amulet"

Datasets and versions explains how patches are published and replaced.

What is available#

{game} is poe1 or poe2. GET /v1/versions lists every published patch.

Where to go next#

• Authentication: sending the key, rate limits, error codes.
• Record format: what each field means and which fields are stable.
• API reference: every endpoint and parameter.
• Downloads: every file of a patch as JSON, without a key.

There is no published SDK yet. The OpenAPI document works with client generators and with tools such as Postman or Insomnia.