Skip to content
This repository has been archived by the owner on Mar 11, 2024. It is now read-only.

gideonbot/gideon-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gideon-api

Node API Wrapper for Gideon API™

Simple API wrapper for the Gideon API™ powering the Arrowverse Discord Bot

  • Easy to use
  • Full API coverage
  • Also wraps the arrowverse.info API

Installing

npm install gideon-api

Usage

//CJS:
const gideonapi = require('gideon-api');
//ES6:
import gideonapi from 'gideon-api';

//fetch a random Arrowverse quote:
const quote = await gideonapi.quote();
console.log(quote);

/* Example response
  {
    "quote": "You saved the world, and then I saved you, with your pod. You're not the only bad-ass in the family.",
    "quotee": "Alexandra Danvers (Arrowverse: Earth-38)",
    "image": "https://static.wikia.nocookie.net/marvel_dc/images/5/5f/Alexandra_Danvers_Arrow_Earth-38_002.jpg/revision/latest/scale-to-width-down/350?cb=20190804030154"
  },
*/

//fetch metahuman abilities:
const abilities = await gideonapi.abilities();
//optional parameters: speedsters / vibers / kryptonians
console.log(abilities);

/* Example response
vibers: {
    title1: "Meta-human physiology",
    ability1: "Vibers possess altered DNA and physiology to access dimensional energy.",
    title2: "Dimensional energy manipulation",
    ability2: "Vibers have a psychic link to the natural energies of reality, allowing them to connect with various vibrations of the multiverse and manipulate them for various effects.",
    title3: "Dimensional awareness",
    ability3: "Known as \"vibing\", vibers can perceive various events throughout time and space, letting them see into the past and future as well as parallel dimensions, even into the very Speed Force itself.",
    title4: "Interdimensional travel",
    ability4: "With their natural connection to the multiverse, vibers can open portals to other dimensions. Being a noticeably more advanced ability, they are shown to need focus and a proper awareness of their intended target.",
    title5: "Vibrational blasts",
    ability5: "Vibers are able to generate powerful blue or red concussive blasts of vibrations from their hands capable of propelling full-grown humans through the air.",
    title6: "Mental connection",
    ability6: "Vibers are connected by their powers and are able to observe each other if they\'re skilled enough."
}
*/

//fetch soundtrack album urls:
const soundtracks = await gideonapi.soundtracks();
//optional parameters: flash / arrow / legends / supergirl / crossovers
console.log(soundtracks);

/* Example response
flash: {
    season1: "https://open.spotify.com/album/0xiJwfDcZRQ77bsbjS9TF5",
    season2: "https://open.spotify.com/album/2EE7W74Rk1LDHzbYC9js2Z",
    season3: "https://open.spotify.com/album/0DCUAyJVmG1fNxkBaZqFLt",
    season4: "https://open.spotify.com/album/12WS02J0JBAVeEGj6aJ7R8",
}
*/

//fetch list of speedsters:
const speedsters = await gideonapi.speedsters();
console.log(speedsters);

/* Example response
{
    speedster: "XS (Nora West-Allen)",
    lightningColorsElectrokinesis: "Purple & Yellow (Speed Force) / Purple & Red (Negative Speed Force)",
    universe: "Earth-1",
    actoractress: "Jessica Parker Kennedy",
    firstAppearanceAsSpeedster: "The Flash 4x20 \"Therefore She Is\""
}
*/

//fetch a timeline change:
const timeline = await gideonapi.timeline();
console.log(timeline);

/* Example response
"Your interference with the timeline has caused World Peace, good job!"
*/

//fetch from arrowverse.info:
const episodes = await gideonapi.avi();
console.log(episodes);

/* Example response
{
    "air_date": "February 12, 2019",
    "episode_id": "S05E14",
    "episode_name": "Cause and XS",
    "row_number": 455,
    "series": "The Flash"
}
*/

License

MIT

About

Node API Wrapper for Gideon API™

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published