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

# Analyze price spread across retailers for a category or department

> Analyze the spread of current prices within a category - mean, stddev, coefficient of variation, and percentiles (p10..p90) with IQR outlier exclusion. The population is representativeness-filtered: refurbished/used listings, accessory/parts subtrees, and rows under a category-aware price floor are excluded from headline stats, with the counts disclosed in `excluded`.



## OpenAPI

````yaml https://api.syntalic.com/openapi.json get /v1/analyst/price-dispersion
openapi: 3.1.0
info:
  title: 'Syntalic — Data Analytics for Agentic Commerce '
  version: 1.0.0
  contact:
    name: Syntalic
    email: support@syntalic.com
    url: https://syntalic.com
  description: >-
    Competitive pricing data across US and Canadian e-commerce retailers
    (Amazon, Walmart, Target, Best Buy, Home Depot, etc.). Serves price
    comparisons, deal alerts, brand tracking, promotional intelligence, and
    market analytics to AI agents via x402 and MPP micropayments.
  x-guidance: >-
    This API has three endpoint groups organized by use case:


    **Shopper endpoints** ($0.01/query): Use these for price comparisons and
    deal hunting. Start with /v1/shopper/best-price?q=<product> to find the
    cheapest option across retailers. Use
    /v1/shopper/deal-finder?category=<category> to find discounted products. Use
    /v1/shopper/price-drop-alert?q=<product> to check for recent price drops.


    **Marketing endpoints** ($0.01/query): Use these for competitive analysis.
    /v1/marketing/competitive-landscape?category=<category> shows all products
    in a category with pricing. /v1/marketing/brand-tracker?brand=<brand> tracks
    a brand's pricing over time.
    /v1/marketing/share-of-shelf?category=<category> shows brand market share.


    **Analyst endpoints** ($0.02/query): Use these for market-level insights.
    /v1/analyst/inflation?category=<category> shows price trends over time.
    /v1/analyst/price-dispersion?category=<category> shows price spread across
    retailers.


    All endpoints accept an optional 'country' parameter (us or ca, defaults to
    us). Query parameters use 'q' for free-text search and 'category' for
    category-level queries.


    Marketing and analyst responses carry a `meta` block (served_from,
    freshness_seconds, schema_version) for staleness budgeting and a `resolved`
    block describing how the category input was matched against the taxonomy.
    Every response also sends an X-Data-Freshness-Hours header.


    **Free pre-payment rejection:** requests that cannot be served are rejected
    BEFORE any payment challenge — invalid params (400 INVALID_PARAMS),
    retailers that are not serving-eligible (404 RETAILER_NOT_SERVING_ELIGIBLE,
    with the catalog quality status and the serving_eligible_retailers list in
    error.details), and shopper queries that resolve to nothing in the catalog
    (404 NO_RESULTS). You only pay when the API can actually execute your query.
    Retailer values are case-insensitive (amazon == Amazon).
servers:
  - url: https://api.syntalic.com
security: []
paths:
  /v1/analyst/price-dispersion:
    get:
      tags:
        - Analyst
      summary: Analyze price spread across retailers for a category or department
      description: >-
        Analyze the spread of current prices within a category - mean, stddev,
        coefficient of variation, and percentiles (p10..p90) with IQR outlier
        exclusion. The population is representativeness-filtered:
        refurbished/used listings, accessory/parts subtrees, and rows under a
        category-aware price floor are excluded from headline stats, with the
        counts disclosed in `excluded`.
      operationId: getPriceDispersion
      parameters:
        - name: category
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            Product category in the Shopify product taxonomy. Accepts a display
            path (e.g. 'Electronics > Computers > Laptops'), its slug form (e.g.
            'electronics/computers/laptops'), a single path segment (e.g.
            'laptops', 'headphones'), or an everyday shelf name (e.g. 'apparel',
            'beauty', 'grocery'); matched against the catalog's category tree
            (exact node, subtree, or whole path segment). Also accepts a GS1 GPC
            code (exactly 8 digits, e.g. '10001159') to filter by PRODUCT TYPE
            instead of by shelf placement — the same product type is shelved
            under different categories by different retailers, so a category
            filter answers from a fraction of the data while a GPC code spans
            them. Coarser codes (class/family/segment) match every brick beneath
            them. Resolve a phrase to a code with /v1/reference/classify?q=... ;
            when a code is used, resolved.match_source is 'gpc'. For analyst
            endpoints, supply either `category` or `department`; both may be
            supplied to narrow the scope.
          example: electronics
        - name: department
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            Top-level department (root category), e.g. 'Electronics', 'Beauty',
            'Home & Kitchen'. Case-insensitive; matched against the category
            tree's root segment. For analyst endpoints, supply either `category`
            or `department`; both may be supplied to narrow the scope.
          example: Electronics
        - name: country
          in: query
          required: false
          schema:
            type: string
            enum:
              - us
              - ca
            default: us
          description: Country (us or ca)
          example: us
        - name: retailer
          in: query
          required: false
          schema:
            type: string
            enum:
              - amazon
              - walmart
              - target
              - bestbuy
              - homedepot
              - costco
              - ikea
              - samsclub
              - cvs
              - dillards
          description: >-
            Filter to a specific retailer platform (long-tail specialty stores
            are also present; any platform key is accepted)
          example: amazon
      responses:
        '200':
          description: Price dispersion data
          content:
            application/json:
              schema:
                type: object
                properties:
                  category:
                    type: string
                    nullable: true
                  department:
                    type: string
                    nullable: true
                  country:
                    type: string
                  currency:
                    type: string
                  avg_price:
                    type: number
                    nullable: true
                  min_price:
                    type: number
                    nullable: true
                  max_price:
                    type: number
                    nullable: true
                  std_dev:
                    type: number
                    nullable: true
                  coeff_of_variation:
                    type: number
                    nullable: true
                  percentiles:
                    type: object
                    properties:
                      p10:
                        type: number
                        nullable: true
                      p25:
                        type: number
                        nullable: true
                      p50:
                        type: number
                        nullable: true
                      p75:
                        type: number
                        nullable: true
                      p90:
                        type: number
                        nullable: true
                  product_count:
                    type: integer
                  price_histogram:
                    type: array
                    description: >-
                      Equal-width buckets over the SAME products the percentiles
                      describe, so the counts sum to product_count. Eight
                      buckets spanning min_price..max_price; the top bucket's
                      upper edge is inclusive. A category where every product
                      shares one price returns a single bucket. Per-product
                      prices are not served — the distribution answers the
                      question without shipping the priced catalogue.
                    items:
                      type: object
                      properties:
                        bin:
                          type: string
                          description: Bucket range label, e.g. "12.5–24.0"
                        count:
                          type: integer
                  outliers_excluded:
                    type: integer
                  representative_floor:
                    type: number
                  excluded:
                    type: object
                    description: >-
                      Transparency counts: rows in scope but excluded from the
                      headline statistics by the representativeness policy.
                    properties:
                      below_floor:
                        type: integer
                      refurbished_or_used:
                        type: integer
                      accessory_or_parts:
                        type: integer
                      price_outliers:
                        type: integer
                    additionalProperties: true
                  resolved:
                    type: object
                    properties:
                      input:
                        type: string
                      category_path:
                        type: string
                        nullable: true
                      department:
                        type: string
                        nullable: true
                      match_source:
                        type: string
                        nullable: true
                      match_confidence:
                        type: number
                        nullable: true
                      alternates:
                        type: array
                        items:
                          type: object
                          additionalProperties: true
                    additionalProperties: true
                  meta:
                    type: object
                    properties:
                      served_from:
                        type: string
                      freshness_seconds:
                        type: number
                      schema_version:
                        type: string
                      computed_at:
                        type: string
                        format: date-time
                      price_observed_at_min:
                        type: string
                        format: date-time
                        nullable: true
                      price_observed_at_max:
                        type: string
                        format: date-time
                        nullable: true
                    additionalProperties: true
        '400':
          description: >-
            Invalid query parameters or unsupported enum values. Rejected by
            preflight BEFORE the payment challenge — no payment is requested or
            charged for malformed requests.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Bad Request
                  status:
                    type: integer
                    const: 400
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '402':
          description: Payment challenge required before executing paid work
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Payment Required
                  status:
                    type: integer
                    const: 402
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '404':
          description: >-
            No matching result. error.code distinguishes the cases: NO_RESULTS
            (the query resolves to nothing in the catalog),
            RETAILER_NOT_SERVING_ELIGIBLE (the requested retailer exists but is
            not serving-eligible — error.details carries its catalog
            quality_status and the serving_eligible_retailers list to retry
            against), or NOT_PUBLISHED (a social rollup the current publish run
            does not compute yet — a gap in what we publish, not a finding about
            the category). Structurally-unservable requests are rejected by
            preflight before any payment challenge.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Not Found
                  status:
                    type: integer
                    const: 404
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '429':
          description: Rate limit exceeded
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Too Many Requests
                  status:
                    type: integer
                    const: 429
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true
        '500':
          description: Unexpected server error
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                properties:
                  type:
                    type: string
                    format: uri-reference
                  title:
                    type: string
                    example: Internal Server Error
                  status:
                    type: integer
                    const: 500
                  detail:
                    type: string
                  instance:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: object
                        additionalProperties: true
                    additionalProperties: true
                additionalProperties: true

````

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