Documentation

Getting Started

I am Grit is designed to be simple and intuitive. Just enter your GitHub username on the homepage to get started with your analysis.

API Reference

GET /api/github/[username]

Fetches comprehensive GitHub profile data, statistics, and AI-generated insights.

Parameters

  • username (string, required) - GitHub username

Response

{
  "user": {
    "login": "string",
    "name": "string",
    "avatar_url": "string",
    "followers": number,
    "following": number,
    // ... more user fields
  },
  "stats": {
    "rank": number,
    "percentile": number,
    "totalStars": number,
    "totalForks": number,
    "contributions": number,
    "streak": number,
    "talents": ["string"],
    // ... more stats
  },
  "insights": ["string"],
  "opportunities": [...],
  "recommendations": ["string"]
}

GET /api/leaderboard

Fetches the global developer leaderboard.

Query Parameters

  • limit (number, optional) - Number of results (default: 100, max: 100)

Response

[
  {
    "rank": number,
    "username": "string",
    "avatar_url": "string",
    "score": number,
    "totalStars": number,
    "followers": number,
    "contributions": number
  }
]

Features

Real-Time Analysis

Get up-to-date statistics from your GitHub profile, including contributions, repositories, and language usage.

Privacy First

We only access public GitHub data. Your private repositories and personal information remain secure.

AI Insights

Powered by GPT-4, get personalized recommendations to improve your GitHub presence and career.

Developer Friendly

Built by developers for developers, with a focus on meaningful metrics and actionable insights.

Ranking Algorithm

Our ranking algorithm considers multiple factors to provide a comprehensive assessment:

  • Stars (10x weight): Total stars across all repositories
  • Forks (5x weight): Total forks indicating code reuse
  • Followers (3x weight): Your influence in the community
  • Repositories (2x weight): Number of public repositories
  • Contributions (1x weight): Total contributions in the last year
  • Account Age Bonus: Up to 1000 points for accounts 10+ years old

Rate Limits

To ensure fair usage and service availability:

  • API calls are limited to 60 requests per hour per IP
  • Profile analyses are cached for 1 hour
  • Leaderboard data is updated every 15 minutes

Support

Need help or have questions? We're here to assist: