API Documentation

Embed your DevProof Score on your personal website, GitHub README, or portfolio.

JSON API

Get user data in JSON format for custom integrations.

Endpoint:

GET https://devproof.dev/api/public/user/[username]

Example:

https://devproof.dev/api/public/user/Allusia1

Response:

{
  "username": "Allusia1",
  "avatar_url": "https://...",
  "score": 34,
  "rank": 1,
  "badge_count": 5,
  "project_count": 8,
  "status": "Open to Work",
  "country": "United States",
  "country_code": "US",
  "tech_stack": ["TypeScript", "Python"],
  "social_links": { ... },
  "profile_url": "https://devproof.dev/Allusia1"
}

SVG Badge

Embed a dynamic shields.io-style badge that displays your DevProof score and rank.

Endpoint:

Custom Label:

https://devproof.dev/badge/$Allusia1?label=Score

💡 By default, badges display your username (e.g. Allusia1). Use the label parameter to customize it to anything like "Score", "DevProof", or your own text.

Percentile Badge (Elite Tier)

Show off your elite status with a premium percentile badge. Displays your tier (Top 0.1%, 1%, 5%, 10%, 25%) with special styling and emojis.

Endpoint:

GET https://devproof.dev/badge/[username]/percentile

Flat (Default):

https://devproof.dev/badge/$Allusia1/percentile

Flat Square:

https://devproof.dev/badge/$Allusia1/percentile?style=flat-square

For The Badge (Recommended):

https://devproof.dev/badge/$Allusia1/percentile?style=for-the-badge

Tier Colors & Emojis:

👑 Top 0.1% - Brilliant Gold Gradient

💎 Top 1% - Purple Diamond Gradient

⭐ Top 5% - Royal Blue Gradient

🔥 Top 10% - Fiery Red Gradient

✨ Top 25% - Green Gradient

GitHub README Usage

Add your DevProof badge to your GitHub profile README to showcase your score.

Markdown:

[![DevProof](https://devproof.dev/badge/Allusia1)](https://devproof.dev/Allusia1)

HTML:

<a href="https://devproof.dev/Allusia1"><img src="https://devproof.dev/badge/Allusia1" alt="DevProof Badge"/></a>

For The Badge Style (Recommended):

[![DevProof](https://devproof.dev/badge/Allusia1?style=for-the-badge)](https://devproof.dev/Allusia1)

Percentile Badge (Elite Tier):

[![DevProof Elite](https://devproof.dev/badge/Allusia1/percentile?style=for-the-badge)](https://devproof.dev/Allusia1)

Parameters

Parameter	Type	Description
`style`	string	Badge style. Options: `flat` (default), `flat-square`, `plastic`, `for-the-badge`, `social`
`label`	string	Custom label text. Default: Your username (e.g. `Allusia1`)
`theme`	string	Color theme for social style. Options: `dark`, `light`

Rate Limits & Caching

• Responses are cached for 5 minutes with stale-while-revalidate for 10 minutes

• All endpoints support CORS for client-side requests

• No authentication required for public endpoints