Shortcut fields
logos and images list every logo and image Brandfetch holds for a brand, in each theme and format. Most integrations show one image of each kind. Every Brand API response carries four shortcut fields for that: logo, symbol, icon and banner.
Each shortcut field picks the best match of its kind from logos or images. It holds that image’s address, or null when the brand has no image of that kind.
Use a shortcut field when you need one image of a kind. Use
logos and images when you need every theme, format or variant.
Fetch each address as it is given. Its c parameter is a client ID signed for your API key. The client ID is required, and a request without it is refused. Its t parameter changes when the image does, so you can tell when a stored copy is out of date, and like the rest of the response you can keep the image for up to 30 days, as Caching explains. The image does not count towards your quota. It works in an <img> tag, from a browser, or from your server.
- The address of a logo or symbol names its theme.
theme/darkis a dark image, for light backgrounds.theme/lightis a light image, for dark backgrounds. - If an image is gone when you fetch it,
logo,symbolandbannerreturn404.iconreturns a lettermark instead: the brand’s initial on a plain square. - All four shortcut fields are
nullfor brands withisNsfw: true.
Homepage screenshot
A brand kit tells you the brand’s logos, colors and fonts. It does not show how the brand puts them together. A screenshot of the homepage does: the layout, the illustration style, the spacing, the tone of the imagery. When you generate designs or content for a brand, give the screenshot to your model next to the brand data. Every Brand API response carries ascreenshot object with the address of the image and when Brandfetch took it:
url as it is given: the c parameter is a client ID signed for your API key, and the image does not count towards your quota. It works in an <img> tag, from a browser, or from your server. A request that drops the client ID is refused. The address returns a PNG of the top of the homepage at a desktop viewport, as Brandfetch saw it on its last visit. It is not a full-page capture. t is the time of capture: the address changes when Brandfetch takes a new screenshot, and like the rest of the response you can keep the image for up to 30 days, as Caching explains.
screenshotisnullwhen Brandfetch holds no screenshot of the homepage yet. A held brand gets one on its next visit. It is alsonullfor brands withisNsfw: true.- The screenshot is what the crawler saw. For some sites that is a cookie banner, a blank page that had not finished loading, or a bot-protection page. Check the image before you rely on it.