diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..296da36 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Logo.dev + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 899cffb..f73f703 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,224 @@ +
+ +# Logo.dev + +### Every company logo, one API request + +**The highest-quality logo and brand API.** Pass a domain, ticker, or crypto symbol — get back a clean, correctly-sized logo, served from a global CDN. No sourcing, no hosting, no broken images. + +[![Website](https://img.shields.io/badge/Website-logo.dev-18181B?style=flat-square)](https://www.logo.dev) +[![Documentation](https://img.shields.io/badge/Docs-docs.logo.dev-18181B?style=flat-square)](https://docs.logo.dev) +[![Get an API key](https://img.shields.io/badge/Get%20an%20API%20key-free-18181B?style=flat-square)](https://www.logo.dev/signup) +[![License: MIT](https://img.shields.io/badge/License-MIT-18181B?style=flat-square)](LICENSE) + +**50M+ companies** · **30M+ requests/day** · **55K+ developers** · **<50ms median** · **150+ edge locations** · **500K free/mo** + +
+ +--- + +## One `` tag, any logo + +There's no SDK to install and no logo files to host. Get your free [publishable key](https://www.logo.dev/dashboard), then hotlink the CDN: + +```html +Stripe logo +``` + +That's the whole integration. Swap `stripe.com` for any domain and you get a crisp, correctly-sized logo back in milliseconds. + + + +--- + +## Why logo.dev + +- **No infrastructure.** No scraping, storing, resizing, or cache-busting. A URL is the integration. +- **One tag, every framework.** It's just an image — drop it into HTML, React, Vue, iOS, Android, or a spreadsheet. +- **Built for production.** A global CDN with a `<50ms` median response across `150+` edge locations. +- **Always current.** `50M+` companies, updated daily — no stale or broken logos. +- **Flexible output.** Size, retina, format (`PNG`/`WebP`), and light/dark `theme` variants via query params. +- **More than logos.** Resolve companies by stock ticker or crypto symbol, search brands by name, or pull structured brand data. + +--- + +## Endpoints + +Every logo is a `GET` against `img.logo.dev`. The REST endpoints return structured brand data. + +| Lookup | Example | Docs | +| --- | --- | --- | +| **By domain** | `img.logo.dev/stripe.com` | [Logo images →](https://docs.logo.dev/logo-images/introduction) | +| **By stock ticker** | `img.logo.dev/ticker/AAPL` | [Ticker →](https://docs.logo.dev/logo-images/ticker) | +| **By crypto symbol** | `img.logo.dev/crypto/BTC` | [Crypto →](https://docs.logo.dev/logo-images/crypto) | +| **By company name** | `img.logo.dev/name/stripe` | [Name →](https://docs.logo.dev/logo-images/name) | +| **Brand Search** | Find a company when you only have a name | [Brand Search →](https://docs.logo.dev/brand-search/introduction) | +| **Describe** | Colors, socials, and structured brand fields | [Describe →](https://docs.logo.dev/describe/introduction) | + +Common parameters: `token` (required), `size`, `retina`, `format`, `theme`. Full reference at [docs.logo.dev](https://docs.logo.dev). + +--- + +## Quickstart + +Lead with HTML, then reach for your stack. Every snippet uses the same CDN URL — only the wrapper changes. + +```html + +Stripe logo +``` + +```jsx +// React — works with any bundler; in Next.js, read the token from +// process.env.NEXT_PUBLIC_LOGO_DEV_PUBLISHABLE_KEY instead +const LOGO_DEV_TOKEN = "LOGO_DEV_PUBLISHABLE_KEY"; + +function CompanyLogo({ domain }) { + return ( + {`${domain} + ); +} +``` + +```bash +# cURL +curl "https://img.logo.dev/stripe.com?token=LOGO_DEV_PUBLISHABLE_KEY&size=128&format=png" --output stripe.png +``` + +```python +# Python +import requests + +def get_company_logo(domain: str) -> bytes: + url = f"https://img.logo.dev/{domain}?token=LOGO_DEV_PUBLISHABLE_KEY" + return requests.get(url).content +``` + +
+More languages — Next.js, Vue, Ruby, PHP, Swift (iOS), Kotlin (Android), Google Sheets & Excel + +
+ +Full, copy-paste-ready snippets for every stack live in the docs: **[docs.logo.dev →](https://docs.logo.dev)** + +- **Next.js** — `next/image` with `img.logo.dev` allowlisted in `remotePatterns` +- **Vue** — bind the URL to `:src` +- **Ruby** — `Net::HTTP.get` +- **PHP** — `file_get_contents` +- **Swift (iOS)** — `AsyncImage` +- **Android (Kotlin)** — Coil or Picasso +- **Google Sheets / Excel** — `=IMAGE("https://img.logo.dev/" & A1 & "?token=LOGO_DEV_PUBLISHABLE_KEY")` + +
+ +--- + +## Migrating from Clearbit + +**Clearbit's Logo API shut down on December 8, 2025.** If your app still points at `logo.clearbit.com`, the logos are broken. + +**We're the same team that originally built the Clearbit Logo API**, and logo.dev is the migration path recommended by Clearbit / HubSpot. It's a drop-in replacement — swap the base URL and add a token. Your existing parameters keep working. + +```diff +- https://logo.clearbit.com/stripe.com ++ https://img.logo.dev/stripe.com?token=LOGO_DEV_PUBLISHABLE_KEY +``` + +Most migrations take a few minutes. Full guide: **[Migrating from Clearbit →](https://docs.logo.dev/migrations/clearbit)** + +> "We built logo enrichment at Clearbit because developers needed it. Logo.dev is what I wish we could have built. Comprehensive, fast, and they actually keep the logos updated. Clear upgrade." +> +> — **Alex MacCaw**, Founder, Clearbit + +--- + +## Trusted by developers + +`55K+` developers build on logo.dev — from CRMs and fintech dashboards to AI products. + + + +--- + +## Use logo.dev logos in your own README or site + +Because every logo is just an `` URL, you can render any company's logo directly in your Markdown, docs, or app: + +```html +GitHub +``` + +On the **free plan, commercial use requires a visible link back**; personal projects don't. Add this wherever you display logos: + +```html +Logos provided by Logo.dev +``` + +Prefer a badge? Drop in [`assets/powered-by-logo-dev.svg`](assets/powered-by-logo-dev.svg): + +[Powered by Logo.dev](https://logo.dev) + +```html + +Powered by Logo.dev +``` + +Full rules and placement guidance: **[Attribution →](https://docs.logo.dev/platform/attribution)** + +--- + +## FAQ + +**Is it really free?** +Yes — `500K` requests/month on the free tier. Commercial use on the free plan needs attribution; paid plans remove it. See [pricing](https://www.logo.dev/pricing). + +**Do I need attribution?** +Only for commercial use on the free plan. Personal projects don't. Details and edge cases: [Attribution](https://docs.logo.dev/platform/attribution). + +**I'm coming from Clearbit — what changes?** +Swap the base URL and add a `token`. Your parameters carry over. See the [Clearbit migration guide](https://docs.logo.dev/migrations/clearbit). + +**What formats and sizes are supported?** +`PNG` and `WebP`, with `size`, `retina`, and light/dark `theme` options. See the [logo image docs](https://docs.logo.dev/logo-images/introduction). + +**What happens when a logo isn't found?** +You get a monogram fallback by default, or request a `404` to handle fallbacks yourself. + +--- -## Work-in-progress +## Resources -> We're working every day to improve functionality of our APIs and our data quality. Currently, we are prioritizing customer requests for new features and expanding our data set to include logo SVGs. +- 📚 **[Documentation](https://docs.logo.dev)** — full API reference and guides +- 🔑 **[Get an API key](https://www.logo.dev/signup)** — free, no credit card +- 💳 **[Pricing](https://www.logo.dev/pricing)** — free tier and paid plans +- 🖥️ **[Dashboard](https://www.logo.dev/dashboard)** — manage keys and usage +- 🐛 **[Report an issue](https://github.com/logo-dev/logo-api/issues)** — bugs, incorrect logos, or feature requests -## Getting started +## Contributing -Our logo image API is free to use with registration. Get your API token at [Logo.dev](https://www.logo.dev). You can find all of our developer documentation here: https://docs.logo.dev +Found an incorrect logo, hit a problem, or have a feature request? [Open an issue](https://github.com/logo-dev/logo-api/issues) — we triage them actively, and most logo corrections ship within 24 hours. -## Find an issue? +## License -Having any probelms with our APIs, find an incorrect logo, or have a feature request? Let us know by filing an issue against this repo here: https://github.com/logo-dev/logo-api/issues +[MIT](LICENSE) © Logo.dev diff --git a/assets/powered-by-logo-dev.svg b/assets/powered-by-logo-dev.svg new file mode 100644 index 0000000..208150c --- /dev/null +++ b/assets/powered-by-logo-dev.svg @@ -0,0 +1,9 @@ + + Powered by Logo.dev + + + + + + Powered by Logo.dev +