Getting started

API key

Data endpoints require authentication. Request a test API key by contacting the maintainer on Discord: omaretot (user id 592473249628291082).

curl -s -H "X-API-Key: YOUR_API_KEY" \
  "https://www.souls-api.com/v1/bloodborne/bosses?page_size=1"

Authorization: Bearer YOUR_API_KEY works too. Replace YOUR_API_KEY with the key you receive. Details: API overview.

Base URL

• Production: https://www.souls-api.com — static docs and API (/v1/..., /docs, /openapi.json) on the same host.

Every data-route example includes -H "X-API-Key: YOUR_API_KEY".

Versioning

• Global: /v1/health
• Per game: /v1/{gameId}/... (phase 1 uses bloodborne, e.g. /v1/bloodborne/weapons). Future titles reuse the same resource names under their own segment.

Explore

Open GET /docs on the API host for Swagger UI, or fetch GET /openapi.json.