JavaScript SDK

Build faster with the official BrandsAPI JavaScript/TypeScript SDK.

Installation

Install the SDK using your favorite package manager:

npm

npm install brandsapi-sdk

Initialization

Import and initialize the client with your API key.

import { BrandsAPI } from 'brandsapi-sdk';

const brandsapi = new BrandsAPI('YOUR_API_KEY');

Methods

getBrand(domain: string)

Fetches all brand data for the given domain.

const brand = await brandsapi.getBrand('linear.app');

getLogo(domain: string, options?: LogoOptions)

Helper method to get just the logo URL.

const logoUrl = await brandsapi.getLogo('openai.com', {
  theme: 'dark',
  format: 'svg'
});

TypeScript Support

The SDK is written in TypeScript and provides full type definitions for all brand data attributes.

import { BrandData } from 'brandsapi-sdk';

const brand: BrandData = await brandsapi.getBrand('apple.com');