We set up our Logo API to be able as easy as possible to test and deploy.

In this guide, we will give an overview of how the API can be used to make the simplest requests and go live on your website.

An important thing to note is that while our API can be used without an API key or any authentication, you will very quickly run into rate limits.

​
Testing locally

The most simple way to test is to add an image anywhere in your HTML.

<img src="https://img.logo.dev/sweetgreen.com?token=YOUR-KEY-HERE" />

https://img.logo.dev/sweetgreen.com

​
Getting an API key

You’ll be required to add an ?token= parameter with an API key to do any serious querying of logos.

Need an API key? Sign up for a free account

By signing up for a free account and registering your site, you’ll have enough requests to manage most projects.

You can use parameters to add your API key and to return different sizes, file types, and effects.

While you are testing, most calls to the Logo API will look like this.

<img
  src="https://img.logo.dev/microsoft.com?token=YOUR-KEY-HERE&size=200&format=png"
/>

https://img.logo.dev/microsoft.com?token=YOUR-KEY-HERE&size=200&format=png

​
Test without code

If you’re looking to test our data quality with no code, we’ve found the best way is to add domains to a Google Sheet and run this formula.

Here’s a link to a Sheets template you can use. You can modify the API’s parameters and add your own key using the formula provided below.

=IMAGE(Concat(CONCAT("https://img.logo.dev/", $A3), "?format=png"))

​
Rate-limiting

When calling images without an API key, you will quickly hit rate limits. We allow unauthenticated calls for testing purposes only.

If you’re asking why letters only being returned and not the logos, it’s because you’ve hit the rate limits.

In order to avoid the limits, you’ll need an API key or to upgrade your account.

​
Attribution requirement

Before deploying, you are required on any page you use the Logo API to link back to logo.dev. Attribution links should be legible and indexable.

Here’s an example attribution link to use.

<a href="https://logo.dev" alt="Logo API">Logos provided by Logo.dev</a>

​
Deploying

Before going to production, be absolutely sure to add an API key. Each account has an API key and can whitelist websites that are authorized to use that key.

You’ll also need to make sure you have proper attribution when using a free account.

When you’re satisfied with how your logos look by modifying parameters and adding your CSS, deploy however you see fit.

Having any issues while testing? Contact us for help getting started.

Migrating from Clearbit