> ## 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.

# Parameters

> Detailed reference of all Logo API parameters

## URL Structure

Logo API uses a structured CDN URL format that allows you to retrieve and customize company logos using path and query parameters.

### Short Version

Use the short version when you only need the default logo for a brand.

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

### Full Version with All Parameters

Use the full version when you want to customize the logo size, theme, fallback, and logo type.

```html theme={null}
<img
  src="https://cdn.brandapi.io/nike.com/w/400/h/400/theme/dark/fallback/lettermark/type/icon?c=YOUR_CLIENT_ID"
  alt="Nike dark icon logo with lettermark fallback"
/>
```

To use Logo API, every request must include your Client ID.
To get your Client ID, register for free from the Developer Portal.

***

## identifier

**Type:** `string`
**Required:** Yes

The identifier is used to retrieve brand assets for a company, stock, fund, or crypto asset.
Accepted identifier formats include:

* **Domain**: `nike.com`
* **Brand ID**: `id_0dwKPKT`
* **ISIN**: `US6541061031`
* **Stock or ETF ticker**: `NKE`
* **Crypto symbol**: `BTC`, `ETH`

Uppercase is preferred for crypto symbols.

### Explicit Type Routes

To avoid naming collisions between identifier types, you can use explicit type routes.
Use this pattern:

```
{type}/{identifier}
```

Supported explicit routes include:

* `domain/nike.com` — Query by domain name.
* `ticker/NKE` — Query by Stock or ETF ticker.
* `isin/US6541061031` — Query by ISIN code.
* `crypto/BTC` — Query by crypto symbol.

### Identifier Example

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

If you omit the type prefix, for example using `nike.com` instead of `domain/nike.com`, Logo API will auto-detect the identifier type.
The detection order is:

* Domain → Stock or ETF ticker → ISIN → Crypto symbol

For more accurate results, explicit type routes are recommended, especially when identifiers may overlap.

***

## theme

**Type:** `enum<string>`

The theme parameter lets you request a logo version that works better on a specific background.
Available values:

* `light` — The light version of the logo
* `dark` — The dark version of the logo

### Example:

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

***

## fallback

**Type:** `enum<string>`

The fallback parameter controls what Logo API should return when a requested logo is not available.
Available values:

* `brandapi` — The Brand API default logo
* `transparent` — A transparent placeholder for custom background options
* `lettermark` — A square icon using the first letter of the brand name, only for `type=icon`
* `404` — Returns HTTP status 404 with a transparent placeholder

**Default**: Varies by logo type.

* `brandapi` for `icon`
* `transparent` for `logo` and `symbol`

### Example:

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

***

## h

**Type:** `number`

The `h` parameter controls the logo height.
The logo aspect ratio is always preserved, so the image will scale without distortion.

### Example:

```html theme={null}
<img
  src="https://cdn.brandapi.io/domain/nike.com/h/128/icon.png?c=YOUR_CLIENT_ID"
  alt="Nike logo with custom height"
/>
```

***

## w

**Type:** `number`

The `w` parameter controls the logo width.
The logo aspect ratio is always preserved, so the image remains clean and proportional.

### Example:

```html theme={null}
<img
  src="https://cdn.brandapi.io/domain/nike.com/w/128/icon.png?c=YOUR_CLIENT_ID"
  alt="Nike logo with custom width"
/>
```

***

## type

**Type:** `enum<string>`

The type parameter controls which logo style is returned.
Available values:

* `icon` — The default icon used on social profiles, such as a social media avatar
* `logo` — The horizontal brand logo, usually used on large surfaces
* `symbol` — The universal brand mark or symbol that represents the brand

### Example:

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