openapi: 3.0.3
servers:
  - url: 'http://localhost:50832'
info:
  description: >-
    This is the API definition Pocket Network Node RPC interface.


    Pocket is a distributed network that relays data requests and responses to and from any blockchain system.


    Pocket verifies all relayed data and proportionally rewards the participating nodes with POKT.
  version: 1.0.0
  title: Pocket Network
  termsOfService: 'https://pokt.network/terms/'
  contact:
    email: hola@pokt.network
  license:
    name: MIT License
    url: 'https://github.com/pokt-network/pocket/blob/main/LICENSE'
tags:
  - name: version
    description: Version of the Pocket API
  - name: health
    description: Liveness of the Pocket API node
  - name: client
    description: Dispatch and relay services
  - name: consensus
    description: Consensus related methods
paths:
  /v1/health:
    get:
      tags:
        - health
      summary: Get the liveness of the Pocket API node
      responses:
        '200':
          description: Healthy
        '404':
          description: Unhealthy - Unreachable
        '500':
          description: Unhealthy - Server Error
  /v1/version:
    get:
      tags:
        - version
      summary: Get the current version of the Pocket Network API
      responses:
        default:
          description: Default response
          content:
            text/plain:
              schema:
                type: string
                example: 1.0.0
  /v1/consensus/round_state:
    get:
      tags:
        - consensus
      summary: Gets the current height, round and step
      responses:
        default:
          description: Default response
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/RoundState'
              example:
                {
                  "height": 75016,
                  "round": 0,
                  "step": 3
                }
  /v1/client/broadcast_tx_sync:
    post:
      tags:
        - client
      summary: Broadcast raw transaction bytes
      requestBody:
        description: Raw transaction to be broadcasted
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RawTXRequest'
      responses:
        '200':
          description: Transaction added to the mempool without errors
        '400':
          description: Bad request
          content:
            text/plain:
              example: "description of failure"
        '500':
          description: An error occurred while adding the transaction to the mempool
          content:
            text/plain:
              example: "description of failure"
externalDocs:
  description: Find out more about Pocket Network
  url: 'https://pokt.network'
components:
  schemas:
    RawTXRequest:
      type: object
      required:
        - address
        - raw_hex_bytes
      properties:
        address:
          type: string
        raw_hex_bytes:
          type: string
    RoundState:
        type: object
        required:
          - height
          - round
          - step
        properties:
          height:
            type: integer
            format: int64
          round:
            type: integer
            format: int64
          step:
            type: integer
            format: int64
  requestBodies: {}
  securitySchemes: {}
  links: {}
  callbacks: {}
security: []