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

# Get your Market Depth add-on status

> Whether the CME Market Depth add-on (full order book, 10 levels each side) is on for the signed-in trader. The add-on is sold per **calendar month (US Central time), paid in advance**: it is on during a month only when that month is paid. With auto-renew on, next month is charged 2 days before the current month ends (one retry the next day); an unpaid month switches the add-on off when it starts.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/user/addons/market-depth
openapi: 3.0.0
info:
  title: Hyperprop Platform API
  version: 1.0.0
  description: >-
    REST API for the Hyperprop Trading Platform — provision evaluation and
    funded trading accounts, manage traders and plans, react to account
    lifecycle events via signed webhooks, and reconcile billing. Built for prop
    firms integrating from their own backend.


    Authentication, quick start, error handling, idempotency, pagination, custom
    metadata, webhooks, and the MCP connector are documented at
    https://docs.hyperprop.com.
  x-logo:
    url: https://app.hyperprop.com/logo-icon.svg
    altText: Hyperprop
    href: https://hyperprop.com
servers:
  - url: https://api.hyperprop.com/platform
    description: Production
security: []
tags:
  - name: Authentication
    description: >-
      User authentication - signup, signin, signout, password reset, email
      verification, OAuth, and MFA
  - name: User
    description: >-
      User account management - profile, notifications, agreements, dismissals,
      and audit logs. Requires Bearer token.
  - name: Organization
    description: >-
      Organization management - profile, team, trading accounts, plans, and
      rules. Supports **dual authentication**: Bearer JWT token (dashboard
      users) OR X-API-Key (programmatic access).
  - name: Market Data
    description: CME futures contracts and market data. Requires Bearer token.
  - name: Indicator Builder
    description: >-
      AI-assisted authoring of custom Hyperprop Script indicators for the web
      terminal. Requires Bearer token.
  - name: System
    description: System endpoints - health checks and connectivity
paths:
  /v1/user/addons/market-depth:
    get:
      tags:
        - User
      summary: Get your Market Depth add-on status
      description: >-
        Whether the CME Market Depth add-on (full order book, 10 levels each
        side) is on for the signed-in trader. The add-on is sold per **calendar
        month (US Central time), paid in advance**: it is on during a month only
        when that month is paid. With auto-renew on, next month is charged 2
        days before the current month ends (one retry the next day); an unpaid
        month switches the add-on off when it starts.
      operationId: getV1UserAddonsMarketdepth
      responses:
        '200':
          description: Status returned
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model370'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model9'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
components:
  schemas:
    Model370:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model369'
    Model9:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication required
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: UNAUTHORIZED
    Model5:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: Internal Server Error
        message:
          type: string
          example: An unexpected error occurred
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INTERNAL_ERROR
    Model369:
      type: object
      properties:
        active:
          type: boolean
          description: Market depth is on right now
          example: true
        source:
          $ref: '#/components/schemas/source'
        autoRenew:
          type: boolean
          description: Next month is charged automatically
          example: true
        paidThrough:
          type: string
          description: First day of the last paid calendar month
          example: '2026-10-01'
        nextChargeDate:
          type: string
          description: >-
            Date (US Central) the next month is charged; null when auto-renew is
            off
          example: '2026-10-29'
        paymentFailed:
          type: boolean
          description: The last renewal charge failed and that month is still unpaid
          example: false
        canManageBilling:
          type: boolean
          description: A billing page is available (payment method, invoices)
          example: true
        priceCents:
          type: integer
          description: Current monthly price in cents; null when billing is unavailable
          example: 4800
        currency:
          type: string
          example: usd
    source:
      type: string
      description: '`monthly` = paid per calendar month; `granted` = enabled by Hyperprop'
      example: monthly
      enum:
        - monthly
        - granted

````

## Related topics

- [Buy Market Depth](/platform-api/user/buy-market-depth.md)
- [Turn Market Depth auto-renew off or on](/platform-api/user/turn-market-depth-auto-renew-off-or-on.md)
- [GET /depth/history — rolling order-book depth history.](/market-data-api/historical/get-depthhistory-—-rolling-order-book-depth-history.md)
- [Update notification preferences](/platform-api/user/update-notification-preferences.md)
- [Changelog](/changelog.md)
