Skip to content

ycd/universities

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Universities is free & open source API service. 🎒

Features 🚀

  • Python FastAPI backend. 🔨
  • SQLAlchemy - models 📊
  • Asynchronous - Thanks to Uvicorn Universities API comes with a incredibly fast ASGI server, 🚀
  • Large database - Supports over +140 countries +9600 Universities 📡
  • 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 now!

How to use & query parameters 💡

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

{
    "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 📌

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

License

This project is licensed under the terms of the MIT license.