Alanzz / collegeAPI

An API that helps you to fetch colleges and their details.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CollegeAPI

Ever faced a problem while collecting the data of Indian Colleges? Here we are with the solution, College API.
An API that helps you to fetch the data of Indian Colleges.⚑


           


Tech Stack πŸ’»

Python FastAPI


What do we exactly do?

The ambition of this project is to provide data of Indian Colleges from all the categories listed in NIRF through different endpoints. We also enable the user to filter the college by the desired city and state.

Wants to contribute?πŸ‘€

You can contribute to this project under Hacktoberfest 2022 🀩

image

How to contribute?πŸ€”

We recommend you to go through the CONTRIBUTING.md where we have mentioned all the guidelines that help you to set up the project and make some awesome contributions πŸ˜„


Endpoints

Method Path Description
GET /all Fetch the list of all participating collges ranked by NIRF
GET /all/nirf Fetch the list of overall colleges ranked by NIRF
GET /engineering_colleges Fetch the list of all the engineering colleges in India.
GET /engineering_colleges/nirf Fetch the list of all the 300 engineering colleges ranked by NIRF. In this endpoint, the rank of the colleges will be provided along with the other details.
GET /engineering_colleges/state={state} Fetch the list of all the engineering colleges in the state passed by the user as a parameter.
GET /engineering_colleges/city={city} Fetch the list of all the engineering colleges in the city passed by the user as a parameter.
GET /medical_colleges Fetch the list of all the medical colleges in India.
GET /medical_colleges/state={state} Fetch the list of all the medical colleges in the state passed by the user as a parameter.
GET /medical_colleges/city={city} Fetch the list of all the medical colleges in the city passed by the user as a parameter.
GET /management_colleges Fetch the list of all the management colleges in India.
GET /management_colleges/nirf Fetch the list of all the 300 management colleges ranked by NIRF. In this endpoint, the rank of the colleges will be provided along with the other details.
GET /management_colleges/state={state} Fetch the list of all the management colleges in the state passed by the user as a parameter.
GET /colleges Fetch the list of all the colleges listed in NIRF
GET /colleges/nirf Fetch the list of all the colleges ranked by NIRF.
GET /pharmacy_colleges Fetch the list of all the pharmacy colleges listed in NIRF.
GET /universities Fetch the list of all the universities in India.
GET /universities/state={state} Fetch the list of all the universities in the state passed by the user as a parameter.
GET /universities/city={city} Fetch the list of all the universities in the city passed by the user as a parameter.
GET /dental_colleges Fetch the list of all the NIRF dental colleges in India.
GET /dental_colleges/state={state} Fetch the list of all the NIRF dental colleges in the state passed by the user as a parameter.
GET /dental_colleges/city={city} Fetch the list of all the NIRF dental colleges in the city passed by the user as a parameter.

For pagination add page and limit as query params i.e. /all/?page=1&limit=10

Project maintainers

Nikhil Raj
Nikhil Raj

About

An API that helps you to fetch colleges and their details.

License:GNU General Public License v3.0


Languages

Language:Python 100.0%