Public endpoints
A small set of routes is intentionally public (no Bearer token) for badges, landing widgets, and anonymous charts.
Public coding charts
| Path | Purpose |
|---|---|
GET /main/api/v1/get/public/time | Public time aggregates |
GET /main/api/v1/get/public/language | Public language distribution |
GET /main/api/v1/get/public/hitmaps | Public activity hitmap data |
GET /main/api/v1/get/public/weekly | Public weekly trends |
GET /main/api/v1/leaderboard/api/get/public | Public leaderboard snapshot |
These endpoints expose only data that users (or the product) have already made public. Do not assume private project paths appear here.
SVG badges
Users can generate shareable coding-stats badges for GitHub READMEs and similar pages.
Authenticated helpers (Bearer required) create or refresh badge links, for example:
- create / share “my SVG” helpers under
/main/api/v1/
The public image is then served from a UUID-based public path such as:
GET /main/api/v1/public/github/svg/{userUUID}
Embed example:
Exact share URLs are shown in the website SVG generator UI after you create a badge.
Plans listing
GET /main/api/v1/get/list/plans
Returns publicly listable subscription plan metadata for the pricing page. Checkout and payment confirmation stay on first-party + payment-provider flows and are not documented as a free-form public API.
Client recommendations
- Cache public chart responses politely (they are relatively expensive and change slowly)
- Do not scrape authenticated dashboard HTML; use the documented JSON reads instead
- When embedding badges, use the UUID URL the product gave you — do not invent IDs