Skip to content

Add crypto logos to your application by downloading from 9000+ logos using the website or through the API.

Notifications You must be signed in to change notification settings

tradeloop-ai/crypto-logos

Repository files navigation

About

An abstraction built from the actively maintained database of cryptocurrencies by CoinMarketCap. Add crypto logos to your application by downloading from 9000+ logos using Crypto Logos, or through the API.

Features

  • A collection of over 9000 cryptocurrencies and their logos in PNG format.
  • An easy-to-use and lightning fast API to get up-to-date logos in real-time.
  • Updated every Sunday at 5AM UTC through cron jobs /api/cron/CMC/route.ts.

API

  • Powered by Vercel Functions, Postgres, KV (and Blob soon).
  • No authentication or API keys, just a 30 reqs/min rate-limit based on IP.
    • Please open an issue to request an increase.
  • Support POST requests with parameters to customize logo output.
  • View the API Docs or try the API Playground for more info.

Future

  • SVG & JSX versions will be added progressively.
  • Docs on how to use SVGR.

Development

This is a Next.js project bootstrapped with create-next-app.

You will need a Postgres DB and Redis KV solution before being able to run dev server. It is highly recommended to use the Deploy to Vercel button below as it will walk you though setting these up.

If you do not want to use Vercel Postgres & Vercel KV, you can also bring your own solutions. A Postgres DB is required, but you can get rid of the KV as it is only used for rate-limiting. The two places where it used are in app/api/getLogos and app/api/getAllLogos.

Clone the repository, then add the following to your .env.local:

And run:

pnpm dev

If this is your first time running dev server or deployment, visit http://localhost:3000/api/cron/cmc to trigger data retrieval from CMC

Then visit http://localhost:3000 see the result.

Deploy on Vercel

Deploy with Vercel

The easiest way to deploy this app is to use the Vercel Deploy button above.

  • You will need to obtain a CMC Pro API Key.
  • Once your application is deployed, visit /api/cron/cmc to trigger data retrieval from CMC.
    • This is only required for your first deployment.
  • And you're good to go!

About

Add crypto logos to your application by downloading from 9000+ logos using the website or through the API.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published