Introduction
This is the documentation for Version 1 (V1) of the Harry Potter API, originally released December 2017.
Response Formats
The default response format is JSON
application/json.
Authentication
The API requires an access key for most routes. You can obtain an access key by signing up for an account here.
All Routes
All routes need to be prefixed with
https://www.potterapi.com/v1/
Sorting Hat Route
GET /sortingHat
Returns a random Hogwarts House.
This is the only route that does not require a key.
Character Routes
GET /characters
Returns all characters.
URL Query Parameters
| Param | Value | Description |
|---|---|---|
key
|
your api key | required |
name
|
string | |
house
|
string | Valid strings: 'Gryffindor', 'Ravenclaw', 'Slytherin', 'Hufflepuff' |
patronus
|
string | |
species
|
string | not required |
bloodStatus
|
string | Valid strings: 'pure-blood', 'half-blood', 'muggle-born', 'unknown' |
role
|
string | |
school
|
string | |
deathEater
|
boolean | |
dumbledoresArmy
|
boolean | |
orderOfThePhoenix
|
boolean | |
ministryOfMagic
|
boolean | |
alias
|
string | |
wand
|
string | |
boggart
|
string | |
animagus
|
string |
GET /characters/{characterId}
Returns character with matching character id.
URL Query Parameters
| Param | Value | Description |
|---|---|---|
key
|
your api key | Required |
House Routes
GET /houses
Returns all Hogwarts Houses.
URL Query Parameters
| Param | Value | Description |
|---|---|---|
key
|
your api key | Required |
GET /houses/{houseId}
Returns house with matching House id. Includes list of characters affiliated with House.
URL Query Parameters
| Param | Value | Description |
|---|---|---|
key
|
your api key | Required |
Spell Routes
GET /spells
Returns all spells.
URL Query Parameters
| Param | Value | Description |
|---|---|---|
key
|
your api key | Required |