https://github.com/manishkumar1080/first-draft-universities

Free & open source API service for obtaining information about +9600 universities worldwide.
https://github.com/manishkumar1080/first-draft-universities

api api-rest asyncapi asyncpg fastapi fastapi-sqlalchemy python python3 uvicorn

Last synced: 22 days ago
JSON representation

Free & open source API service for obtaining information about +9600 universities worldwide.

• Host: GitHub
• URL: https://github.com/manishkumar1080/first-draft-universities
• Owner: manishkumar1080
• Created: 2024-05-25T08:28:36.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-25T08:51:32.000Z (6 months ago)
• Last Synced: 2024-07-29T16:59:27.005Z (4 months ago)
• Topics: api, api-rest, asyncapi, asyncpg, fastapi, fastapi-sqlalchemy, python, python3, uvicorn
• Language: Python
• Homepage:
• Size: 135 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        



## Universities is free & open source API service. :school_satchel:

   

## Features :rocket:

* **Python **FastAPI** backend.** :hammer:

* **SQLAlchemy** - models :bar_chart:

* **Asynchronous** - Thanks to Uvicorn **Universities API** comes with a incredibly fast ASGI server, :rocket:

* **Large database** - Supports over +140 countries +9600 Universities :satellite:

* **Documentation** - Have an automatic API documentation web user interface thanks to FastAPI

* **Open source** - Everything from the code base is opensource and free to use under a permissive MIT license.

## Try it online with the [Documentation](https://universitiesapi.herokuapp.com) now! 

## How to use & query parameters :bulb:

### You can search by:

* **Country**             ```/search?country=India``` or ```/search?country=United+States```

* **Name**                ```/search?name=harvard``` 

* **Alpha_two_code**      ```/search?alpha_two_code=FR```

* **Domain**              ```/search?domain=uni-muenchen.de```

### Multiple querying & Auto completion

* **Name** and **Country** ```/search?country=Brazil&name=Centro```

* **Name** and **Alpha_two_code** ```/search?name=oxford&alpha_two_code=gb```

### Example Response 

```JSON

{

    "name": "Ludwig-Maximilians-Universität München",

    "alpha_two_code": "DE",

    "country": "Germany",

    "web_pages": [

      "http://www.uni-muenchen.de/"

    ],

    "domains": [

      "uni-muenchen.de"

    ],

    "state_province": null

}

```

## For Installation :pushpin:

```shell

git clone https://github.com/ycd/universities.git

cd universities

virtulenv env

source env/bin/activate

pip install -r requirements.txt

uvicorn app.main:app --reload

```