> ## 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.

# Get price history for a product over time

> Get historical price observations for a product within a date range. Returns current price, period low/high/avg, trend (rising/falling/stable), good-deal flag, and an observation time-series for charting. Also returns `series`, one row per day at that day's lowest price across the product's entity-matched listings, and `series_summary`, which reads that series: the dated low and high (`min_date`, `max_date`), every day-over-day drop of 5% or more (`drops`), and `change_pct`, the banded like-for-like change over `win` days (best price in the last few days vs best price around `win` days ago; null when the queried range does not reach back that far). These are the numbers the Syntalic dashboards report. Includes a nullable gpc block for the resolved product (fail-soft).



## OpenAPI

````yaml https://api.syntalic.com/openapi.json get /v1/shopper/price-history
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/shopper/price-history:
    get:
      tags:
        - Shopper
      summary: Get price history for a product over time
      description: >-
        Get historical price observations for a product within a date range.
        Returns current price, period low/high/avg, trend
        (rising/falling/stable), good-deal flag, and an observation time-series
        for charting. Also returns `series`, one row per day at that day's
        lowest price across the product's entity-matched listings, and
        `series_summary`, which reads that series: the dated low and high
        (`min_date`, `max_date`), every day-over-day drop of 5% or more
        (`drops`), and `change_pct`, the banded like-for-like change over `win`
        days (best price in the last few days vs best price around `win` days
        ago; null when the queried range does not reach back that far). These
        are the numbers the Syntalic dashboards report. Includes a nullable gpc
        block for the resolved product (fail-soft).
      operationId: getPriceHistory
      parameters:
        - name: q
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            Search query (product name, keyword, or brand + model). Required
            unless `product_uid` or `entity_uid` is supplied.
          example: airpods
        - name: product_uid
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            Stable product identifier returned by a prior Syntalic shopper
            response. When supplied, the endpoint should pin to this listing
            instead of re-resolving free text.
          example: p_airpods_deal
        - name: entity_uid
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            Stable cross-retailer entity identifier returned by a prior Syntalic
            shopper response. When supplied, the endpoint should resolve within
            the same physical-product entity.
          example: e_airpods_deal
        - 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
        - name: time_window
          in: query
          required: false
          schema:
            type: string
            enum:
              - last_30_days
              - last_60_days
              - last_90_days
              - month_to_date
              - previous_month
              - month_over_month
              - quarter_to_date
              - custom
          description: >-
            Historical window preset. Explicit `from`/`to` takes precedence and
            is reported as `custom`; `time_window=custom` requires both `from`
            and `to`. Date-only ranges use UTC calendar boundaries with
            inclusive `from` and exclusive `to`.
          example: last_60_days
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date
          description: Start date (ISO 8601, defaults to 30 days ago)
          example: '2026-05-01'
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date
          description: End date (ISO 8601, defaults to now)
          example: '2026-06-01'
        - name: win
          in: query
          required: false
          schema:
            type: integer
            enum:
              - 7
              - 30
              - 90
            default: 30
          description: >-
            Window in days for series_summary.change_pct. Independent of the
            chart range: set lookback_days (or from) far enough back to cover
            it.
      responses:
        '200':
          description: Price history
          content:
            application/json:
              schema:
                type: object
                properties:
                  query:
                    type: string
                  country:
                    type: string
                  currency:
                    type: string
                  product_uid:
                    type: string
                  entity_uid:
                    type: string
                  product_name:
                    type: string
                  retailer:
                    type: string
                  condition:
                    type: string
                  current_price:
                    type: number
                  period_low:
                    type: number
                  period_high:
                    type: number
                  period_avg:
                    type: number
                  is_good_deal:
                    type: boolean
                    nullable: true
                  trend:
                    type: string
                    nullable: true
                  insufficient_history:
                    type: boolean
                  observation_count:
                    type: integer
                  scope:
                    type: string
                    enum:
                      - entity
                      - listing
                    nullable: true
                  member_count:
                    type: integer
                    nullable: true
                  window:
                    type: object
                    properties:
                      preset:
                        type: string
                      from:
                        type: string
                        format: date
                      to:
                        type: string
                        format: date
                      granularity:
                        type: string
                        nullable: true
                      comparison_from:
                        type: string
                        format: date
                        nullable: true
                      comparison_to:
                        type: string
                        format: date
                        nullable: true
                      timezone:
                        type: string
                        example: UTC
                    additionalProperties: true
                  observations:
                    type: array
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          format: date
                        price:
                          type: number
                  series:
                    type: array
                    description: One row per day at that day's lowest price, oldest first.
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          format: date
                        price:
                          type: number
                  series_summary:
                    type: object
                    nullable: true
                    description: >-
                      What the daily-low series says. Null when there is no
                      series.
                    properties:
                      current:
                        type: number
                      min:
                        type: number
                      min_date:
                        type: string
                        format: date
                      max:
                        type: number
                      max_date:
                        type: string
                        format: date
                      change_pct:
                        type: number
                        nullable: true
                        description: >-
                          Banded like-for-like change over change_window_days,
                          in percent.
                      change_window_days:
                        type: integer
                        enum:
                          - 7
                          - 30
                          - 90
                      drops:
                        type: array
                        description: Day-over-day falls of 5% or more.
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              format: date
                            from_price:
                              type: number
                            to_price:
                              type: number
                            pct:
                              type: number
                              description: Size of the fall, in percent.
                  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.