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

# Market days supply

> Active supply, recent sell-through, and implied market days supply for a segment. Requires Unlimited plan entitlement.



## OpenAPI

````yaml /openapi.yaml get /market/days-supply
openapi: 3.1.0
info:
  title: Hrizn Public API
  version: 1.2.0
  description: >
    The Hrizn Public API allows partners to programmatically create content,
    manage inventory descriptions, and integrate with the Hrizn platform.


    All endpoints are prefixed with `/public` and require an API key passed via
    the `X-API-Key` header (except the health check).
  contact:
    email: support@hrizn.io
servers:
  - url: https://api.app.hrizn.io/v1/public
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: IdeaClouds
    description: Create and manage AI-powered keyword research
  - name: Content Intelligence
    description: AI-powered content gap analysis and recommendations
  - name: Content
    description: Generate content from IdeaClouds
  - name: Compliance
    description: Run OEM compliance checks on content
  - name: Content Tools
    description: Generate SEO metadata, schemas, and social snippets
  - name: Inventory
    description: Access vehicle data and AI descriptions
  - name: Market
    description: >-
      Live local market listings, days supply, competitive set, and pricing
      insights (Unlimited plan + market_data:read)
  - name: Site
    description: View dealership details and configuration
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events
  - name: Reference
    description: Look up available types, scopes, and events
  - name: Social
    description: >-
      Social Hub posting and reviews across all connected platforms (X,
      Facebook, Instagram, LinkedIn, Google Business Profile)
  - name: Health
    description: Health check (no authentication)
paths:
  /market/days-supply:
    get:
      tags:
        - Market
      summary: Market days supply
      description: >-
        Active supply, recent sell-through, and implied market days supply for a
        segment. Requires Unlimited plan entitlement.
      operationId: getMarketDaysSupply
      parameters:
        - $ref: '#/components/parameters/MarketMake'
        - $ref: '#/components/parameters/MarketModel'
        - $ref: '#/components/parameters/MarketTrim'
        - $ref: '#/components/parameters/MarketYearMin'
        - $ref: '#/components/parameters/MarketYearMax'
        - $ref: '#/components/parameters/MarketCarType'
        - $ref: '#/components/parameters/MarketZip'
        - $ref: '#/components/parameters/MarketState'
        - $ref: '#/components/parameters/MarketRadiusMiles'
      responses:
        '200':
          description: Market days supply
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketDataResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/PlanUpgradeOrForbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    MarketMake:
      name: make
      in: query
      schema:
        type: string
      description: Vehicle make
    MarketModel:
      name: model
      in: query
      schema:
        type: string
      description: Vehicle model
    MarketTrim:
      name: trim
      in: query
      schema:
        type: string
      description: Trim level
    MarketYearMin:
      name: year_min
      in: query
      schema:
        type: integer
        minimum: 1980
        maximum: 2100
    MarketYearMax:
      name: year_max
      in: query
      schema:
        type: integer
        minimum: 1980
        maximum: 2100
    MarketCarType:
      name: car_type
      in: query
      schema:
        type: string
        enum:
          - new
          - used
          - certified
    MarketZip:
      name: zip
      in: query
      schema:
        type: string
        minLength: 3
        maxLength: 12
      description: ZIP override (dealership ZIP auto-resolved when omitted)
    MarketState:
      name: state
      in: query
      schema:
        type: string
        minLength: 2
        maxLength: 2
      description: US state code when no ZIP
    MarketRadiusMiles:
      name: radius_miles
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 500
  schemas:
    MarketDataResponse:
      type: object
      properties:
        data:
          type: object
          additionalProperties: true
          description: Live market payload (shape varies by endpoint)
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: 'keyword: Required'
            details:
              type: object
            request_id:
              type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    PlanUpgradeOrForbidden:
      description: >-
        Missing market_data:read scope, or Unlimited plan entitlement required
        for Hrizn Market Maker (`plan_upgrade_required`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_scope:
              value:
                error:
                  code: forbidden
                  message: >-
                    This API key requires one of the following scopes:
                    market_data:read
                  details:
                    required_scopes:
                      - market_data:read
            plan_upgrade:
              value:
                error:
                  code: plan_upgrade_required
                  message: Unlimited plan required for Hrizn Market Maker.
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Hrizn API key (prefix hzk_)

````