API Intro

The Phasmophobia API allows for 4 endpoints currently.

Instructions to add to firebot

Instructions to add to Discord

Ability endpoint

Intro

The ability api allows for the user to get back the ability for a chosen ghost.

Example request

Endpoint

"/ability"

Request type

"GET"

Parameters (in red required)

ghost

Example:

/ability?ghost=banshee

Response types

200: Successful

Returns String:

The {ghost}'s special ability is {ability}

200: Failed

Return String: Please use as follows: !ability "< ghost name >"

Top of Page

Cursed Item endpoint

Intro

Returns the location of given Cursed Item on given Map

Example request

Endpoint

"/curseditems

Request type

"GET"

Parameters (in red required)

map

object

Example:

/curseditems?object=monkey+paw&map=grafton

Response types

200: Successful

Return String:

The {object} is located in {location} on {map}

200: Failed

Return String:

This command requires specific usage. Please use like: !location "map name" "cursed item" including quotes. Map and Item names should be in lowercase'

Top of Page

Evidence endpoint

Intro

Returns the evidences and hunt thresholds for a given ghost

Example request

Endpoint

"/evidence"

Request type

"GET"

Parameters (in red required)

ghost

Example:

/evidence?ghost=banshee

Response types

200: Successful

Return String:

The {ghost} has the following evidence: {evidence}. The {ghost}'s hunt threshold is {hunt threshold}

200: Failed

Return String:

Please use as follows: !ev "ghost name"

Top of Page

Trivia endpoint

Intro

Returns random trivia about ghosts

Example request

Endpoint

"/trivia"

Request type

"GET"

Parameters (in red required)

Takes no parameters

Response types

200: Successful

Return String:

Your random ghost is {rand_ghost}. Did you know this about the {rand_ghost}? {fact}

200: Failed

You should not receive a fail response ever.

Top of Page

Firebot Instructions Under Construction

Add Random Ability command to Firebot

In progress

Add Cursed Item command to Firebot

In progress

Add Evidence command to Firebot

In progress

Add Random Fact/Trivia command to Firebot

Top of Page

Discord Instructions Under Construction

Top of Page