All Endpoints

Listed here are all the endpoints for the Hip Hop Xpress API.

Base URL

https://us-central1-hhx-api-48896.cloudfunctions.net/app

Note: This will likely change over the course of development.

Test endpoints

Try these endpoints to make sure your connection to the API is working.

GET /hello-world  // Hello World!
GET /alive        // The Hip Hop Xpress API is alive!

Version 1

Endpoints here are implemented primarily for the mobile app, but can be used elsewhere. As development continues, more documentation will be added for reference and you'll be able to see the progress here.

All endpoints in Version 1 of the API will be prefaced with /v1.

You can also view the error documentation for planning on handling errors.

Version 1 endpoints:

A quick explanation of the table:

• Implemented = Initial draft of endpoint has been written and likely deployed for testing
• Tested = Test suite written and passed
• Connected to App = App uses endpoint for fetching data

Endpoint	Implemented	Tested	Connected to App
Historic artists	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Participants	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Variations	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Courses	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Projects	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Featured artists	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Updates	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Location	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Social Media	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark: