Website brand
The logo, icon, brand colors, fonts, description and social profiles of a company, read from its website.
GET/v1/web/brand
Costs 1 credit per request. Only requests that return data are charged.
Parameters
| Name | Type | Description |
|---|---|---|
urlrequired |
string | Website address or bare domain, such as stripe.com. The site at that host is read; a path is ignored. |
Example request
curl "https://pipefetch.com/v1/web/brand?url=stripe.com" \
-H "x-api-key: YOUR_API_KEY"const res = await fetch('https://pipefetch.com/v1/web/brand?url=stripe.com', {
headers: { 'x-api-key': process.env.PIPEFETCH_API_KEY },
});
const { data, credits } = await res.json();import os, requests
res = requests.get(
"https://pipefetch.com/v1/web/brand",
params={"url": "stripe.com"},
headers={"x-api-key": os.environ["PIPEFETCH_API_KEY"]},
)
data = res.json()["data"]Example response
A real answer to the request above. Long texts and lists are shortened here.
{
"data": {
"url": "https://stripe.com",
"domain": "stripe.com",
"name": "Stripe",
"title": "Stripe | Financial Infrastructure to Grow Your Revenue",
"description": "Stripe is a financial services platform that helps all types of businesses accept payments, build flexible billing models, and manage money movement.",
"logo": {
"url": "https://images.stripeassets.com/fzn2n1nzq965/1hgcBNd12BfT9VLgbId7By/01d91920114b124fb4cf6d448f9f06eb/favicon.svg",
"format": "svg",
"source": "structured-data"
},
"icon": "https://images.stripeassets.com/fzn2n1nzq965/4vVgZi0ZMoEzOhkcv7EVwK/8cce6fdcf2733b2ec8e99548908847ed/favicon.png?w=180&h=180",
"icons": [
"https://images.stripeassets.com/fzn2n1nzq965/4vVgZi0ZMoEzOhkcv7EVwK/8cce6fdcf2733b2ec8e99548908847ed/favicon.png?w=180&h=180",
"https://images.stripeassets.com/fzn2n1nzq965/4vVgZi0ZMoEzOhkcv7EVwK/8cce6fdcf2733b2ec8e99548908847ed/favicon.png?w=96&h=96"
],
"image": "https://b.stripecdn.com/mkt-ssr-statics/assets/_next/static/media/stripe.37119086.jpg",
"colors": {
"primary": {
"hex": "#533afd",
"rgb": "rgb(83, 58, 253)"
},
"secondary": {
"hex": "#bdb4ff",
"rgb": "rgb(189, 180, 255)"
},
"theme": null
},
"fonts": [
{
"family": "Sohne-Var",
"source": "stylesheet"
},
{
"family": "Sourcecodepro",
"source": "stylesheet"
}
],
"socials": [
{
"platform": "github",
"url": "https://github.com/stripe"
}
],
"twitterHandle": "@stripe",
"images": [
"https://b.stripecdn.com/mkt-ssr-statics/assets/_next/static/media/wave-fallback-desktop-1x.fba6fa88.webp",
"https://images.stripeassets.com/fzn2n1nzq965/vYmk6v8n7oDAwbDpwhjV6/846f9b3e214549b8f14e2b8c8cfe9343/payment-bento-background.jpg?w=860&q=80"
]
},
"credits": {
"used": 1,
"remaining": 99
}
}Good to know
- The logo is the one the site states in its structured data, or else the image in its header or home link. logo.source tells you which. A row of customer logos is never mistaken for it.
- A logo drawn as inline SVG comes back as a data: URI, which works wherever an image address does. logo is null when a site draws its logo with CSS only; icon is then the mark to use.
- Colors and fonts are counted in the CSS the home page loads, so they are what the site uses most.
- A website that does not exist or does not answer within 15 seconds answers 404 website_unreachable and costs nothing.
Errors
Every error has the same shape, and none of them is charged. The full list is in the error reference.
Looking for an overview and use cases? See the Brand API page.