Skip to navigation
API ReferenceWebsites

Websites

Resolve a website URL to its ID and best_commission_rate. Tip: website_ids filters accept domains directly, so this lookup is most useful for retrieving commission rates.

Authentication

x-api-keystring
API Key authentication via header

Headers

X-Channel3-LanguagestringOptional
X-Channel3-CountrystringOptional
X-Channel3-CurrencystringOptional
X-Channel3-Length-UnitstringOptional
X-Channel3-Weight-UnitstringOptional

Query parameters

querystringRequired
countryenum or nullOptional

ISO 3166-1 alpha-2 country code that best_commission_rate is scoped to. Defaults to 'US' when unset.

Response

Successful Response
idstring
urlstring
namestring or nullOptional
logo_urlstring or nullOptional
descriptionstring or nullOptional
best_commission_ratedoubleOptionalDefaults to 0

The maximum commission rate for the website in the requested country (default 'US'), as a percentage

Errors

401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error