Skip to content

OSC's official API. Used to serve details on our events, EB members and a lot more.

License

Notifications You must be signed in to change notification settings

osc-vitap/OSC-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OSC-API

Logo
OSC API that serves JSON data on events.

API Endpoints

ID Endpoint Example Details
1 [/] https://osc-api.herokuapp.com/ Index.
1 [/api/] https://osc-api.herokuapp.com/api/ API Base endpoint with documentation
2 [api/event/] https://osc-api.herokuapp.com/api/event/ GET complete data on all the events.
3 [api/event/<int:id>] https://osc-api.herokuapp.com/api/event/8 GET data from a particular event (from Event ID).
4 [api/event/latest] https://osc-api.herokuapp.com/api/event/latest GET data of the latest OSC event.
5 [api/event/announcement] https://osc-api.herokuapp.com/api/event/announcement?api_key= POST to this endpoint to send a discord announcement
6 [api/projects/] https://osc-api.herokuapp.com/api/projects GET all public repos from the github organisation.

Contributing

To contribute to OSC-API, fork the repository, create a new branch and send us a pull request. Make sure you read CONTRIBUTING.md before sending us Pull requests.

Also, thanks for contributing to Open-source!

License

OSC-API is under The GNU General Public License v3.0. Read the LICENSE file for more information.

About

OSC's official API. Used to serve details on our events, EB members and a lot more.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks