> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trychannel3.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Websites

> Paginated list of websites, capped at the top 5,000.

With `category_ids`, lists the websites selling those categories — best
first, each category contributing at most its top 1,000.



## OpenAPI

````yaml get /v1/websites
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.trychannel3.com
    description: Production
security: []
paths:
  /v1/websites:
    get:
      tags:
        - v1
      summary: List Websites
      description: |-
        Paginated list of websites, capped at the top 5,000.

        With `category_ids`, lists the websites selling those categories — best
        first, each category contributing at most its top 1,000.
      operationId: list_websites_public_v1_websites_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Max items per page (1-100).
            default: 20
            title: Limit
          description: Max items per page (1-100).
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Pagination cursor returned by a prior call. Omit for the first
              page.
            title: Cursor
          description: Pagination cursor returned by a prior call. Omit for the first page.
        - name: category_ids
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: >-
              If provided, only websites selling in these categories will be
              returned. Accepts category slugs. Categories that do not exist, or
              that are not available for search, are rejected with a 422.
            title: Category Ids
          description: >-
            If provided, only websites selling in these categories will be
            returned. Accepts category slugs. Categories that do not exist, or
            that are not available for search, are rejected with a 422.
        - name: country
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/CountryCode'
              - type: 'null'
            description: >-
              ISO 3166-1 alpha-2 country code that `best_commission_rate` is
              scoped to. Defaults to 'US' when unset.
            title: Country
          description: >-
            ISO 3166-1 alpha-2 country code that `best_commission_rate` is
            scoped to. Defaults to 'US' when unset.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedListWebsitesResponse'
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              examples:
                missing_key:
                  summary: Missing API Key
                  value:
                    detail: >-
                      Unauthorized. Missing authentication key. Make sure to
                      attach an x-api-key with your request. Need help? Reach
                      out to support@trychannel3.com.
                invalid_key:
                  summary: Invalid API Key
                  value:
                    detail: >-
                      API key was provided but is invalid. Need help? Reach out
                      to support@trychannel3.com.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment required
          content:
            application/json:
              examples:
                credits_exhausted:
                  summary: API key out of credits
                  value:
                    detail: >-
                      You have used all of your free credits. Add a payment
                      method to continue.
                mpp_challenge:
                  summary: MPP Tempo payment required
                  value:
                    detail: >-
                      Payment required. Satisfy the MPP Tempo challenge in
                      WWW-Authenticate.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail:
                  - loc:
                      - body
                      - query
                    msg: field required
                    type: value_error.missing
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail: Internal Server Error
      security:
        - APIKeyHeader: []
components:
  schemas:
    CountryCode:
      type: string
      enum:
        - US
        - GB
        - EU
        - AU
        - CA
        - IE
        - DE
        - AT
        - FR
        - BE
        - IT
        - ES
        - NL
        - SE
        - FI
        - PT
        - CZ
        - GR
        - RO
      title: CountryCode
      description: ISO 3166-1 alpha-2 country code (plus the pan-region ``EU``).
    PaginatedListWebsitesResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Website'
          type: array
          title: Items
          description: List of websites
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Cursor to fetch the next page of results. Null if no more results.
      type: object
      required:
        - items
      title: PaginatedListWebsitesResponse
    ErrorResponse:
      properties:
        detail:
          anyOf:
            - type: string
            - items:
                additionalProperties: true
                type: object
              type: array
          title: Detail
      type: object
      required:
        - detail
      title: ErrorResponse
    Website:
      properties:
        id:
          type: string
          title: Id
        url:
          type: string
          title: Url
        best_commission_rate:
          type: number
          title: Best Commission Rate
          description: >-
            The maximum commission rate for the website in the requested country
            (default 'US'), as a percentage
          default: 0
      type: object
      required:
        - id
        - url
      title: Website
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.