Home/Docs/API Reference

API Reference

Complete reference for RepoPulse APIs including endpoints, parameters, and response formats

Quick Start

Repository Analysis

curl https://repopulse-one.vercel.app/api/repo/vercel/next.js

Get complete repository health analysis

README Badge

![Health](https://repopulse-one.vercel.app/api/badge/health?repo=vercel/next.js)

Add health badge to your README

API Endpoints

GET
/api/repo/:owner/:repo

Complete repository analysis with health score, insights, and metrics

Parameters

NameTypeRequiredDescription
ownerstringYesRepository owner username
repostringYesRepository name

Response

rawMetrics:Basic repository statistics
derivedMetrics:Calculated metrics (commit frequency, growth rates, etc.)
insights:Actionable insights with confidence scores
healthScore:Overall health score (0-100) with breakdown

Example

/api/repo/vercel/next.js
GET
/api/user/:username

User profile analysis with repository overview

Parameters

NameTypeRequiredDescription
usernamestringYesGitHub username

Response

user:GitHub user profile data
repositories:User repositories with basic stats
stats:Aggregated user statistics

Example

/api/user/octocat
GET
/api/org/:org

Organization-wide repository analysis

Parameters

NameTypeRequiredDescription
orgstringYesOrganization name

Response

organization:Organization name
repositories:All public repos with health scores
summary:Aggregated org statistics and distributions

Example

/api/org/vercel
GET
/api/card/repo

SVG repository card for README embedding

Parameters

NameTypeRequiredDescription
repostringYesRepository in owner/name format
themestringNoCard theme (default, carbon, etc.)

Response

SVG image content

Example

/api/card/repo?repo=vercel/next.js&theme=carbon
GET
/api/card/user

SVG user profile card

Parameters

NameTypeRequiredDescription
usernamestringYesGitHub username
themestringNoCard theme

Response

SVG image content

Example

/api/card/user?username=octocat&theme=dracula
GET
/api/card/languages

SVG language breakdown card

Parameters

NameTypeRequiredDescription
repostringYesRepository in owner/name format
themestringNoCard theme

Response

SVG image content

Example

/api/card/languages?repo=facebook/react&theme=ocean
GET
/api/badge/:type

Smart status badges

Parameters

NameTypeRequiredDescription
repostringYesRepository in owner/name format
themestringNoBadge theme (flat, rounded, etc.)
typestringYesBadge type (stars, forks, health, activity, issues)

Response

SVG badge image

Example

/api/badge/health?repo=vercel/next.js&theme=neon-blue

Configuration Options

Analysis Parameters

  • window - Analysis time window (30, 90, 365 days)
  • weights - Health score component weights
  • insights - Enabled insight categories

Theme Parameters

  • theme - Card/badge theme selection
  • 100+ card themes available
  • 25+ badge styles available

Example Configuration

/repo/vercel/next.js?theme=carbon&window=90&insights=activity,growth

Rate Limits & Caching

GitHub API Limits

  • • Unauthenticated: 60 requests/hour
  • • Authenticated: 5,000 requests/hour
  • • Set GITHUB_TOKEN for higher limits

RepoPulse Caching

  • • Repository data: 1 hour
  • • SVG cards/badges: 24 hours
  • • Theme-aware cache keys

Need help? Check out our FAQ orGitHub repository