Skip to content

SoulsAPI

I just like Souls games :)

What is SoulsAPI?

SoulsAPI is a read-only REST API (starting with Bloodborne) designed for developers, wikis, and tools.

  • OpenAPI: GET /openapi.json plus GET /docs (Swagger UI) on the API host.
  • Shared types: @souls-api/types.
  • Community data: JSON under data/ merged via pull requests.

API access

Game data routes require an API key. Test keys are issued on request — contact the maintainer on Discord: omaretot (user id 592473249628291082). Include your email and intended use.

Send the key on every GET /v1/{gameId}/... request via X-API-Key or Authorization: Bearer. See API overview and Getting started for curl examples and rate limits.