CHchannel3-ai
v1

Search Websites

Changed on

Search websites by retailer name or domain, optionally within categories.

Category filtering matches within each category's top 1,000 websites.

get/v1/websites/search

Request

  • Base URL
    https://api.trychannel3.com
  • URL
    https://api.trychannel3.com/v1/websites/search
  • Auth
    API key in header x-api-key

Query parameters

querystring required

Free-text query (e.g. 'Nordstrom', 'nike.com').

limitinteger

Maximum number of websites to return.

category_idsstring[] nullable

If provided, only websites selling in these categories will be matched. Accepts category slugs. Categories that do not exist, or that are not available for search, are rejected with a 422.

country'US' | 'GB' | 'EU' | 'AU' | 'CA' | 'IE' | 'DE' | 'AT' | 'FR' | 'BE' | 'IT' | 'ES' | 'NL' | 'SE' | 'FI' | 'PT' | 'CZ' | 'GR' | 'RO' | 'CH' | 'PL'

ISO 3166-1 alpha-2 country code (plus the pan-region EU).

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

Response

Successful Response

Changes

  • fbe04bdb7b70Revision changes
    • info

      added the optional property // to the response with the status

  • f642382eaf91Revision changes
    • info

      added the enum value PL to the property anyOf[subschema #1: CountryCode]/ of the query request parameter country