yashchaudhari008/codechef-cards-api

[NO LONGER MAINTAINED] A REST API to get codechef user details.

Codechef Cards API

A REST API to get codechef user details. Made using Spring Boot and jsoup.

---

📩 Request Format

https://codechef-cards-api.onrender.com/{username}

📝 Example URL

https://codechef-cards-api.onrender.com/mad_008

✉️ Response Format

{
    "data": {
        "username": {String},
        "name": {String},
        "isActiveUser": {Boolean},
        "rating": {Integer},
        "highestRating": {Integer},
        "stars": {Integer},
        "globalRank": {Long || null},
        "countryRank": {Long || null},
        "problemFullySolved": {Long},
        "problemPartiallySolved": {Long},
        "contestParticipated": {Integer},
        "country": {String}
    },
    "status": "success"
}

---

🖥 Apps Using This API

1. Codechef Cards

🏃‍ Runnning Locally

Open project in IDE of your choice (IntelliJ Recommended) and execute main method of CodechefCardsApiApplication.java

💡 Pro Tip - Use this JSON Formatter Chrome Extension to view in a structured format.

🤝 Contributing

Check CONTRIBUTING.md before contributing or making a PR. 👍

• You can find issues to work on here.
• Found a bug? or have a good suggestion create a fresh issue here.

NOTE :- For major changes, please open an issue first to discuss and then proceed further.

💁‍♂️ Contributors

Made with contrib.rocks.

📃 License

Distributed under the MIT License. See LICENSE for more information.

codechef-cards-api's Issues

Code refactoring and optimization

Spring Boot best practices, Code refactoring and optimization