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

# List channels and markets

> Lists the channels available to your workspace and the markets each one covers.
Use this instead of hard-coding market lists — markets are added over time.




## OpenAPI

````yaml /api-reference/openapi.yaml get /channels
openapi: 3.1.0
info:
  title: Unif API
  version: '2026-09-01'
  summary: One schema for commerce data across every channel.
  description: >
    The Unif API returns normalized commerce data — shops, products, creators,
    videos,

    livestreams and categories — through a single schema that does not change
    when the

    underlying data source does.


    Each request runs a cascade across the sources behind a channel, in cost
    order, stopping at

    the first result that verifies. You are charged for the hit, not for the
    attempts. See

    [the waterfall](/docs/concepts/waterfall).


    Every response is denominated in the currency you ask for, scoped to a
    market, and

    measured over a period you control, whichever source answered.


    **Base URL**


    ```

    https://api.unif.dev/v1

    ```


    All requests require a bearer token. See
    [Authentication](/docs/authentication).


    **Conventions**


    - Success and failure are carried by the HTTP status code. There is no
    envelope to unwrap:
      a `200` body is the object itself, and any `4xx` or `5xx` body is an
      [error object](/docs/platform/errors).
    - Lists are cursor-paginated. Read `next_cursor` and stop when `has_more` is
    false.

    - Every response carries `X-Request-Id`. Billable responses also carry
      `X-Unif-Credits-Charged` and `X-Unif-Credits-Remaining`.
    - Monetary fields are converted to the `currency` you request, and every
    object repeats
      the `currency` and `period` it was measured under.
  contact:
    name: Unif Support
    email: support@unif.dev
    url: https://unif.dev/docs
  license:
    name: Proprietary
    url: https://unif.dev/legal/terms
servers:
  - url: https://api.unif.dev/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Meta
    description: Workspace, channel availability and field coverage.
  - name: Shops
    description: Storefronts and sellers.
  - name: Products
    description: Listings, pricing and sales performance.
  - name: Creators
    description: Affiliates and influencers who sell.
  - name: Videos
    description: Short-form video attributed to sales.
  - name: Livestreams
    description: Live selling sessions.
  - name: Categories
    description: The normalized category tree and category-level market data.
  - name: Resolution
    description: Turn a URL, handle or external ID into a Unif entity.
  - name: Jobs
    description: Asynchronous work for large searches, enrichments and exports.
  - name: Lists
    description: Saved sets of entities.
  - name: Trackers
    description: Scheduled re-checks that emit webhook events on change.
  - name: Webhooks
    description: Endpoint registration and delivery settings.
  - name: Usage
    description: Credit balance and per-request consumption.
paths:
  /channels:
    get:
      tags:
        - Meta
      summary: List channels and markets
      description: >
        Lists the channels available to your workspace and the markets each one
        covers.

        Use this instead of hard-coding market lists — markets are added over
        time.
      operationId: listChannels
      responses:
        '200':
          description: Available channels.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelList'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ChannelList:
      allOf:
        - $ref: '#/components/schemas/ListEnvelope'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/ChannelInfo'
    ListEnvelope:
      type: object
      required:
        - object
        - data
        - has_more
      properties:
        object:
          type: string
          const: list
        has_more:
          type: boolean
          description: Whether another page exists.
        next_cursor:
          type:
            - string
            - 'null'
          description: Pass to `cursor` to fetch the next page. Null on the last page.
        total_count:
          type:
            - integer
            - 'null'
          description: >-
            Approximate number of matches. Null when the result set is too large
            to count exactly.
        period:
          $ref: '#/components/schemas/ResolvedPeriod'
        currency:
          type: string
    ChannelInfo:
      type: object
      properties:
        channel:
          $ref: '#/components/schemas/Channel'
        name:
          type: string
          examples:
            - TikTok Shop
        entity_types:
          type: array
          items:
            $ref: '#/components/schemas/EntityType'
        markets:
          type: array
          items:
            type: object
            properties:
              market:
                $ref: '#/components/schemas/Market'
              currency:
                type: string
                description: The market's native currency.
              timezone:
                type: string
                examples:
                  - America/Los_Angeles
              earliest_period:
                type: string
                format: date
                description: Oldest date with data.
              granularities:
                type: array
                items:
                  type: string
                  enum:
                    - day
                    - week
                    - month
                description: Period granularities this market supports natively.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    ResolvedPeriod:
      type: object
      description: >
        The concrete window a request was measured over, after any preset was
        expanded and any

        channel-specific snapping was applied. Always read this rather than
        assuming you got

        back exactly the dates you asked for.
      required:
        - start
        - end
      properties:
        start:
          type: string
          format: date
        end:
          type: string
          format: date
        granularity:
          type: string
          enum:
            - day
            - week
            - month
          description: The smallest bucket the channel reports for this market.
        adjusted:
          type: boolean
          description: >
            True when the requested dates were snapped to the nearest boundary
            the channel

            supports. See [Periods and currency](/docs/concepts/periods).
    Channel:
      type: string
      description: >
        A sales channel — the commerce surface a request is about. Behind each
        channel is a

        cascade of data sources, tried in cost order until one verifies; the
        roster is published,

        but which source answered a given row is not carried in the response, so
        the cascade can

        be re-tuned without breaking your code.
      enum:
        - tiktok_shop
      examples:
        - tiktok_shop
    EntityType:
      type: string
      enum:
        - shop
        - product
        - creator
        - video
        - livestream
        - category
    Market:
      type: string
      description: An ISO 3166-1 alpha-2 country code identifying a channel storefront.
      enum:
        - US
        - GB
        - IE
        - ES
        - FR
        - DE
        - IT
        - ID
        - TH
        - VN
        - MY
        - PH
        - SG
        - JP
        - BR
        - MX
      examples:
        - US
    Error:
      type: object
      properties:
        type:
          type: string
          enum:
            - invalid_request_error
            - authentication_error
            - permission_error
            - not_found_error
            - rate_limit_error
            - billing_error
            - coverage_error
            - api_error
        code:
          type: string
          examples:
            - parameter_invalid
        message:
          type: string
        param:
          type:
            - string
            - 'null'
          description: The offending field
          as a dot-path.: null
        doc_url:
          type: string
          format: uri
        request_id:
          type: string
  responses:
    Unauthorized:
      description: The API key is missing, malformed or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              code: invalid_api_key
              message: No API key was provided in the Authorization header.
              doc_url: https://unif.dev/docs/platform/errors#invalid_api_key
              request_id: req_01k3m9x7v2q8r4t6y0b1n5d7fa
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Send your workspace API key as a bearer token:


        ```

        Authorization: Bearer unif_sk_live_...

        ```


        Keys are scoped to a single workspace. See
        [Authentication](/docs/authentication).

````