> ## Documentation Index
> Fetch the complete documentation index at: https://devshine-cbff6863.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Instantly add any company logos to your app or website

# Logo API

## Overview

Instantly Add Company Logos to Your App or Website

Logo API gives you a simple CDN-based way to add any company logo to your app, website, dashboard, or product interface.

With one embeddable image URL, you can access a brand’s latest logo and keep it automatically up to date. Logo API is customizable, supports powerful logo transformation options, and can be used directly inside your HTML image tags.

## Implementation Guide

Logo API is free to use. Before deploying your application to production, review the rate limits and usage guidelines to ensure a smooth launch.

### 1. Embed Your Logo

To embed a company logo, add an `img` tag with the Logo API CDN URL as the `src` attribute.

```html theme={null}
<img
  src="https://cdn.brandapi.io/nike.com?c=YOUR_CLIENT_ID"
  alt="Nike logo powered by Logo API"
/>
```

You can also use explicit type routes to avoid naming collisions between different identifier types.

Supported type routes include:

* `domain/`
* `ticker/`
* `isin/`
* `crypto/`

Without a type prefix, Logo API automatically detects the identifier type in this order:

* `domain` → `ticker` → `isin` → `crypto`

### 2. Register an Account and Get Your Client ID

Logo API is free to use and does not require attribution.

Each request must include your unique Client ID. This helps keep usage within fair limits and ensures logos continue to render reliably.

To get your Client ID, register for free from the Developer Portal.

### 3. Implement Additional Features

Beyond basic logo embedding, Logo API includes flexible features to improve logo delivery and presentation across your website or application.

* **Logo Types**: Access different logo formats, including brand icons, symbols, and main logos.
* **Theme Variants**: Use dark or light logo variants so each company logo looks clear on different background colors.
* **Customizable Sizing**: Control logo width and height to match your UI requirements.
* **Smart Fallbacks**: Show fallback logo styles when a brand logo is not available.
* **Search by Stock or ETF Ticker**: Query logos directly using a Stock or ETF ticker, such as `NKE` or `QQQ`.
* **Search by ISIN**: Query logos directly using an ISIN, such as `US6541061031`.
* **Search by Crypto Symbol**: Query logos directly using a crypto symbol, such as `BTC` or `ETH`.

Explore these options in the Logo API parameters page.

## Default Icon

Get a brand’s default logo icon using the standard CDN URL.

```html theme={null}
<img
  src="https://cdn.brandapi.io/nike.com?c=YOUR_CLIENT_ID"
  alt="Nike default brand logo icon"
/>
```

## PNG or JPG Instead of WebP

By default, Logo API serves logos in the modern and efficient WebP format.

You can request other formats by specifying the file extension in the URL. The logo and symbol variants also support SVG format.

```html theme={null}
<img
  src="https://cdn.brandapi.io/:domain/icon.png?c=YOUR_CLIENT_ID"
  alt="Company logo in PNG format"
/>
```

## Logo Sizing and Retina Support

Customize logo dimensions by adding width and height parameters to the URL.

Use:

* `w` for width
* `h` for height

The logo aspect ratio is always preserved.

For Retina displays, use double-size values for sharper rendering. For example, if your UI displays a 64x64 icon, request a 128x128 logo.

```html theme={null}
<img
  src="https://cdn.brandapi.io/:domain/h/128/w/128/icon.png?c=YOUR_CLIENT_ID"
  alt="High-resolution company logo for Retina displays"
/>
```

## Type Variants

Request different logo types by using the type path parameter.

Available logo variants include:

* `icon`
* `symbol`
* `logo`

```html theme={null}
<img
  src="https://cdn.brandapi.io/:domain/symbol?c=YOUR_CLIENT_ID"
  alt="Company brand symbol from Logo API"
/>
```

## Dark and Light Themes

Use theme variants to make sure logos look clear on different backgrounds.

For example, you can request a light logo variant for dark interface sections.

```html theme={null}
<img
  src="https://cdn.brandapi.io/:domain/theme/light/logo?c=YOUR_CLIENT_ID"
  alt="Light company logo for dark background"
/>
```

## Multiple Fallbacks

Specify a fallback option to display when a logo is not available.

Fallbacks help keep your UI complete, even when a specific brand asset cannot be found.

```html theme={null}
<img
  src="https://cdn.brandapi.io/:domain/fallback/lettermark/icon?c=YOUR_CLIENT_ID"
  alt="Fallback lettermark logo for company"
/>
```

## Explore More Options

Explore additional customization options in the Logo API parameters page.