Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chinxcode/leetscan-api
LeetScan API is a tool for fetching data from LeetCode user profiles. It provides developers and recruiters with detailed insights into a user's coding activity and contest performance. This API integrates easily with other systems and offers robust data access features.
https://github.com/chinxcode/leetscan-api
api express graphql leetcode leetcode-api nodejs
Last synced: 15 days ago
JSON representation
LeetScan API is a tool for fetching data from LeetCode user profiles. It provides developers and recruiters with detailed insights into a user's coding activity and contest performance. This API integrates easily with other systems and offers robust data access features.
- Host: GitHub
- URL: https://github.com/chinxcode/leetscan-api
- Owner: chinxcode
- Created: 2024-09-15T20:04:36.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-16T06:54:31.000Z (about 2 months ago)
- Last Synced: 2024-11-16T07:28:28.590Z (about 2 months ago)
- Topics: api, express, graphql, leetcode, leetcode-api, nodejs
- Language: JavaScript
- Homepage: https://leetscan.vercel.app
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 LeetScan API
[](https://github.com/chinxcode/leetScan-api/stargazers)
[](https://github.com/chinxcode/leetScan-api/network)
[](https://github.com/chinxcode/leetScan-api/issues)
> LeetScan API fetches and displays profile data from LeetCode, allowing developers to access key statistics and recent activities.
LeetScan API is a powerful tool for fetching and analyzing data from LeetCode user profiles. It provides developers, recruiters, and coding enthusiasts with detailed insights into a user's coding activity, problem-solving statistics, and contest performance. This API is designed for easy integration with other systems and offers robust data access features.
## 🌟 Features
- 🔍 **Profile Data Retrieval**: Fetch comprehensive LeetCode user profiles with detailed problem-solving statistics.
- 📊 **Contest and Submission Stats**: Access a user's contest rankings, total submissions, and recent activities.
- 🔢 **Multiple User Profiles**: Fetch data for multiple users in a single request.
- 🔒 **Rate Limiting**: Built-in rate limiting to handle multiple requests safely and prevent abuse.
- 🔌 **Easy Integration**: RESTful API that can be integrated into any platform or application.
- 📱 **Responsive Documentation**: Interactive and mobile-friendly API documentation.
## 📚 API Documentation
### Get Single Developer Profile
```
GET /:username
```
Replace `:username` with the LeetCode username.
#### Response Example
```json
{
"username": "codingwizard",
"totalSolved": 100,
"totalSubmissions": 150,
"totalQuestions": 1500,
"easySolved": 50,
"totalEasy": 500,
"mediumSolved": 30,
"totalMedium": 750,
"hardSolved": 20,
"totalHard": 250,
"ranking": 5000,
"contributionPoints": 500,
"reputation": 1000,
"submissionCalendar": {...},
"profile": {
"realName": "John Doe",
"aboutMe": "Passionate coder",
"userAvatar": "https://example.com/avatar.jpg",
"location": "New York",
"skillTags": ["Python", "JavaScript", "Algorithms"],
"websites": ["https://johndoe.com"],
"company": "Tech Corp",
"school": "Code University",
"starRating": 4.5
},
"recentSubmissions": [...],
"badges": [...],
"contestRanking": {
"attendedContestsCount": 10,
"rating": 1800,
"globalRanking": 1000,
"totalParticipants": 10000,
"topPercentage": 10,
"badge": {
"name": "Knight",
"icon": "https://example.com/knight.png"
}
}
}
```
### Get Multiple Developer Profiles
```
POST /multi
```
Send a POST request with a JSON body containing an array of usernames:
```json
{
"usernames": ["user1", "user2", "user3"]
}
```
The response will be an array of profile objects, each following the structure of the single profile response.
## 🛠️ Technologies Used
- **Node.js**
- **Express.js**
- **GraphQL** for fetching LeetCode data
- **HTML/CSS/JavaScript** for interactive documentation
## 🚀 Quick Start
Follow these steps to get started with LeetScan API:
1. Clone the repository:
```bash
git clone https://github.com/chinxcode/leetScan-api.git
```
2. Install dependencies:
```bash
cd leetScan-api
npm install
```
3. Start the server:
```bash
npm start
```
4. Access the API documentation:
Open `http://localhost:8000` in your web browser to view the interactive API documentation.
5. Make your first API call:
```bash
curl http://localhost:8000/leetcode_username
```
## 📖 Documentation
For more detailed information about the API, including request/response formats and error handling, visit the interactive documentation at the root URL of your deployed API.
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chinxcode/leetScan-api/issues).
## 📝 Projects made with LeetScan
1. **[devArena Leaderboard](https://github.com/chinxcode/devArena-leaderboard):**
This leaderboard application leverages the **[LeetScan API](https://github.com/chinxcode/leetscan-api)** to fetch coding profiles from LeetCode and display relevant statistics. It retrieves data from MongoDB and is built using Express.js with dotenv for environment variables, mongoose for database interactions, and express-rate-limit for rate limiting. Additionally, it includes CORS for unrestricted origins, making it a robust and secure solution for managing developer leaderboards.
2. **[Profile Data Handler](https://github.com/chinxcode/profile-data-handler):**
This backend service integrates the **[LeetScan API](https://github.com/chinxcode/leetscan-api)** to handle user profile data efficiently. It fetches LeetCode statistics and provides APIs for CRUD operations, enabling seamless data management and integration with other systems. Designed with scalability and performance in mind, it is ideal for managing and analyzing user profiles.
---
Made with ❤️ by Sachin Sharma