openapi: 3.2.0
info:
  title: Livepeer CLI Local HTTP Status API
  description: 'Local control-plane HTTP endpoints exposed by the Livepeer node.


    The CLI HTTP API provides programmatic access to node management functions

    including status monitoring, staking operations, orchestrator configuration,

    and broadcast settings.


    **Default Ports:**

    - Gateway: http://localhost:5935

    - Orchestrator: http://localhost:7935

    '
  version: 1.0.0
  contact:
    name: Livepeer Documentation
    url: https://docs.livepeer.org
servers:
- url: http://localhost:5935
  description: Gateway CLI API (default)
- url: http://localhost:7935
  description: Orchestrator CLI API
tags:
- name: Status
  description: Node status and information
paths:
  /status:
    get:
      tags:
      - Status
      summary: Get node status
      description: Display node information, balances, and configuration
      operationId: getStatus
      responses:
        '200':
          description: Node status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeStatus'
  /protocolParameters:
    get:
      tags:
      - Status
      summary: View protocol parameters
      description: Show protocol state and parameters
      operationId: getProtocolParameters
      responses:
        '200':
          description: Protocol parameters retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolParameters'
  /registeredOrchestrators:
    get:
      tags:
      - Status
      summary: List registered orchestrators
      description: Display available orchestrators on the network
      operationId: getRegisteredOrchestrators
      responses:
        '200':
          description: Orchestrator list retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Orchestrator'
components:
  schemas:
    NodeStatus:
      type: object
      properties:
        node:
          type: object
          properties:
            version:
              type: string
              example: 0.7.0
            chainId:
              type: integer
              example: 42161
        account:
          type: object
          properties:
            address:
              type: string
              example: 0x...
            ethBalance:
              type: string
              example: '1000000000000000000'
            lptBalance:
              type: string
              example: '1000000000000000000'
    Orchestrator:
      type: object
      properties:
        address:
          type: string
          example: 0x...
        serviceURI:
          type: string
          example: https://orchestrator.example.com:8935
        pricePerPixel:
          type: string
          example: '1000'
        activationRound:
          type: string
    ProtocolParameters:
      type: object
      properties:
        totalBondedToken:
          type: string
        totalSupply:
          type: string
        paused:
          type: boolean
        currentRound:
          type: string