Quickstart Guide
Get up and running with BrandQL in minutes by making your first API request to fetch a logo without any setup hassle.
curl "https://api.brandql.com/logo/paypal.com?api_key=YOUR_API_KEY"
const response = await fetch(
"https://api.brandql.com/logo/paypal.com?api_key=YOUR_API_KEY"
);
const data = await response.json();
console.log(data.logo); // URL to the logo image
import requests
response = requests.get(
"https://api.brandql.com/logo/paypal.com",
params={"api_key": "YOUR_API_KEY"}
)
data = response.json()
print(data["logo"])
{
"domain": "paypal.com",
"logo": "https://cdn.brandql.com/logos/paypal.com/128x128.png",
"size": "128x128",
"format": "png",
"cached": true
}
- A free BrandQL account (sign up at https://brandql.com/signup)
- Your API key (found in the dashboard at https://dashboard.brandql.com)
- curl, Postman, or a tool like JavaScript fetch for testing
Get Started in 3 Steps
Follow these steps to fetch your first company logo from any domain.
Sign Up and Get Your API Key
Create a free account to access the generous free tier.
- Visit https://brandql.com/signup
- Complete the signup form
- Navigate to your dashboard at https://dashboard.brandql.com/api-keys
- Copy your API key (it looks like
brql_xxxxxxxxxxxx)
Store your API key securely. Use environment variables in production: BRANDQL_API_KEY.
Make Your First API Request
Fetch a logo for paypal.com using the simple GET endpoint.
Use the {domain} path parameter and your API key as a query parameter.
Replace YOUR_API_KEY with your actual key.
View the Response and Logo
The API returns JSON with the logo details. Use the logo URL to display the image.
Test in your browser: Visit the logo URL directly (e.g., https://cdn.brandql.com/logos/paypal.com/128x128.png).
Success! You've fetched a logo in <100ms. BrandQL handles just-in-time fetching for uncached domains.
Test with Different Tools
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.brandql.com/logo/google.com?size=64"
Create a new GET request:
| Field | Value |
|---|---|
| URL | https://api.brandql.com/logo/netflix.com |
| Query Params | api_key: YOUR_API_KEY |
| Headers | None required |
Click Send and check the response body for the logo URL.
Open your browser console:
fetch('https://api.brandql.com/logo/apple.com?api_key=YOUR_API_KEY')
.then(r => r.json())
.then(data => {
const img = document.createElement('img');
img.src = data.logo;
document.body.appendChild(img);
});
API Parameters
The company domain (e.g., paypal.com, newstartup.io). BrandQL fetches uncached logos on-demand.
Your BrandQL API key.
Logo size (e.g., 64x64, 128x128, 256x256). Default: 128x128.
Next Steps
Full API Reference
Explore all endpoints and parameters.
React SDK
Integrate with React components.
Error Handling
Handle rate limits and failures.
Head to the dashboard to monitor usage and upgrade your plan for higher limits.