A
APIs Score

Readme typing SVG API

Beginner's Pick Photography / No Auth Required Beginner HTTPS
Free to Use
87 A
Metadata Score 0 50 100 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

The kind of data this API exposes, based on its documentation. We could not call the endpoint to confirm the exact field names.

image URLs in multiple sizes
photographer credit
image dimensions
download link
color data

Example Response

Illustrative shape only — we were not able to call this endpoint (it requires credentials or exposes no public sample URL), so the fields below show the kind of data this API returns rather than a recorded response.

JSON Response · Illustrative 
{
  "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

Calls a real endpoint of this API. Replace any placeholder credentials with your own key.

Request 
const url = "https://readme-typing-svg.demolab.com?font=Fira+Code&size=22&pause=1000&color=36BCF7&width=435&lines=Hello+World!";
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

Generated guidance based on this API's documentation, not observed by us. Treat it as a starting point and check against the provider's own error reference.

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? →

Technical Specifications

Auth No Auth
HTTPS REQUIRED
CORS UNKNOWN
Category Photography
Difficulty Beginner
Listing details not endpoint-verified

Related Tags

#photography

Similar APIs

View All →

Lorem Picsum

⭐ Beginner's Pick
76 B
Measured

Lorem Picsum provides free, beautiful placeholder images sourced from Unsplash with a simple URL-based API that requires no authentication.

No Auth Beginner HTTPS 295ms

PlaceKeanu

⭐ Beginner's Pick
87 A
Est.

PlaceKeanu is a fun, free placeholder image API that serves Keanu Reeves photos in any size you specify in the URL with no API key or sign-up needed.

No Auth Beginner HTTPS 115ms

ReSmush.it

⭐ Beginner's Pick
72 B
Est.

ReSmush.it is a free image optimization API that compresses photos to reduce file size without visibly losing quality.

No Auth Beginner 317ms

Screenshotlayer

⭐ Beginner's Pick
82 A
Est.

Screenshotlayer is a simple API that converts any URL into a screenshot image with a single HTTP request.

No Auth Beginner HTTPS 342ms

PhotoRoom

87 A
Est.

PhotoRoom API uses AI to remove backgrounds from product and portrait photos, producing clean PNG images with transparent backgrounds suitable for e-commerce and marketing.

API Key Intermediate HTTPS