Documentation

Introduction

This documentation will show you to how to get the resources of the Gravity Falls API and how to query them in different ways.

REST

Base url : https://gravity-falls-api.vercel.app/api/

The base url contains about all available API endpoints. All requests are the GET requests and responses will return data in json format.

GET

https://gravity-falls-api.vercel.app/api/

{"characters":"https://gravity-falls-api.vercel.app/api/characters"}

Characters

There is a total of 143 characters listed by id.

Characters schema

Key	Type	Description
id	Int	The id of the character.
name	String	The name of the character.
image	String(url)	The image url of character.
quote	String	Common quote of character
episode	String	Indicates that in which episode that character appeared.

Get All Characters

You can access the list of characters by using /characters endpoint.

GET

https://gravity-falls-api.vercel.app/api/characters

[
    {
      "id":1,
      "name":"8 Ball",
      "image":"https://static.wikia.nocookie.net/gravityfalls/images/a/a2/Opening_8_ball.jpg/",
      "quote":"So, you wanna eat him, or, something?",
      "episode":"The Last Mabelcorn"
    },
    ...
 ]

Get A Single Character

You can get a single character by adding the id as a parameter: /character/3 endpoint.

GET

https://gravity-falls-api.vercel.app/api/characters/3

{
    "id":3,
    "name":"Agent Powers",
    "image":"https://static.wikia.nocookie.net/gravityfalls/images/c/c5/S2e1_agent_powers.png/",
    "quote":"Then we'll make them believe us. This is the town we've been searching for.",
    "episode":"Scary-oke"
},

Filter Chracters

You can get a characters by filtering their name as a parameter: /characters?name=mabel endpoint. This will return a piece of characters that names are including mabel.

GET

https://gravity-falls-api.vercel.app/api/characters?name=mabel

[
    {
      "id":7,
      "name":"Anti-Mabel",
      "image":"https://static.wikia.nocookie.net/gravityfalls/images/c/c6/AntiMabel5.jpeg",
      "quote":"The exact kind of Mabel you aren’t. And considering how easy it was for me to guess this, you’ll probably never figure it out.",
      "episode":"Gravity Falls: Lost Legends"
    },
    {
      "id":85,
      "name":"Mabel Pines",
      "image":"https://static.wikia.nocookie.net/gravityfalls/images/b/b2/S1e3_mabel_new_wax_figure.png/",
      "quote":"When life gives you lemons, draw faces on those lemons and wrap them in a blanket. 
      Ta-daaa! Now you have lemon babies.",
      "episode":"Tourist Trapped"
    }
]

Furthermore you can filter a characters by just using their epsiode names : /characters?episode=touristendpoint.

Filter Characters By Using Multiple Queries

You can get a characters by filtering their name and episode as a parameter: /characters?name=dipper&episode=tourist endpoint. This will return a piece of characters that names are including mabel.

GET

https://gravity-falls-api.vercel.app/api/characters?name=dipper&episode=tourist

[
    {
      "id":38,
      "name":"Dipper Pines",
      "image":"https://static.wikia.nocookie.net/gravityfalls/images/c/cb/S1e16_dipper_will_take_room.png/",
      "quote":"When life gives you lemons, extract the juice and use it to draw a treasure map in invisible ink. That really works! Seriously!",
      "episode":"Tourist Trapped"
    }
]

Paginate Chracters

You can get a characters by limiting incoming character by using take as a parameter: /characters?take=5 endpoint. This will return a 5 related characters insted of taking all characters.

GET

https://gravity-falls-api.vercel.app/api/characters?take=5

[
    {
       "id":1,
       "name":"8 Ball",
       "image":"https://static.wikia.nocookie.net/gravityfalls/images/a/a2/Opening_8_ball.jpg",
       "quote":"So, you wanna eat him, or, something?",
       "episode":"The Last Mabelcorn"
    },
    {
       "id":2,
       "name":"Abuelita",
       "image":"https://static.wikia.nocookie.net/gravityfalls/images/c/c5/S1e20_Soos_grandma.png/",
       "quote":"Soos' life is my soap opera.",
       "episode":"Gideon Rises"
    }
    3 More...
]

Furthermore you can skip to intented characters list by using the character id. /characters?skip=70endpoint.

Paginate Characters By Using Multiple Queries

You can also paginate characters by using take and skip as a parameter: /characters?take=8&skip=70endpoint. This will return a piece of characters that start listing from 70. id and limited by 8 characters.

GET

https://gravity-falls-api.vercel.app/api/characters?take=8&skip=70

[
    {
       "id":71,
       "name":"Hectorgon",
       "image":"https://static.wikia.nocookie.net/gravityfalls/images/0/0b/Opening_hectorgon.png/",
       "quote":"Spin the person! Spin the person! Spin the person!",
       "episode":"Weirdmageddon Part 1"
    },
    {
       "id":72,
       "name":"Hot Elf",
       "image":"//static.wikia.nocookie.net/gravityfalls/images/f/f5/S2e13_hot_elf_2.jpg",
       "quote":"The game is like, over. Excelsi-whatever.",
       "episode":"Dungeons, Dungeons, and More Dungeons"
    },
    6 More...
]