shelfatlas-com Stats API

openapi: 3.2.0
info:
  title: ShelfAtlas Catalog Stats API
  version: 1.0.0
  description: 'Read access to normalised Danish retail catalog data — products, offers, stores, and chains. Authenticate with a Bearer `sa_live_` API key. This document is the contract the official ShelfAtlas SDKs conform to. Data coverage: the offer feed covers every major Danish chain, but the curated product catalog is smaller and actively expanding — an empty data array from /products/{id}/offers or /price-history means no offers are linked to that product yet, not an error.'
  termsOfService: https://shelfatlas.com/legal/terms
servers:
- url: https://api.shelfatlas.com
  description: Production
security:
- bearerAuth: []
tags:
- name: Stats
paths:
  /api/v1/public/catalog/stats:
    get:
      operationId: getStats
      summary: Platform-wide catalog aggregates (public marketing numbers)
      description: 'The same real numbers rendered on the ShelfAtlas homepage — live offer count, coverage, per-chain breakdown. Unauthenticated: the data is already public, so a key would protect nothing. Bounded instead by a per-IP rate limit and a CDN cache (`Cache-Control: public, s-maxage=3600, stale-while-revalidate=86400`).'
      tags:
      - Stats
      security: []
      parameters: []
      responses:
        '200':
          description: Current platform stats snapshot.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                additionalProperties: false
                properties:
                  ok:
                    type: boolean
                    enum:
                    - true
                  data:
                    $ref: '#/components/schemas/Stats'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    RateLimited:
      description: Rate limit or monthly limit reached (`rate_limited` / `monthly_limit_reached`).
      headers:
        Retry-After:
          description: Seconds to wait before retrying (present on `rate_limited`).
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    ChainStat:
      type: object
      additionalProperties: false
      required:
      - name
      - slug
      - logoUrl
      - storeCount
      - liveOfferCount
      properties:
        name:
          type: string
        slug:
          type: string
        logoUrl:
          type:
          - string
          - 'null'
        storeCount:
          type: integer
        liveOfferCount:
          type: integer
    Error:
      type: object
      additionalProperties: true
      required:
      - error
      properties:
        error:
          type: string
          description: Machine-readable error code.
        message:
          type: string
        detail:
          type: string
        retry_after_sec:
          type: integer
          description: Seconds to wait before retrying (429).
        plan:
          type: string
          description: Caller's resolved plan id (present on monthly_limit_reached).
        limit:
          type: integer
          description: The plan monthly request quota (present on monthly_limit_reached).
        used:
          type: integer
          description: Requests already spent this UTC month (present on monthly_limit_reached).
        resets_at:
          type: string
          format: date-time
          description: When the quota resets — next UTC month start (present on monthly_limit_reached).
        next_plan:
          type: object
          nullable: true
          description: The cheapest plan with a larger quota, or null at the top of the ladder.
          properties:
            id:
              type: string
            name:
              type: string
            monthly_price_dkk:
              type: integer
            monthly_request_quota:
              type: integer
        plans_url:
          type: string
          format: uri
          description: Public pricing page — no sign-in required.
        upgrade_url:
          type: string
          format: uri
    RecentOffer:
      type: object
      additionalProperties: false
      required:
      - rawName
      - price
      - currency
      - chainName
      - imageUrl
      properties:
        rawName:
          type: string
        price:
          type: string
          description: Decimal string (Postgres numeric).
        currency:
          type: string
          minLength: 3
          maxLength: 3
        chainName:
          type:
          - string
          - 'null'
        imageUrl:
          type:
          - string
          - 'null'
    Stats:
      type: object
      additionalProperties: false
      required:
      - liveOffers
      - storesCount
      - chainsCovered
      - productsCount
      - priceHistoryDays
      - perChain
      - recentOffers
      - generatedAt
      properties:
        liveOffers:
          type: integer
        storesCount:
          type: integer
        chainsCovered:
          type: integer
        productsCount:
          type: integer
        priceHistoryDays:
          type: integer
          description: Age of the oldest price observation, in days.
        perChain:
          type: array
          items:
            $ref: '#/components/schemas/ChainStat'
        recentOffers:
          type: array
          items:
            $ref: '#/components/schemas/RecentOffer'
        latestOffersAcrossChains:
          type: array
          items:
            $ref: '#/components/schemas/RecentOffer'
          description: 'Newest current campaign offers across chains (at most 2 per chain, 6 in total). Optional: absent in payloads cached before it existed.'
        generatedAt:
          type: string
          format: date-time
          description: Wallclock when this snapshot was assembled.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'A ShelfAtlas API key: `Authorization: Bearer sa_live_<key>`.'
    deviceTokenAuth:
      type: apiKey
      in: header
      name: X-Device-Token
      description: 'Anonymous per-device identity for POST /api/v1/observations: a UUID the client generates and keeps locally. Any UUID version is accepted — the check is purely the 8-4-4-4-12 hex-digit shape.'