Readme typing SVG API

Beginner's Pick Photography / No Auth Required Beginner HTTPS

Free to Use Varies (check documentation)

87 A

Metadata Score Metadata estimate · not endpoint-tested

Visit Official Site Compare Alternatives

Overview

Readme Typing SVG generates animated SVG images that display a customizable typing-and-deleting text animation, commonly used in GitHub profile READMEs to add a dynamic introduction. You configure the text, font size, color, speed, and more via URL query parameters with no API key required. Just paste the generated URL into your Markdown file and the animation appears automatically.

Beginner Tip

Use the hosted demo at https://readme-typing-svg.demolab.com/demo/ to build your animation URL visually by filling out a form, then copy the generated Markdown or URL into your README. Multiple lines of text are passed as separate lines[] parameters in the URL.

Available Data

image URLs in multiple sizes

photographer credit

image dimensions

download link

color data

Example Response

JSON Response

{
  "id": "Dwu85P9SOIk",
  "urls": {
    "full": "https://images.unsplash.com/photo-...",
    "regular": "https://images.unsplash.com/photo-...?w=1080",
    "thumb": "https://images.unsplash.com/photo-...?w=200"
  },
  "width": 4000,
  "height": 3000,
  "user": {
    "name": "John Doe",
    "username": "johndoe"
  }
}

Field Reference

(SVG document) The entire response is an SVG XML document containing the animation; embed it via an img tag or inline SVG in your Markdown or HTML.

Implementation Example

Request

const url = "https://github.com/DenverCoder1/readme-typing-svg";
const response = await fetch(url);
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

SVG not rendering on GitHub GitHub caches images aggressively, so changes to the URL parameters may not appear immediately.

✓ GitHub may take a few minutes to refresh the cached SVG; try adding a dummy parameter like &v=2 to bust the cache.

Text getting cut off The width parameter is too small for the text content.

✓ Increase the width parameter (default is 435); use the demo tool to preview and adjust until all text fits within the SVG boundary.

Colors not applying correctly Color values with hash symbols are not URL-encoded in the query string.

✓ Encode # as %23 in the URL (e.g., color=%23FF5733 instead of color=#FF5733) or use named colors supported by SVG.

Metadata Score Breakdown

Estimated from metadata — endpoint not independently tested

This score is estimated from observable metadata — HTTPS support, authentication model, declared CORS, and documentation reachability — because the API requires authentication or exposes no publicly testable endpoint. The five-signal breakdown is only shown for live-tested APIs.

Metadata estimate · endpoint not independently tested

How is this scored? →