hey-arnold-documentation

Hey Arnold API!

Character Routes

Get All Characters

https://hey-arnold-api.herokuapp.com/api/v1/characters

This route will return a paginated list. By default, a list (or page), will return 20 characters. To change this number, simply add a perPage query parameter, e.g. ?perPage=3. You can move to the next page of results by adding the page query parameter, e.g. ?page=2.

https://hey-arnold-api.herokuapp.com/api/v1/characters?perPage=3&page=2

[
  {
    "_id": "5da237699734fdcb7bef8f56",
    "name": "Miles Shortman",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/2/2e/Miles.jpg/revision/latest/scale-to-width-down/243?cb=20101115140639"
  },
  {
    "_id": "5da237699734fdcb7bef8f54",
    "name": "Mitzi",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/d/d9/Mitzi.png/revision/latest/scale-to-width-down/310?cb=20171212070331"
  },
  {
    "_id": "5da237699734fdcb7bef8f55",
    "name": "Arnie",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/4/42/Arnie.jpg/revision/latest/scale-to-width-down/310?cb=20110109195825"
  }
]

Query by Character Name

This route does allow you to query characters by name, with the ability to return all partial matches regardless of casing, e.g. ?name=hel.

https://hey-arnold-api.herokuapp.com/api/v1/characters?name=hel

[
  {
    "_id": "5da237699734fdcb7bef8f63",
    "name": "Helga G. Pataki",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/e/e5/Helga_Pataki.png/revision/latest/scale-to-width-down/266?cb=20190816021807"
  },
  {
    "_id": "5da237699734fdcb7bef8f8b",
    "name": "Shelley",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/c/cb/Shelley.jpg/revision/latest/scale-to-width-down/310?cb=20120527025256"
  },
  {
    "_id": "5da237699734fdcb7bef902e",
    "name": "Helga's Parrot (bird)",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/f/f1/Helga%27s_parrot%2C_bird.jpg/revision/latest/scale-to-width-down/310?cb=20100307071524"
  },
  {
    "_id": "5da237699734fdcb7bef8fb8",
    "name": "Shelley",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/c/cb/Shelley.jpg/revision/latest/scale-to-width-down/310?cb=20120527025256"
  }
]

Get Random Character

This route returns one random character by default. To change this number, simply add a count query parameter, e.g. ?count=2.

https://hey-arnold-api.herokuapp.com/api/v1/characters/random?count=2

[
  {
    "_id": "5da237699734fdcb7bef9036",
    "name": "Sidney",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/d/d4/Sidney.jpg/revision/latest/scale-to-width-down/310?cb=20120807185330"
  },
  {
    "_id": "5da237699734fdcb7bef8f9e",
    "name": "Edmund",
    "image": "https://vignette.wikia.nocookie.net/heyarnold/images/0/0a/Edmund.png/revision/latest?cb=20171219083557"
  }
]

Get Character by Id

https://hey-arnold-api.herokuapp.com/api/v1/characters/5da237699734fdcb7bef8f51

{
  "_id": "5da237699734fdcb7bef8f51",
  "name": "Arnold Shortman",
  "image": "https://vignette.wikia.nocookie.net/heyarnold/images/f/f5/Arnold.png/revision/latest?cb=20181027162333"
}

Gif Routes

Get All GIFs

https://hey-arnold-api.herokuapp.com/api/v1/gifs

This route will return a list of 49 Hey Arnold GIFs.

Get Random GIF

This route returns one random GIF by default. To change this number, simply add a count query parameter, e.g. ?count=2.

https://hey-arnold-api.herokuapp.com/api/v1/gifs/random?count=2

[
  {
    "_id": "5da23754845fd2cb76d59f10",
    "gifLink": "https://media.tenor.com/images/7511947a6ae9acb62c9515bfba14b1ec/tenor.gif"
  },
  {
    "_id": "5da23754845fd2cb76d59f05",
    "gifLink": "https://media.tenor.com/images/369dabafda46a71e9fdea7ff6d89fc6d/tenor.gif"
  }
]

Get GIF by Id

https://hey-arnold-api.herokuapp.com/api/v1/gifs/5da23754845fd2cb76d59ee7

{
  "_id": "5da23754845fd2cb76d59ee7",
  "gifLink": "https://media.tenor.com/images/4393cee845d8464670817e40b0601e3b/tenor.gif"
}