HTTP API for Pet Simulator 99 game data, public player profiles, and authenticated player account access.
https://ps99.biggamesapi.io/
The v1 namespace (/v1/*) is the new surface covering authenticated player data, public player
profiles, clan aggregations, and league leaderboards. See v1/overview.md for the full reference.
The legacy namespace (/api/*) is the original API — fully supported, not deprecated, and still
the right choice for pet data, item data, RAP, clan listings, and exists lookups. See
legacy/README.md for the full reference.
| I want to... | Use | Auth? |
|---|---|---|
| Get game data (pets, items, RAP, clans, exists, collections) | /api/* | None |
| Look up a player's public profile | /v1/players/ | None |
| Browse clan and league leaderboards | /v1/clans/, /v1/leagues/ | None |
| Read a player's personal data (with their permission) | /v1/account/ | OAuth (see authentication) |
Want to make your first call right now? Walk through the Quickstart — about five minutes.
- Quickstart — from zero to a working call in 5 minutes.
- v1 overview — response envelope, errors, rate limits, caching.
- Authentication (OAuth 2.0 + PKCE) — how to issue and use bearer tokens.
- Freshness & refresh quota — how account data is cached and the daily fresh-pull budget.
- v1 /players — public profile lookup, search, featured, list, total.
- v1 /account — 7 authenticated endpoints (inventory, profile, extendedProfile, itemIndex, trades, booth, mail).
- v1 /clans — players aggregator, single-player lookup, battle detail.
- v1 /leagues — leagues leaderboard, league detail, top contributors.
- Legacy /api endpoints — the original API.
- Changelog — release notes.
- Terms
Every response from both /v1/* and /api/* uses the same envelope: a status field of "ok"
or "error", paired with either a data field or an error object.
{ "status": "ok", "data": { ... } }{ "status": "error", "error": { "message": "Rate limit exceeded.", "ignore": true } }Field-by-field details live in v1/overview.md.
v1 is shape-stable within the version: fields will not be renamed or removed without a major
version bump. Additive changes — new fields or new view keys in player profiles — are not
considered breaking and may appear at any time. Removals or renames bump to v2. The legacy
/api/* surface remains supported indefinitely. See
v1/overview.md for detail.
Open an issue at https://github.com/BIG-Games-LLC/ps99-public-api-docs/issues.