Skip to content

Custom Headers

yan edited this page Nov 16, 2020 · 32 revisions

Why use custom headers?

Brave has reached the size where we would like to add brave to the User-Agent string. However, in testing this, we found that many sites don't work correctly with this UA.

We added a JS API to allow sites to detect brave. Unfortunately this doesn't work for Brave's partners who require the ability to detect the UA in an HTTP header.

In all cases, the header is the same for all users of Brave Desktop and therefore cannot be used to distinguish users.

X-Brave-Partner

Site Header Reason
Brave X-Brave-Access-Key: key Show subscription page for Dow Jones Media Group.
cheddar.com X-Brave-Partner: cheddar To provide free subscriptions to Brave users.
coinbase.com X-Brave-Partner: coinbase For detection of using Brave for the Earn BAT campaign.
marketwatch.com & barrons.com X-Brave-Partner: dowjones To provide free subscriptions to Brave users.
townsquare.com & related sites X-Brave-Partner: townsquare Offer to users that are not in Brave to download Brave.
softonic.com X-Brave-Partner: softonic Avoid showing download Brave promotions to Brave users.
upbit.com and upbit subdomains X-Brave-Partner: upbit For detection of using Brave for co-marketing.
uphold.com X-Brave-Partner: uphold Shows different UI to Brave users for payments as a publisher.
eaff.com & subdomains X-Brave-Partner: eaff Custom content for Brave users.

Yandex CLID

If Yandex is the default search engine, we add a clid parameter to search requests to indicate that they are coming from Brave. Our clid is assigned by Yandex, so it looks like a random number but is actually the same for all users on a platform. On Android, you would see 2423859 in the URL and on desktop you would see 2353835.

Clone this wiki locally