Frontend and REST API for BhagavadGita.io
Backend - Flask
Frontend - Material Design
Database - PostgreSQL, ElasticSearch
The Bhagavad Gita Application Programming Interface (API) allows a web or mobile developer to use the Bhagavad Gita text in their web or mobile application(s). It follows some of the Best Practices for designing a REST API.
The current version of the API is v1. We encourage you to explicitly use this version in the url.
All API access is over HTTPS, and accessed from https://bhagavadgita.io/api/v1. All data is sent and received as JSON.
HTTP requests to the BHAGAVAD GITA API are protected with OAUTH2 authentication. To be able to use the API, you need to be a registered BhagavadGita.io user. After signing in, you can register your applications from your Account Dashboard after which you will be issued a Client ID and Client Secret specific to an application that can be used to programatically get the access_token(valid for 300sec).
How to get an access token?
Make a POST request to
/auth/oauth/token with these parameters sent in Headers -
- Client ID - Obtained from Account Dashboard after registering an app.
- Client Secret - Obtained from Account Dashboard after registering an app.
- Grant Type - Use
- Scope - Use
verseif you just want to access the verses,
chapterif you just want to access the chapters and
verse chapterif you want access to both.
curl -X POST "https://bhagavadgita.io/auth/oauth/token" -H "accept: application/json" -H "content-type: application/x-www-form-urlencoded" -d "client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials&scope=verse%20chapter"
Then, you can use the received access_token to access any of the endpoints. You can send the access_token as a header or as a query parameter.
- Query Parameter
curl -X GET "https://bhagavadgita.io/v1/chapters?access_token=YOUR_ACCESS_TOKEN" -H "accept: application/json"
curl -X GET \ https://bhagavadgita.io/v1/chapters \ -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
We have 2 types of documenatations available for this API, both based on the Open API specification.
- Fork this repository and clone the forked repository.
- Create and activate a Python 3 virtualenv.
pip install -r requirements.txtto install the requirements.
foreman start -f localto start the server.
- API can be accessed at
http://127.0.0.1:5000/api/v1and frontend can be accessed at
Bug reports and pull requests are welcome on GitHub at https://github.com/gita/BhagavadGita. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
To submit a pull request -
- Fork/clone the repository.
- Create a new branch from the master branch.
- Open a pull request on Github describing what was fixed or added.