Skip to main content
GET
List characters you can cast

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Query Parameters

source
enum<string>
default:all
Available options:
all,
official,
mine,
collected
q
string

Words that must all appear in the character's name, look or profile (e.g. fitness).

limit
integer
default:100
Required range: 1 <= x <= 200

Response

The characters you can cast.

characters
object[]
count
integer
how_to_use
string