Skip to content

API.md

Latest commit

 

History

History
131 lines (91 loc) · 2.9 KB

API.md

File metadata and controls

131 lines (91 loc) · 2.9 KB
Raw

API

Base URL: http://<your-ip>:8082

Modes

Full (default): everything - GPSS server, web viewer, database, all endpoints below.

Legality-only: just POST /api/legality, POST /api/legalize, and GET /api/status. No database, no UI.

LEGALITY_ONLY=1 docker compose up -d

POST /api/legality

Check raw Pokemon bytes against PKHeX. Works in both modes.

Header Required Description
X-Generation Yes 1-9, BDSP, or PLA

Body: raw .pkm bytes (max 1 MB).

curl -X POST http://192.168.1.3:8082/api/legality \
  -H "X-Generation: 9" \
  --data-binary @my_pokemon.pkm
{"legal": true, "report": []}
{"legal": false, "report": ["Invalid: Move 1 PP is above the amount allowed (99)."]}

POST /api/legalize

Auto-legalize a Pokemon using PKHeX. Tries to fix legality issues and returns the corrected bytes. Works in both modes.

Header Required Description
X-Generation Yes 1-9, BDSP, or PLA
X-Version No Game version (Scarlet, Diamond, Sun, etc). Defaults to Any

Body: raw .pkm bytes (max 1 MB).

curl -X POST http://192.168.1.3:8082/api/legalize \
  -H "X-Generation: 7" \
  -H "X-Version: Sun" \
  --data-binary @my_pokemon.pkm

Successfully fixed:

{
  "legal": true,
  "modified": true,
  "pokemon": "<base64 corrected bytes>",
  "report_before": ["Invalid: Nickname does not match species name."],
  "report_after": []
}

Already legal (nothing to do):

{"legal": true, "modified": false, "pokemon": null, "report_before": [], "report_after": []}

Can't fix:

{
  "legal": false,
  "modified": true,
  "pokemon": null,
  "report_before": ["Invalid: Move 1 PP is above the amount allowed (99)."],
  "report_after": ["Invalid: Move 1 PP is above the amount allowed (99)."]
}

GET /api/pokemon

Search the database. Full mode only.

Param Description
q Name, nickname, OT, code, or ID
gen 1-9, 3.1 (Colosseum), 3.2 (XD)
legal 1 or 0
shiny 1 or 0
species Species ID
sort recent, dl, level, az, id
page Page number
limit Results per page (max 100)

GET /api/pokemon/{id}

Full detail for one Pokemon (stats, moves, types, Showdown paste, sprites).

GET /api/pokemon/{id}/legality

Live PKHeX legality check on a Pokemon in the database. Returns legal, report, and whether the check was live or from the DB cache.

GET /api/pokemon/{id}/download

Download raw .pkm file.

GET /api/stats

Total count, legal count, per-generation breakdown, service status.

GET /api/status

Engine version, database size, service health.

GET /api/updates

Checks GitHub for newer PKHeX versions.

/api/v2/*

Proxied to the Go GPSS server. This is what PKSM talks to.