Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.brandsapi.com/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Get your API Key

To start using BrandsAPI, you’ll need an API key. You can get one for free by signing up on our Dashboard.

​
2. Install the SDK

If you’re using JavaScript or TypeScript, we recommend using our official SDK for the best experience. 
npm install brandsapi-sdk

​
3. Make your first call

Use the SDK to fetch data for any domain. Here’s a quick example fetching Stripe’s brand data: 
import { BrandsAPI } from 'brandsapi-sdk';

const brandsapi = new BrandsAPI('YOUR_API_KEY');

const brand = await brandsapi.getBrand('stripe.com');

console.log(brand.name); // "Stripe"
console.log(brand.colors[0].hex); // "#635BFF"

​
4. Using the REST API

If you’re not using JavaScript, you can make a direct HTTP request to our API. 
curl https://api.brandsapi.com/v1/brand/stripe.com \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Next Steps

Now that you’ve made your first call, dive deeper into the documentation:

API Reference

Explore all available endpoints and parameters.

SDK Guides

Learn how to use our SDK in your favorite framework.