// API REFERENCE

API Reference

All ReadmeForge endpoints. Every route accepts GET requests and returns an image/svg+xml response — usable directly as a markdown image URL.

Base URL: readmeforge.natrajx.inRuntime: Vercel EdgeAuth: None required

// OVERVIEW

Request Format

GET https://readmeforge.natrajx.in/api/{component}?param=value&param=value

Response Headers:
  Content-Type: image/svg+xml; charset=utf-8
  Cache-Control: public, max-age=86400
  Access-Control-Allow-Origin: *

Usage in GitHub README:
  ![Alt text](https://readmeforge.natrajx.in/api/banner?text=Hello&metal=gold)

Common Parameters

These parameters are supported by all endpoints:

Param	Type	Default	Description
`metal`	string	chrome	Metal theme name. Any of the 44 metal values.
`colors`	string	—	Comma-separated hex colors to override the metal gradient. E.g. #ff0000,#0000ff
`angle`	number	135	Gradient angle in degrees (0–360).
`theme`	dark \| light	dark	Overall color theme — controls backgrounds and text.
`width`	number	varies	SVG width in pixels.
`height`	number	varies	SVG height in pixels.

GET/api/banner

Full-width SVG banner with main heading, optional subtitle, and 28 design styles. Supports 20 SMIL text animation effects.

Parameters

Param	Type	Default	Description
`text`	string	READMEFORGE	Main heading text
`sub`	string	—	Subtitle / tagline below the heading
`style`	string	default	28 design styles: cyber-grid, neon-sign, hologram, retro-wave, glassmorphic, etc.
`anim`	string	—	Text animation effect (see /api/text-anim for full list)
`bg`	string	—	Background color override
`fontFamily`	string	Orbitron	Heading font family
`width`	number	800	Width in px (100–1200)
`height`	number	160	Height in px (60–400)

Example

![Banner](https://readmeforge.natrajx.in/api/banner?text=MY+PROJECT&sub=Built+with+AI&metal=neon-green&style=cyber-grid&width=900&height=180)

GET/api/card

Compact stat card displaying a title and a value. Use for GitHub stats, scores, counters, and key metrics.

Parameters

Param	Type	Default	Description
`title`	string	GitHub Stats	Card title label
`value`	string	—	Main value displayed prominently
`style`	string	default	Design style preset
`icon`	string	—	Icon identifier
`width`	number	320	Width in px
`height`	number	160	Height in px

Example

![Stars](https://readmeforge.natrajx.in/api/card?title=GitHub+Stars&value=1.2k&metal=gold&style=hologram)

GET/api/card-neo

Neumorphic (soft 3D) card with layered shadows and raised/inset aesthetics.

Parameters

Param	Type	Default	Description
`title`	string	Neo Card	Card title
`value`	string	—	Card value
`neoTheme`	dark \| light	dark	Neumorphic background theme
`neoStyle`	string	raised	raised \| inset \| flat

Example

![Neo Card](https://readmeforge.natrajx.in/api/card-neo?title=Projects&value=12&metal=chrome&neoTheme=dark)

GET/api/card-glass

Glassmorphic card with frosted blur effect, translucent backgrounds, and light border.

Parameters

Param	Type	Default	Description
`title`	string	Glass Card	Card title
`value`	string	—	Card value
`glassTheme`	dark \| light	dark	Glass background theme

Example

![Glass Card](https://readmeforge.natrajx.in/api/card-glass?title=Rating&value=5.0&metal=holographic&glassTheme=dark)

GET/api/button

Metallic SVG button in 16 styles. Wrap in [![label](url)](href) to make it clickable in a README.

Parameters

Param	Type	Default	Description
`label`	string	Click Me	Button label text
`style`	string	metallic	16 styles: metallic, ghost, outline, neon, chrome, gold, pill, sharp, glass, minimal, cyber, retro, gradient, brutalist, 3d, flat
`icon`	string	—	Icon to prepend to label
`width`	number	200	Width in px
`height`	number	48	Height in px

Example

<!-- Clickable button (link wraps the image) -->
[![Deploy](https://readmeforge.natrajx.in/api/button?label=Deploy+Now&metal=neon-green&style=metallic)](https://vercel.com)

GET/api/badge

Two-part label/value badge in 5 shapes. Great for version, status, and tech stack indicators.

Parameters

Param	Type	Default	Description
`label`	string	Label	Left side label text
`value`	string	—	Right side value text
`shape`	string	pill	pill \| sharp \| hex \| rounded \| flat
`valueColor`	string	—	Override the value text color (hex)

Example

![Version](https://readmeforge.natrajx.in/api/badge?label=Version&value=3.0.0&metal=gold&shape=pill)
![Status](https://readmeforge.natrajx.in/api/badge?label=Status&value=Active&metal=neon-green&shape=sharp)

GET/api/header

Full-width profile header with name, title, and optional avatar/logo area.

Parameters

Param	Type	Default	Description
`name`	string	Your Name	Display name
`title`	string	Developer	Job title or tagline
`avatar`	string	—	Avatar image URL
`style`	string	default	Design style preset
`width`	number	800	Width in px
`height`	number	200	Height in px

Example

![Header](https://readmeforge.natrajx.in/api/header?name=John+Doe&title=Full+Stack+Developer&metal=chrome&style=cyber-grid&width=900)

GET/api/footer

Thin footer strip with optional text and metallic divider styling.

Parameters

Param	Type	Default	Description
`text`	string	—	Footer text
`style`	string	wave	Divider style within the footer
`width`	number	800	Width in px
`height`	number	60	Height in px

Example

![Footer](https://readmeforge.natrajx.in/api/footer?text=Thanks+for+visiting&metal=chrome&style=wave&width=900)

GET/api/divider

Decorative horizontal divider in 6 styles. Use between README sections.

Parameters

Param	Type	Default	Description
`style`	string	wave	wave \| zigzag \| dots \| straight \| double \| gradient
`width`	number	800	Width in px
`height`	number	40	Height in px

Example

![Divider](https://readmeforge.natrajx.in/api/divider?style=wave&metal=gold&width=900)
![Divider](https://readmeforge.natrajx.in/api/divider?style=zigzag&metal=neon-blue&width=900)

GET/api/text-anim

Animated SVG text with 20 SMIL-based effects. Animates in GitHub READMEs.

Parameters

Param	Type	Default	Description
`text`	string	Hello World	The text to animate
`effect`	string	typewriter	typewriter \| glitch \| neon-pulse \| wave \| matrix-rain \| hologram-flicker \| cyber-scan \| pixel-dissolve \| data-stream \| lightning \| fire \| ice \| aurora \| portal \| quantum \| gravity-well \| sound-wave \| dna-helix \| constellation \| wormhole
`size`	number	32	Font size in px
`width`	number	600	Width in px
`height`	number	80	Height in px

Example

![Typing](https://readmeforge.natrajx.in/api/text-anim?text=Hello+World&effect=typewriter&metal=neon-green&size=36)
![Glitch](https://readmeforge.natrajx.in/api/text-anim?text=SYSTEM+ERROR&effect=glitch&metal=neon-pink&size=40)

GET/api/progress-bar

Single horizontal progress bar with a label and percentage fill.

Parameters

Param	Type	Default	Description
`skill`	string	Skill	Skill / label name
`value`	number	75	Percentage fill (0–100)
`width`	number	400	Width in px
`height`	number	40	Height in px

Example

![Python](https://readmeforge.natrajx.in/api/progress-bar?skill=Python&value=90&metal=neon-blue&width=400)

GET/api/skill-tree

Multiple stacked skill progress bars in one SVG. Pass all skills in a single param.

Parameters

Param	Type	Default	Description
`skills`*	string	—	Comma-separated Name:percent pairs. E.g. Python:90,TypeScript:85,Rust:60
`title`	string	Tech Stack	Section title above the bars
`width`	number	500	Width in px

Example

![Skills](https://readmeforge.natrajx.in/api/skill-tree?skills=Python:90,TypeScript:85,Next.js:80,AWS:70&metal=neon-blue&title=Tech+Stack&width=500)

GET/api/terminal

Fake terminal block with a title bar and command output lines. Great for showing setup commands or bio text.

Parameters

Param	Type	Default	Description
`lines`*	string	—	Pipe \| separated lines. Use colon syntax for prompt: cd ~/projects
`title`	string	terminal	Title bar text
`width`	number	500	Width in px

Example

![Terminal](https://readmeforge.natrajx.in/api/terminal?title=~/me&lines=whoami:+fullstack+dev|focus:+AI+%26+web|status:+building+cool+stuff&metal=matrix&width=500)

GET/api/social-links

Row of social platform link buttons. Supported platforms: github, twitter, linkedin, youtube, instagram, email, website, discord.

Parameters

Param	Type	Default	Description
`links`*	string	—	Comma-separated platform:handle pairs. E.g. github:@you,twitter:@you,linkedin:yourname
`style`	string	pills	pills \| icons \| minimal
`width`	number	600	Width in px

Example

![Social](https://readmeforge.natrajx.in/api/social-links?links=github:@yourname,twitter:@yourname,linkedin:yourname&metal=chrome&style=pills&width=600)

GET/api/logo-container

Metallic shaped container for a logo, avatar, or initials. 6 shapes available.

Parameters

Param	Type	Default	Description
`text`	string	MF	Initials/text to show if no src provided
`src`	string	—	Image URL for logo/avatar
`style`	string	hexagon	hexagon \| shield \| circle \| diamond \| star \| rounded-square
`size`	number	120	Size in px (width and height are equal)
`spin`	boolean	false	Slow rotation animation
`glow`	boolean	true	Glow filter effect

Example

![Logo](https://readmeforge.natrajx.in/api/logo-container?text=NX&metal=gold&style=hexagon&size=120&glow=true)

GET/api/image-container

Decorative metallic frame around any image. The image is fetched server-side and embedded as base64.

Parameters

Param	Type	Default	Description
`src`	string	—	Public image URL to embed inside the frame
`frame`	string	metallic	metallic \| glass \| polaroid \| circuit \| hologram \| neon-sign
`caption`	string	—	Caption text below the image
`rounded`	boolean	true	Rounded inner corners
`width`	number	300	Width in px
`height`	number	220	Height in px

Example

![Screenshot](https://readmeforge.natrajx.in/api/image-container?src=https://your-image.com/shot.png&metal=chrome&frame=metallic&caption=My+Project&width=400)

Response Format

// Success
HTTP 200
Content-Type: image/svg+xml; charset=utf-8
Cache-Control: public, max-age=86400
Access-Control-Allow-Origin: *

<svg xmlns="http://www.w3.org/2000/svg" width="800" height="160" ...>
  ...
</svg>

// Error
HTTP 400
<svg ...><text>Error: ...</text></svg>

API by

NATRAJ-X

AI & IT Engineering Agency — ML pipelines, data engineering, full-stack products.

Work with us →