github-readme-design-api

🔌 Application Programming Interface (API)

What is API❓

An application programming interface (API) is a connection between computers or between computer programs. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build or use such a connection or interface is called an API specification. A computer system that meets this standard is said to implement or expose an API. The term API may refer either to the specification or to the implementation.

Prerequisite 🚀



Banner's 🪧

Doesn't require any username or Repository name.

Method
GET

Light Banner

API endpoint →

https://github-readme-design.vercel.app/api/getHeadLight



Method
GET

Dark Banner

API endpoint →

https://github-readme-design.vercel.app/api/getHeadDark





Pinned Repository 📕

Require the Github Username and the Repository Name.
If you have the License added inside the Repository then will be fetch automatically otherwise you can forcely add any license for your repository just add this line &license=MIT (We have added MIT here but you can add your own) to the end of API.

Example: https://github-readme-design.vercel.app/api/starRepo/getStarLight?user=username&repo=repository-name&license=MIT

Method
GET

Light Starred Repository

API endpoint →

https://github-readme-design.vercel.app/api/starRepo/getStarLight?user=username&repo=repository-name



Method
GET

Dark Starred Repository

API endpoint →

https://github-readme-design.vercel.app/api/starRepo/getStarDark?user=username&repo=repository-name





Metric Card 📊 or Statistics 📈

Require the Github Username.
If you need to enable the dark mode then add this line &dark=true to the end of API.
Note: We have only dark and light mode right now in future versions we are updating new modes but you can also contribute to this 🙂

Example: https://github-readme-design.vercel.app/api/metricCard?user=username&dark=true

Method
GET

Light Statistic's Card

API endpoint →

https://github-readme-design.vercel.app/api/metricCard?user=username



Method
GET

Dark Statistic's Card

API endpoint →

https://github-readme-design.vercel.app/api/metricCard?user=username&dark=true





Language Used 🔡

Require the Github Username.
If you need to enable the dark mode then add this line &dark=true to the end of API.
Note: We have only dark and light mode right now in future versions we are updating new modes but you can also contribute to this 🙂

Example: https://github-readme-design.vercel.app/api/languageCard?user=username&dark=true

Method
GET

Language Most Used (Light)

API endpoint →

https://github-readme-design.vercel.app/api/languageCard?user=username



Method
GET

Language Most Used (Dark)

API endpoint →

https://github-readme-design.vercel.app/api/languageCard?user=username&dark=true



Please help us to improve this for everyone need Thank You!
Want to Contribute? Visit our official github repository to contribute Github-Readme-Design


Unable to understand? Sorry for this please use our GUI (Graphic User Interface) 💻 page for the help! Github-Readme-Design-GUI