Parameters Overview
A quick index of BrandQL query parameters and how to use them.
Parameters
Use query parameters to customize the logo you get back. Each parameter is optional.
Want code samples? See the language pages under Examples.
Variant
Dark, light, transparent, or SVG variants.
Size
Request exact pixel dimensions.
Format
Choose SVG, PNG, JPG, WebP, or AVIF.
Fallback
Control strict vs safe behavior.
Quick index
- Variant —
variant=dark,variant=light,variant=transparent,variant=svg - Size —
size=64 - Format —
format=svg,format=png,format=jpg,format=webp,format=avif - Fallback —
fallback=true|false - Defaults — what happens when you omit params
- Dark mode
- Light mode
- Transparent
Example
curl "https://api.brandql.com/logo/stripe.com?variant=dark&size=128&format=png&fallback=false"
Notes
- If you omit parameters, we return the best available logo with defaults. See Defaults.
- If you want strict behavior, set
fallback=false. See Fallback Parameter.
Related
Was this page helpful?