Skip to content

reymundvirtus/svg-icons-api

Repository files navigation

🎨 SVG Icons API

A simple and fast API for serving SVG icons tailored for light, dark, and neutral backgrounds. Built with FastAPI, this project allows you to request and embed SVG icons from a structured directory via clean URLs.


🚀 Features

  • ⚡ Blazing-fast icon serving with FastAPI
  • 🌓 Themed icon support for light and dark backgrounds
  • 🟢 Neutral icons that work on any background
  • 🖼 Easy to embed in Markdown, HTML, or frontend apps
  • 🔗 Public API endpoints — no auth required
  • 🛡 Licensed under MIT (open source and free to use)

📥 GET Icon by Theme

Parameter Type Example Description
theme string dark, light, neutral The visual theme of the icon
icon_name string github Name of the icon without .svg

✅ Examples

GET /icons/dark/spotify
GET /icons/light/astro
GET /icons/neutral/github

Returns: image/svg+xml

You can embed directly in HTML or Markdown:


🧑‍💻 Contributing

Want to add more icons? Awesome!

  • Fork this repo
  • Add SVG icons to the correct folder (dark/, light/, or neutral/)
  • Submit a PR

By contributing, you agree that the icons you submit are either:

  • Your original work
  • Licensed under an open source/public domain license (e.g. MIT, CC0)
  • Not restricted by copyright or trademark laws

See CONTRIBUTING.md for full guidelines.

Important

Before submitting an SVG icon, please ensure you have the legal right to do so.

✅ You must either:

  • Own the icon yourself,
  • Have explicit permission to use it, or
  • Confirm that it is licensed under an open license (e.g. MIT, CC0, Apache 2.0).

If you're unsure, please contact the company or the original author before uploading. Submitting copyrighted or trademarked material without proper permission may violate intellectual property laws.


License

This API Library is MIT licensed.

About

🧩✨ A FastAPI-powered service for serving open-source SVG icons, optimized for dark and light UI themes.

Topics

Resources

License

Contributing

Stars

Watchers

Forks