Logo

Shadowrun Quotesite API v0.2.0 Documentation

This API uses semantic versioning. Currently the API is v.0.2.0. While I try not to introduce breaking changes, breaking API changes may occur at any time until the API is complete.

This website has been equipped with a very basic API. For the uninitiated, an API is an easy way for a programmer to get information from a website.

All API endpoints begin with https://shadowrun.needs.management/api/

Quote API

The Quote API currently supports the following:

  • Getting the latest quote
  • Getting a random quote
  • Getting a specific quote

JSON Values

api_url (string): The url that can be used to access this quote via the API

author (string): Author is the name given by the quote author. Given that users on the site can change their name at will, trying to cue on the author name may not be the best idea.

created (datetime): Time is the creation date and time of the quote.

downvotes (integer): The number of downvotes the quote has received

id (integer): Id is the quote's ID number. This number is guaranteed to be unique. This can be passed in to the API to get this quote specifically.

quote (string): Quote is the actual quote created by the quote author.

title (string): Title is the quote title given by the quote author.

url (string): The url to view this quote directly.

upvotes (integer): The number of upvotes the quote has received

url (string): The url that can be used to access this quote via a web browser

API Endpoints

Method: GET

/api/quote/

/api/quote/random/

Returns a random quote.

Method: GET

/api/quote/latest/

Returns the most recently submitted quote.

Method: GET

/api/quote/quote_id

Returns the quote specified by quote_id where quote_id is an integer

Method: GET

/api/quote/page/page_num

Returns a page of quotes from the database where page_num is an integer. Each page contains 20 quotes.

Character API

The Character API currently supports the following:

  • Getting a random character
  • Getting a specific character by name
  • Getting a specific character by id
  • Getting a list of characters by player name

JSON Values

There are two parts to the Characters API.

  • Retrieving Characters
  • Retriving all characters for a specific player

Character Keys

description (string): The text description of the character.

id (integer): Id is the character's ID number. This number is guaranteed to be unique. This can be passed in to the API to get this character specifically.

name (string): The name of the character. Can be used to search for this character.

player (string): player is the actual player who created this character.

Player Keys

player (string): The player name being searched for.

characters (dict): A JSON Dictionary containing all of the characters this player has made. See the character keys above for the character key structure.

API Endpoints

Method: GET

/api/character/

Returns a random character.

Method: GET

/api/character/name/Doe

Returns the character named Doe

Method: GET

/api/character/id/1

Returns the character with the specified character_id where character_id is an integer

Method: GET

/api/character/character/player/ephreal

Returns all of the characters for the player "ephreal".