{ "openapi": "3.1.0", "info": { "title": "ReadmeFX API", "version": "1.0.0", "summary": "Direct SVG asset generation for GitHub READMEs.", "description": "ReadmeFX turns HTTP queries into GitHub-README-ready SVG assets: contribution stats, streaks, trophies, typing animations, banners, badges, a contribution snake, QR codes, and more. Every endpoint is a GET returning image/svg+xml with no authentication. Responses are edge-cached and safe to embed in any Markdown renderer, including GitHub (Camo proxy compatible). Each path is also available under the /api prefix (e.g. /api/stats) - both forms return identical output; the short form is conventional for README embeds.", "license": { "name": "License", "url": "https://github.com/PotenFYR-Studios/ReadmeFX/blob/main/LICENSE" } }, "externalDocs": { "url": "https://readmefx.potenfyr.in/docs", "description": "Human-readable API reference" }, "servers": [ { "url": "https://readmefx.potenfyr.in" } ], "tags": [ { "name": "Animations" }, { "name": "Icons" }, { "name": "GitHub" }, { "name": "Content" }, { "name": "Widgets" }, { "name": "Design" }, { "name": "Meta" } ], "paths": { "/typing": { "get": { "operationId": "typing", "summary": "Typing Animation", "description": "Terminal-style animated SVG with multi-line typing cycles and blinking cursor.", "tags": [ "Animations" ], "parameters": [ { "name": "lines", "in": "query", "required": false, "description": "Separate lines with a semicolon (;)", "schema": { "type": "string" }, "example": "Full Stack Engineer;Open Source Contributor;Building ReadmeFX" }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "fontSize", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 12, "maximum": 48 }, "example": 22 }, { "name": "cursor", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "|" } ], "responses": { "200": { "description": "Animated SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/text": { "get": { "operationId": "text", "summary": "Text Animation", "description": "Smooth CSS keyframe animated SVG text presets including fade, wave, slide, and glitch.", "tags": [ "Animations" ], "parameters": [ { "name": "text", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Build something useful." }, { "name": "animation", "in": "query", "required": false, "description": "One of: fade, slide, bounce, wave, pulse, glitch, blur-in, reveal, typewriter.", "schema": { "type": "string", "enum": [ "fade", "slide", "bounce", "wave", "pulse", "glitch", "blur-in", "reveal", "typewriter" ] }, "example": "fade" }, { "name": "duration", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 1, "maximum": 20 }, "example": 3 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Animated SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/icon": { "get": { "operationId": "icon", "summary": "Social Media Icons", "description": "Standalone vector SVG social media badges and developer platform tiles.", "tags": [ "Icons" ], "parameters": [ { "name": "name", "in": "query", "required": false, "description": "One of: github, x, youtube, linkedin, instagram, discord, twitch, reddit, telegram, whatsapp, spotify, steam, stackoverflow, devto, medium, website, email.", "schema": { "type": "string", "enum": [ "github", "x", "youtube", "linkedin", "instagram", "discord", "twitch", "reddit", "telegram", "whatsapp", "spotify", "steam", "stackoverflow", "devto", "medium", "website", "email" ] }, "example": "github" }, { "name": "size", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 16, "maximum": 64 }, "example": 24 }, { "name": "radius", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 0, "maximum": 32 }, "example": 8 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/streak": { "get": { "operationId": "streak", "summary": "Contribution Streak", "description": "Real public GitHub contribution metrics showing current streak, longest streak, and total.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "A public GitHub username is required.", "schema": { "type": "string" } }, { "name": "showCalendar", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "hideBorder", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/activity": { "get": { "operationId": "activity", "summary": "Contribution Heatmap", "description": "Full-year 52-week contribution graph with month/day labels and real GitHub activity levels.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "A public GitHub username is required.", "schema": { "type": "string" } }, { "name": "hideLegend", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "hideLabels", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/stars": { "get": { "operationId": "stars", "summary": "Star History Snapshot", "description": "Star progression curve and metrics for open-source repositories.", "tags": [ "GitHub" ], "parameters": [ { "name": "repo", "in": "query", "required": true, "description": "Format must be owner/repository_name", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/trophy": { "get": { "operationId": "trophy", "summary": "Profile Trophy Card", "description": "Tiered achievement trophies for repositories, stars, followers, commits, and pull requests.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "A public GitHub username is required.", "schema": { "type": "string" } }, { "name": "column", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 1, "maximum": 4 }, "example": 3 }, { "name": "noFrame", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/quote": { "get": { "operationId": "quote", "summary": "Quote Generator", "description": "High-density typographic quote card with multiline text wrapping and author attribution.", "tags": [ "Content" ], "parameters": [ { "name": "text", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Make it work, make it right, make it fast." }, { "name": "author", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Kent Beck" }, { "name": "alignment", "in": "query", "required": false, "description": "One of: left, center, right.", "schema": { "type": "string", "enum": [ "left", "center", "right" ] }, "example": "left" }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/stats": { "get": { "operationId": "stats", "summary": "GitHub Stats Card", "description": "Aggregate profile statistics including stars earned, commits, pull requests, issues, and grade.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "A public GitHub username is required.", "schema": { "type": "string" } }, { "name": "showIcons", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": true }, { "name": "rank", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": true }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/languages": { "get": { "operationId": "languages", "summary": "Top Languages", "description": "Calculated byte percentages of most used programming languages across public repositories.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "A public GitHub username is required.", "schema": { "type": "string" } }, { "name": "langsCount", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 1, "maximum": 8 }, "example": 5 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/repo": { "get": { "operationId": "repo", "summary": "Repository Card", "description": "Compact repository card showing stars, forks, language, license, and description.", "tags": [ "GitHub" ], "parameters": [ { "name": "repo", "in": "query", "required": true, "description": "Format: owner/name", "schema": { "type": "string" } }, { "name": "showDescription", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": true }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/visitors": { "get": { "operationId": "visitors", "summary": "Visitor Counter", "description": "Live profile visitor counter badge with persistent key-value tracking.", "tags": [ "Widgets" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "A key is required to identify your view counter.", "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Profile Views" }, { "name": "color", "in": "query", "required": false, "description": "One of: #3b82f6, #22c55e, #a855f7, #ef4444, #525252.", "schema": { "type": "string", "enum": [ "#3b82f6", "#22c55e", "#a855f7", "#ef4444", "#525252" ] }, "example": "#3b82f6" }, { "name": "style", "in": "query", "required": false, "description": "One of: flat, flat-square, for-the-badge.", "schema": { "type": "string", "enum": [ "flat", "flat-square", "for-the-badge" ] }, "example": "flat" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/views": { "get": { "operationId": "views", "summary": "Profile Activity Snapshot", "description": "Concise developer snapshot showing public bio, followers, repositories, and developer score.", "tags": [ "Widgets" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "A public GitHub username is required.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/badge": { "get": { "operationId": "badge", "summary": "Animated Badge", "description": "Clean shields-style badge with micro-animations like shimmer, pulse, and glow.", "tags": [ "Content" ], "parameters": [ { "name": "label", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Build" }, { "name": "message", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Passing" }, { "name": "color", "in": "query", "required": false, "description": "One of: success, blue, error, warning, purple, gray.", "schema": { "type": "string", "enum": [ "success", "blue", "error", "warning", "purple", "gray" ] }, "example": "success" }, { "name": "animation", "in": "query", "required": false, "description": "One of: none, shimmer, pulse, glow, bounce.", "schema": { "type": "string", "enum": [ "none", "shimmer", "pulse", "glow", "bounce" ] }, "example": "none" }, { "name": "style", "in": "query", "required": false, "description": "One of: flat, flat-square, for-the-badge.", "schema": { "type": "string", "enum": [ "flat", "flat-square", "for-the-badge" ] }, "example": "flat" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/skills": { "get": { "operationId": "skills", "summary": "Technology Icons Row", "description": "A responsive grid or row of developer stack icons with titles.", "tags": [ "Icons" ], "parameters": [ { "name": "skills", "in": "query", "required": false, "description": "Supports 35+ technologies: react, ts, js, python, go, rust, docker, k8s, etc.", "schema": { "type": "string" }, "example": "react,typescript,nodejs,docker,tailwind,go,rust" }, { "name": "showLabels", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": true }, { "name": "size", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 16, "maximum": 48 }, "example": 28 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/timeline": { "get": { "operationId": "timeline", "summary": "Activity Timeline", "description": "Live chronological stream of recent GitHub push, pull request, and issue events.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "A public GitHub username is required.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 1, "maximum": 8 }, "example": 4 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/svg": { "get": { "operationId": "svg", "summary": "Geometric SVG Utility", "description": "README separators, dividers, status pills, and geometric callouts.", "tags": [ "Design" ], "parameters": [ { "name": "type", "in": "query", "required": false, "description": "One of: divider, status, pill, card.", "schema": { "type": "string", "enum": [ "divider", "status", "pill", "card" ] }, "example": "divider" }, { "name": "text", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Operational ยท All Systems Normal" }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/banner": { "get": { "operationId": "banner", "summary": "Markdown Header Banner", "description": "Header banners for developer profiles and projects with background dot/grid patterns.", "tags": [ "Design" ], "parameters": [ { "name": "title", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Hello, World." }, { "name": "subtitle", "in": "query", "required": false, "description": "", "schema": { "type": "string" }, "example": "Software engineer & open source builder" }, { "name": "pattern", "in": "query", "required": false, "description": "One of: dots, grid, lines, none.", "schema": { "type": "string", "enum": [ "dots", "grid", "lines", "none" ] }, "example": "dots" }, { "name": "alignment", "in": "query", "required": false, "description": "One of: center, left.", "schema": { "type": "string", "enum": [ "center", "left" ] }, "example": "center" }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/snake": { "get": { "operationId": "snake", "summary": "Contribution Snake", "description": "Animated snake slithering across your real GitHub contribution calendar.", "tags": [ "Animations" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "Uses your public contribution calendar.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "duration", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 3, "maximum": 30 }, "example": 10 }, { "name": "color", "in": "query", "required": false, "description": "Leave empty to use the theme accent.", "schema": { "type": "string" } }, { "name": "title", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Animated SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/neofetch": { "get": { "operationId": "neofetch", "summary": "GitHub Neofetch", "description": "Terminal-style neofetch card showing your repos, stars, followers and uptime.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "title", "in": "query", "required": false, "description": "Defaults to username@github.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/hours": { "get": { "operationId": "hours", "summary": "Coding Clock", "description": "Radial 24-hour dial showing when your commits land, with your peak hour.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "Based on your recent public activity.", "schema": { "type": "string" } }, { "name": "title", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "color", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/joke": { "get": { "operationId": "joke", "summary": "Dev Joke Card", "description": "A rotating developer joke card - new laughs every day in your README.", "tags": [ "Content" ], "parameters": [ { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "index", "in": "query", "required": false, "description": "Leave empty to rotate automatically.", "schema": { "type": "number", "minimum": 0, "maximum": 29 } } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/fact": { "get": { "operationId": "fact", "summary": "Dev Fact Card", "description": "A rotating technology fact card to spark curiosity in your profile.", "tags": [ "Content" ], "parameters": [ { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "index", "in": "query", "required": false, "description": "Leave empty to rotate automatically.", "schema": { "type": "number", "minimum": 0, "maximum": 29 } } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/countdown": { "get": { "operationId": "countdown", "summary": "Progress Countdown", "description": "Year progress bar or a countdown to any date - perfect for launches.", "tags": [ "Widgets" ], "parameters": [ { "name": "mode", "in": "query", "required": false, "description": "One of: year, date.", "schema": { "type": "string", "enum": [ "year", "date" ] }, "example": "year" }, { "name": "date", "in": "query", "required": false, "description": "Only used in Date Countdown mode.", "schema": { "type": "string" } }, { "name": "label", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/qr": { "get": { "operationId": "qr", "summary": "QR Code Card", "description": "Scannable QR code linking to your GitHub profile, repo, or any URL.", "tags": [ "Widgets" ], "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Any URL or text up to ~100 characters.", "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 180, "maximum": 640 }, "example": 320 }, { "name": "style", "in": "query", "required": false, "description": "One of: square, rounded, dots.", "schema": { "type": "string", "enum": [ "square", "rounded", "dots" ] }, "example": "square" }, { "name": "caption", "in": "query", "required": false, "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/achievements": { "get": { "operationId": "achievements", "summary": "Achievements Card", "description": "Your GitHub achievement medals (Pull Shark, Starstruck, and more), rendered live.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "title", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 1, "maximum": 15 }, "example": 15 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/pinned": { "get": { "operationId": "pinned", "summary": "Pinned Repositories", "description": "Your pinned repositories as a live showcase row with stars, forks, and languages.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "columns", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 1, "maximum": 4 }, "example": 2 }, { "name": "title", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/leetcode": { "get": { "operationId": "leetcode", "summary": "LeetCode Stats", "description": "Your LeetCode progress: total solved with easy, medium, and hard breakdowns.", "tags": [ "Widgets" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "Your leetcode.com username (not GitHub).", "schema": { "type": "string" } }, { "name": "hide_rank", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/feed": { "get": { "operationId": "feed", "summary": "Blog Feed Card", "description": "Your latest posts from any RSS or Atom feed - no GitHub Actions required.", "tags": [ "Content" ], "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Any RSS or Atom feed. Or set username= for a dev.to feed.", "schema": { "type": "string" } }, { "name": "title", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 1, "maximum": 8 }, "example": 4 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/iso": { "get": { "operationId": "iso", "summary": "3D Contribution City", "description": "Isometric 3D skyline built from your real contribution graph - no Actions needed.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "color", "in": "query", "required": false, "description": "Leave empty to use the theme accent.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/score": { "get": { "operationId": "score", "summary": "Repository Health Score", "description": "Transparent 0-100 health score for any repo: maintenance, activity, community, hygiene.", "tags": [ "Widgets" ], "parameters": [ { "name": "repo", "in": "query", "required": true, "description": "e.g. PotenFYR-Studios/ReadmeFX", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/profile": { "get": { "operationId": "profile", "summary": "Profile Summary Card", "description": "One tall card with everything: stats, languages, streaks, and your rank.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/status": { "get": { "operationId": "status", "summary": "Live Status Card", "description": "Availability dot with your latest push - an \"open to work\" card that updates itself.", "tags": [ "Widgets" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "text", "in": "query", "required": false, "description": "Overrides the automatic last-activity message.", "schema": { "type": "string" } }, { "name": "available", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": true }, { "name": "pulse", "in": "query", "required": false, "description": "Animate the availability dot.", "schema": { "type": "boolean" }, "example": true }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Animated SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/npm": { "get": { "operationId": "npm", "summary": "npm Package Stats", "description": "Monthly download counts for any package on the npm registry.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/pypi": { "get": { "operationId": "pypi", "summary": "PyPI Package Stats", "description": "Download stats and metadata for Python packages on PyPI.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/crates": { "get": { "operationId": "crates", "summary": "crates.io Stats", "description": "Total and recent downloads for Rust crates.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/dockerhub": { "get": { "operationId": "dockerhub", "summary": "Docker Hub Stats", "description": "Pull counts and stars for any Docker Hub image.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/nuget": { "get": { "operationId": "nuget", "summary": "NuGet Package Stats", "description": "Total downloads for .NET and NuGet packages.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/rubygems": { "get": { "operationId": "rubygems", "summary": "RubyGems Stats", "description": "Download stats for Ruby gems.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/packagist": { "get": { "operationId": "packagist", "summary": "Packagist Stats", "description": "Total downloads for Composer/PHP packages.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/homebrew": { "get": { "operationId": "homebrew", "summary": "Homebrew Formula Stats", "description": "30-day install counts for Homebrew formulae.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/modrinth": { "get": { "operationId": "modrinth", "summary": "Modrinth Project Stats", "description": "Downloads and followers for Modrinth projects.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/codewars": { "get": { "operationId": "codewars", "summary": "Codewars Stats", "description": "Honor, overall rank, and kata progress from Codewars.", "tags": [ "Widgets" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/codeforces": { "get": { "operationId": "codeforces", "summary": "Codeforces Stats", "description": "Competitive programming rating, max rating, and rank.", "tags": [ "Widgets" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/chess": { "get": { "operationId": "chess", "summary": "Chess.com Stats", "description": "Blitz, rapid, and bullet ratings from Chess.com.", "tags": [ "Widgets" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/stackoverflow": { "get": { "operationId": "stackoverflow", "summary": "Stack Overflow Stats", "description": "Reputation, answers, and badges from Stack Overflow.", "tags": [ "Widgets" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "Your numeric Stack Overflow user ID.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/release": { "get": { "operationId": "release", "summary": "Latest Release", "description": "The latest release tag, name, and date for any repository.", "tags": [ "GitHub" ], "parameters": [ { "name": "repo", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/org": { "get": { "operationId": "org", "summary": "Organization Card", "description": "Stars and public repo counts for any GitHub organization.", "tags": [ "GitHub" ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/contributors": { "get": { "operationId": "contributors", "summary": "Contributors Card", "description": "Contributor avatar tiles for any repository - thank your team.", "tags": [ "GitHub" ], "parameters": [ { "name": "repo", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 4, "maximum": 24 }, "example": 14 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/excuse": { "get": { "operationId": "excuse", "summary": "Developer Excuse", "description": "A rotating developer excuse - for when the build breaks again.", "tags": [ "Content" ], "parameters": [ { "name": "index", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 0, "maximum": 29 } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/advice": { "get": { "operationId": "advice", "summary": "Dev Advice Card", "description": "A rotating piece of hard-earned developer advice.", "tags": [ "Content" ], "parameters": [ { "name": "index", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 0, "maximum": 29 } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/go": { "get": { "operationId": "go", "summary": "Go Module Stats", "description": "Latest version and release date for any Go module on proxy.golang.org.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/maven": { "get": { "operationId": "maven", "summary": "Maven Central Stats", "description": "Latest version and version count for JVM artifacts on Maven Central.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/hex": { "get": { "operationId": "hex", "summary": "Hex.pm Stats", "description": "Download stats for Elixir packages on Hex.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/cpan": { "get": { "operationId": "cpan", "summary": "CPAN Stats", "description": "Download stats for Perl distributions on CPAN.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/cran": { "get": { "operationId": "cran", "summary": "CRAN Stats", "description": "Monthly download stats for R packages on CRAN.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/pub": { "get": { "operationId": "pub", "summary": "Pub (Dart) Stats", "description": "Downloads and likes for Dart and Flutter packages.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/cocoapods": { "get": { "operationId": "cocoapods", "summary": "CocoaPods Stats", "description": "Download stats for iOS and macOS CocoaPods.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/conda": { "get": { "operationId": "conda", "summary": "Conda Package Stats", "description": "Download stats for Conda packages (defaults to conda-forge).", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/wordpress": { "get": { "operationId": "wordpress", "summary": "WordPress Plugin Stats", "description": "Downloads and active installs for WordPress.org plugins.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/huggingface": { "get": { "operationId": "huggingface", "summary": "Hugging Face Model Stats", "description": "Monthly downloads and likes for models on the Hugging Face Hub.", "tags": [ "Widgets" ], "parameters": [ { "name": "pkg", "in": "query", "required": true, "description": "", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 360, "maximum": 900 }, "example": 520 } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/chart": { "get": { "operationId": "chart", "summary": "Chart Engine", "description": "Bar, horizontal bar, line, area, pie, donut, radar, gauge, and sparkline charts from URL data.", "tags": [ "Design" ], "parameters": [ { "name": "type", "in": "query", "required": false, "description": "One of: bar, hbar, line, area, pie, donut, radar, gauge, sparkline.", "schema": { "type": "string", "enum": [ "bar", "hbar", "line", "area", "pie", "donut", "radar", "gauge", "sparkline" ] }, "example": "bar" }, { "name": "data", "in": "query", "required": true, "description": "Gauge takes a single 0-100 value.", "schema": { "type": "string" }, "example": "30,80,45,60,95" }, { "name": "labels", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "title", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "color", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "color2", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "unit", "in": "query", "required": false, "description": "", "schema": { "type": "string" } }, { "name": "show_grid", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": true }, { "name": "show_values", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": true }, { "name": "show_labels", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": true }, { "name": "width", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 220, "maximum": 1400 }, "example": 560 }, { "name": "height", "in": "query", "required": false, "description": "", "schema": { "type": "number", "minimum": 80, "maximum": 900 }, "example": 320 }, { "name": "theme", "in": "query", "required": false, "description": "One of: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg.", "schema": { "type": "string", "enum": [ "midnight", "dark", "transparent", "graphite", "github-dark", "dracula", "nord", "tokyo-night", "radical", "slate", "monokai", "merko", "gruvbox", "onedark", "cobalt", "synthwave", "highcontrast", "chartreuse-dark", "coral", "iceberg" ] }, "example": "midnight" }, { "name": "hide_border", "in": "query", "required": false, "description": "", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Static SVG image", "content": { "image/svg+xml": {} } }, "400": { "description": "Invalid parameters (returned as a rendered SVG error card)", "content": { "image/svg+xml": {} } }, "404": { "description": "GitHub resource not found", "content": { "image/svg+xml": {} } }, "429": { "description": "GitHub API rate limit exceeded", "content": { "image/svg+xml": {} } } } } }, "/api/health": { "get": { "operationId": "health", "summary": "Service health", "description": "JSON status of the ReadmeFX service and its GitHub dependency.", "tags": [ "Meta" ], "responses": { "200": { "description": "Health status", "content": { "application/json": {} } } } } } } }