Bob's Burgers API Documentation

Introduction

What is this?

The Bob's Burgers API is a REST API based on the television show Bob's Burgers. The Bob's Burgers API contains data for hundreds of characters, episodes, running gags, and images from the show.

If you are using this API please consider supporting the project by buying me a coffee ☕ to help maintain the API and keep it free for everyone.

Statistics

GraphQL

The GraphQL endpoint provides a GraphQL wrapper around the Bob's Burgers REST API.

https://bobsburgers-api.herokuapp.com/graphql/

Root URL

The Root endpoint provides information on all available resources within the API. All requests are GET requests and are sent over HTTPS.

https://bobsburgers-api.herokuapp.com

Sorting and Limiting

All endpoints support the sortBy, orderBy, limit, and skip parameters.

By default each endpoint returns the results sorted in ascending order by ID.

Examples

Sort characters in ascending order by name

https://bobsburgers-api.herokuapp.com/characters?sortBy=name&OrderBy=asc&limit=1&skip=0

Sort characters in descending order by name

https://bobsburgers-api.herokuapp.com/characters?sortBy=name&OrderBy=desc&limit=1&skip=0

Sort characters in descending order by name and get fifth result

https://bobsburgers-api.herokuapp.com/characters?sortBy=name&OrderBy=desc&limit=1&skip=5

Get all pest control trucks in the 7th season.

https://bobsburgers-api.herokuapp.com/pestControlTruck?season=7&limit=2

Burger Of The Day

Get all burgers

https://bobsburgers-api.herokuapp.com/burgerOfTheDay

Get a single burger of the day

https://bobsburgers-api.herokuapp.com/burgerOfTheDay/1

Get multiple burgers

Multiple burgers can be found by adding an array of ids to the /burgerOfTheDay/ endpoint URL. (E.g. [1,2,3] or 1,2,3 )

https://bobsburgers-api.herokuapp.com/burgerOfTheDay/[1,2,3]

Burger Of The Day Schema

Key	Type	Description
id	number	The unique id for the burger of the day
name	string	The name of the burger of the day
price	string	The price for the burger of the day
season	number	The season that the burger of the day appeared in
episode	number	The episode that the burger of the day appeared in
episodeUrl	string	The url for the episode that the burger of the day appeared in
url	string	The unique link for the burger of the day

Filter and Sort burgers

Burgers can be filtered or sorted by any valid property in it's schema. A list of all valid keys can be found above.

https://bobsburgers-api.herokuapp.com/burgerOfTheDay/?season=5&episode=1

Character

Get all characters

https://bobsburgers-api.herokuapp.com/characters

Get a single character

https://bobsburgers-api.herokuapp.com/characters/1

Get multiple characters

Multiple characters can be found by adding an array of ids to the /characters/ endpoint URL. (E.g. [1,2,3] or 1,2,3 )

https://bobsburgers-api.herokuapp.com/characters/[1,2,3]

Character Schema

Key	Type	Description
id	number	The unique id for the character
name	string	The character's name
image	string	The url for the character's image
hair nullable	string	The character's hair color
age nullable	string	The character's age
gender nullable	string	The character's gender
allOccupations	string[]	All of the character's known occupations
occupation nullable	string	The character's occupation
nicknames	string[]	All of the character's nicknames
relatives	object[] (see Relative below)	The character's relatives
firstEpisode nullable	string	The first episode the character appeared in
voicedBy nullable	string	The voice actor(s) for the character
wikiUrl	string	The unique for link the character's wiki page
url	string	The unique for link the character

Filter and Sort characters

Characters can be filtered or sorted by any valid property in it's schema. A list of all valid keys can be found above.

https://bobsburgers-api.herokuapp.com/characters/?sortBy=voicedBy&limit=2

Relative Schema

Key	Type	Description
name	string	The relative's name
relationship nullable	string	The relative's relationship to the character.
wikiUrl nullable	string	The unique for link the relative's wiki page
url nullable	string	The unique for link the relative

End Credits Sequence

Please note, images 1,2 and 4-13 are the same. This is because the same end credits sequence was used in the first season aside from the third episode Sacred Cow.

Get all end credits sequences

https://bobsburgers-api.herokuapp.com/endCreditsSequence

Get a single end credits sequence

https://bobsburgers-api.herokuapp.com/endCreditsSequence/1

Get multiple end credits sequences

Multiple end credits sequences can be found by adding an array of ids to the /endCreditsSequence/ endpoint URL. (E.g. [1,2,3] or 1,2,3 )

https://bobsburgers-api.herokuapp.com/endCreditsSequence/[1,2,3]

End Credits Sequence Schema

Key	Type	Description
id	number	The unique id for the end credits sequence.
image	string	The url for the end credits sequence's image
season	number	The season that the end credits sequence appeared in
episode	number	The episode that the end credits sequence appeared in
episodeUrl	string	The url for the episode that the end credits sequence appeared in
url	string	The unique link for the end credits sequence

Filter and Sort end credits sequences

End credits sequences can be filtered or sorted by any valid property in it's schema. A list of all valid keys can be found above.

https://bobsburgers-api.herokuapp.com/endCreditsSequence/?season=9&limit=2

Episode

Get all episodes

https://bobsburgers-api.herokuapp.com/episodes

Get a single episode

https://bobsburgers-api.herokuapp.com/episodes/1

Get multiple episodes

Multiple episodes can be found by adding an array of ids to the /episodes/ endpoint URL. (E.g. [1,2,3] or 1,2,3 )

https://bobsburgers-api.herokuapp.com/episodes/[1,2,3]

Episode Schema

Key	Type	Description
id	number	The unique id for the episode
name	string	The episode's name
description	string	The episode's description
productionCode	string	The episode's production code
airDate	string	The episode's air date
season	number	The season the episode appeared in
episode	number	The episode number in the season
totalViewers	string	The episode's total viewers
url	string	The unique link for the episode
wikiUrl	string	The unique for link the episodes's wiki page

Filter and Sort episodes

Episodes can be filtered or sorted by any valid property in it's schema. A list of all valid keys can be found above.

https://bobsburgers-api.herokuapp.com/episodes/?season=3&limit=2

Pest Control Truck

Please note, the first 13 pest control trucks all have the same name and image. This is because the same pest control truck was used in every episode in the first season.

Get all pest control trucks

https://bobsburgers-api.herokuapp.com/pestControlTruck

Get a single pest control truck

https://bobsburgers-api.herokuapp.com/pestControlTruck/1

Get multiple pest control trucks

Multiple pest control trucks can be found by adding an array of ids to the /pestControlTruck/ endpoint URL. (E.g. [1,2,3] or 1,2,3 )

https://bobsburgers-api.herokuapp.com/pestControlTruck/[1,2,3]

Pest Control Truck Schema

Key	Type	Description
id	number	The unique id for the pest control truck
name	string	The pest control truck's name
image	string	The url for the pest control truck's image
season	number	The season that the pest control truck appeared in
episode	number	The episode that the pest control truck appeared in
episodeUrl	string	The url for the episode that the pest control truck appeared in.
url	string	The unique link for the pest control truck

Filter and Sort pest control trucks

Pest control trucks can be filtered or sorted by any valid property in it's schema. A list of all valid keys can be found above.

https://bobsburgers-api.herokuapp.com/pestControlTruck/?season=9&sortBy=name&limit=2

Store Next Door

Get all stores

https://bobsburgers-api.herokuapp.com/storeNextDoor

Get a single store next door

https://bobsburgers-api.herokuapp.com/storeNextDoor/1

Get multiple stores

Multiple stores can be found by adding an array of ids to the /storeNextDoor/ endpoint URL. (E.g. [1,2,3] or 1,2,3 )

https://bobsburgers-api.herokuapp.com/storeNextDoor/[1,2,3]

Store Next Door Schema

Key	Type	Description
id	number	The unique id for the store
name	string	The store's name
image	url	The url for the store's image
season	number	The season that the store appeared in
episode	number	The episode that the store appeared in
episodeUrl	url	The url for the episode that the store appeared in
url	url	The unique link for the store

Filter and Sort stores

Stores can be filtered or sorted by any valid property in it's schema. A list of all valid keys can be found above.

https://bobsburgers-api.herokuapp.com/storeNextDoor/?season=6&sortBy=name&limit=2