Jet Set Radio API
Documentation

Home Swagger Docs

Introduction

Welcome to the jsrapi, the Jet Set Radio API! This documentation should help get you familiar with which resources are available and how to consume them with HTTP requests.

More info on rate limiting, caching, and other info can be found near the bottom of the page.

Swagger Docs

You can also use the swagger docs to view the available endpoints, see their parameters, and test the routes out!

___________________________________________________________

Resources

The following Resources are currently available to be consumed from. More resources will be added in the future.

  • Games
  • Characters
  • Locations
  • Levels
  • Graffiti Tags
  • Graffiti Souls
  • Songs
  • Artists
  • Collectibles

The following Resources will be added in a future release of JSRAPI.

If you would like to contribute in adding any of these resources, see the Contributing Docs.

  • Street Challenges
  • Jet Challenges
  • Gangs
  • Acheivements (JSR only)
  • Mystery Tapes
  • Grind Tricks

Each Resource is described more in detail below. An example request and response is provided for each resource. Note that the example responses provided on this page won't always match exactly what is returned from the example request. To get the most accurate data, it is best to try out the requests for yourself.

Games

A Game is a resource describing a published game developed within the Jet Set Radio Franchise.

Endpoints:

  • /games ==> Returns all Games
  • /games/:id ==> Returns a single Game by ID

Example Request:

https://jetsetradio-api.onrender.com/v1/api/games?name=Jet Set Radio Future

Example Response:

Characters

A Character is a resource describing a character from a specific Game.

Endpoints:

  • /characters ==> Returns all Characters
  • /characters/random ==> Returns a Random Character From any Game
  • /characters/random?game=jsr ==> Returns a Random JSR Character
  • /characters/random?game=jsrf ==> Returns a Random JSRF Character
  • /characters/random?game=brc ==> Returns a Random BRC Character
  • /characters/random?count=10 ==> Returns 10 random Characters
  • /characters/jsr ==> Returns all Jet Set Radio Characters
  • /characters/jsr/:id ==> Returns a single JSR Character by ID
  • /characters/jsrf ==> Returns all Jet Set Radio Future Characters
  • /characters/jsrf/:id ==> Returns a single JSRF Character by ID
  • /characters/brc ==> Returns all Bomb Rush Cyberfunk Characters
  • /characters/brc/:id ==> Returns a single BRC Character by ID

Example Request:

https://jetsetradio-api.onrender.com/v1/api/characters/jsr

Example Response:

Locations

A Location is a resource describing a location or place from a specific Game.

Endpoints:

  • /locations ==> Returns all Locations
  • /locations/random ==> Returns a Random Location From any Game
  • /locations/random?game=jsr ==> Returns a Random JSR Location
  • /locations/random?game=jsrf ==> Returns a Random JSRF Location
  • /locations/random?game=brc ==> Returns a Random BRC Location
  • /locations/random?count=10 ==> Returns 10 random Locations
  • /locations/jsr ==> Returns all Jet Set Radio Locations
  • /locations/jsr/:id ==> Returns a single JSR Location by ID
  • /locations/jsrf ==> Returns all Jet Set Radio Future Locations
  • /locations/jsrf/:id ==> Returns a single JSRF Location by ID
  • /locations/brc ==> Returns all Bomb Rush Cyberfunk Locations
  • /locations/brc/:id ==> Returns a single BRC Location by ID

Example Request:

https://jetsetradio-api.onrender.com/v1/api/locations?sortBy=name&limit=5

Example Response:

Levels

A Level is a resource describing a level from Jet Set Radio/Jet Grind Radio.

Endpoints:

  • /levels ==> Returns all Levels
  • /levels/:id ==> Returns a single Level by ID

Example Request:

https://jetsetradio-api.onrender.com/v1/api/levels?sortBy=chapter

Example Response:

Graffiti-Tags

A Graffiti Tag is a resource describing a Graffiti Point from a specific Game.

Endpoints:

  • /graffiti-tags ==> Returns all Graffiti-Tags
  • /graffiti-tags/jsr ==> Returns all Jet Set Radio Graffiti-Tags
  • /graffiti-tags/jsr/:id ==> Returns a single JSR Graffiti-Tag by ID
  • /graffiti-tags/jsrf ==> Returns all Jet Set Radio Future Graffiti-Tags
  • /graffiti-tags/jsrf/:id ==> Returns a single JSRF Graffiti-Tag by ID
  • /graffiti-tags/jsr?size=XL ==> Returns all JSR XL Graffiti-Tags
  • /graffiti-tags?tagName=POISON JAM ==> Returns Graffiti-Tags with tagName

Example Request:

https://jetsetradio-api.onrender.com/v1/api/graffiti-tags?sortBy=size&orderBy=desc

Example Response:

Graffiti-Souls

A Graffiti Soul is a resource describing a Graffiti Soul from a specific Game.

Endpoints:

  • /graffiti-souls ==> Returns all Graffiti-Souls
  • /graffiti-souls/random ==> Returns a Random Location From any Game
  • /graffiti-souls/random?game=jsr ==> Returns a Random JSR Graffiti-Souls
  • /graffiti-souls/random?game=jsrf ==> Returns a Random JSRF Graffiti-Souls
  • /graffiti-souls/random?count=10 ==> Returns 10 random Graffiti-Souls
  • /graffiti-souls/jsr ==> Returns all Jet Set Radio Graffiti-Souls
  • /graffiti-souls/jsr/:id ==> Returns a single JSR Graffiti-Soul by ID
  • /graffiti-souls/jsrf ==> Returns all Jet Set Radio Future Graffiti-Souls
  • /graffiti-souls/jsrf/:id ==> Returns a single JSRF Graffiti-Soul by ID
  • /graffiti-souls/jsrf?size=M ==> Returns all JSRF M Graffiti-Souls
  • /graffiti-souls?locationName=Hikage Street ==> Returns All Graffiti-Souls in a specific location

Example Request:

https://jetsetradio-api.onrender.com/v1/api/graffiti-souls?sortBy=size&orderBy=desc

Example Response:

Collectibles

A Collectible is a resource describing a location or place from a specific Game. The only supported game currently is Bomb Rush Cyberfunk.

Endpoints:

  • /collectibles ==> Returns all Collectibles
  • /collectibles/random ==> Returns a Random Collectible
  • /collectibles/random?count=10 ==> Returns 10 random Collectibles
  • /collectibles/:id ==> Returns a single Collectible by ID
  • /collectibles?type=CD ==> Returns all CD Collectibles
  • /collectibles?character.name=Shine ==> Returns Shine's Collectibles

Example Request:

https://jetsetradio-api.onrender.com/v1/api/collectibles?sortBy=name&limit=5

Example Response:

Songs

A Song is a resource describing a song from a specific Game.

Endpoints:

  • /songs ==> Returns all Songs
  • /songs/random ==> Returns a Random Song From any Game
  • /songs/random?game=jsr ==> Returns a Random JSR Song
  • /songs/random?game=jsrf ==> Returns a Random JSRF Song
  • /songs/random?game=brc ==> Returns a Random BRC Song
  • /songs/random?count=10&game=jsrf ==> Returns 10 random JSRF Songs
  • /songs/jsr ==> Returns all Jet Set Radio Songs
  • /songs/jsr/:id ==> Returns a single JSR Song by ID
  • /songs/jsrf ==> Returns all Jet Set Radio Future Songs
  • /songs/jsrf/:id ==> Returns a single JSRF Song by ID
  • /songs/brc ==> Returns all Bomb Rush Cyberfunk Songs
  • /songs/brc/:id ==> Returns a single BRC Song by ID

Example Request:

https://jetsetradio-api.onrender.com/v1/api/songs?gameId=64285b7918c8a0231136dc5a

Example Response:

Artists

An Artist is a resource describing an artist that created a Song.

Endpoints:

  • /artists ==> Returns all Artists
  • /artists/:id ==> Returns a single Artist by ID
  • /artists/:id/songs ==> Returns all Songs by A Single Artist

Example Request:

https://jetsetradio-api.onrender.com/v1/api/artists/643865b5af5362b86b844d75

Example Response:

Audio/Quotes

An Audio is a resource describing a audio/quote by a character from a specific Game.

Endpoints:

  • /audio ==> Returns all Audio
  • /audio/random ==> Returns a Random Audio From any Game
  • /audio/random?game=jsr ==> Returns a Random JSR Audio
  • /audio/random?game=jsrf ==> Returns a Random JSRF Audio
  • /audio/random?count=10&game=jsrf ==> Returns 10 random JSRF Audio
  • /audio/jsr ==> Returns all Jet Set Radio Audio
  • /audio/jsr/:id ==> Returns a single JSR Audio by ID
  • /audio/jsrf ==> Returns all Jet Set Radio Future Audio
  • /audio/jsrf/:id ==> Returns a single JSRF Audio by ID
  • /audio/jsrf?speaker=DJ Professor K ==> Returns DJ Professor K quotes from JSRF

Example Request:

https://jetsetradio-api.onrender.com/v1/api/songs?gameId=64285b7918c8a0231136dc5a

Example Response:

___________________________________________________________

Base URL

The Base URL is the root URL for all of the API. If you ever get an error performing a request check the BaseURL first.

The Base URL is:

https://jetsetradio-api.onrender.com/v1/api/

Authentication

Jsrapi is a completely open API. No authentication is required. This means you are only able to do GET requests. If you find a mistake in the data, then send an email to jetsetradio.api@gmail.com or post on issue on the github page.

Rate Limiting

A request limit has been set to avoid malicious abuse(if anyone were to do that!). Limiting is set per IP address. You can make a total of up to 1000 requests per hour.

Sorting

All API routes support the sortBy and orderBy parameters. If orderBy is omitted, it will assume an ascending direction.

Example:

https://jetsetradio-api.onrender.com/v1/api/characters/jsr?sortBy=name&orderBy=desc

Limiting

All API routes(with the exception of /random) support the limit parameter. You can use this to return a limited number of results instead of the entire response.

Example:

https://jetsetradio-api.onrender.com/v1/api/locations/jsrf?limit=5

Caching

All API routes utilize cache in memory to be able to serve content faster! The cache is automatically set to expire after 1 hour. The expiration is subject to future change.