openapi: 3.1.0
info:
  title: 'NEAR Protocol RPC: Network Information'
  description: Retrieve information about the NEAR Protocol network and connected peers
  version: 1.0.0
servers:
  - url: https://rpc.mainnet.fastnear.com
    description: Mainnet
  - url: https://rpc.testnet.fastnear.com
    description: Testnet
paths:
  /:
    post:
      operationId: network_info
      summary: Get network information
      description: >-
        Retrieves information about the network and connected peers including
        active connections, peer addresses, and network configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - jsonrpc
                - id
                - method
                - params
              properties:
                jsonrpc:
                  type: string
                  enum:
                    - '2.0'
                id:
                  type: string
                  example: fastnear
                method:
                  type: string
                  enum:
                    - network_info
                params:
                  type: array
                  maxItems: 0
                  description: Empty array as this method takes no parameters
                  example: []
            examples:
              mainnet:
                summary: Mainnet Network Information
                value:
                  jsonrpc: '2.0'
                  id: fastnear
                  method: network_info
                  params: []
              testnet:
                summary: Testnet Network Information
                value:
                  jsonrpc: '2.0'
                  id: fastnear
                  method: network_info
                  params: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonRpcResponse'
components:
  schemas:
    JsonRpcResponse:
      type: object
      required:
        - jsonrpc
        - id
      properties:
        jsonrpc:
          type: string
          enum:
            - '2.0'
        id:
          oneOf:
            - type: string
            - type: number
        result:
          type: object
          properties:
            active_peers:
              type: array
              items:
                type: object
            known_producers:
              type: array
              items:
                type: object
              description: Accounts of known block and chunk producers from routing table.
            num_active_peers:
              type: integer
              format: uint
              minimum: 0
            peer_max_count:
              type: integer
              format: uint32
              minimum: 0
            received_bytes_per_sec:
              type: integer
              format: uint64
              minimum: 0
            sent_bytes_per_sec:
              type: integer
              format: uint64
              minimum: 0
          required:
            - active_peers
            - num_active_peers
            - peer_max_count
            - sent_bytes_per_sec
            - received_bytes_per_sec
            - known_producers
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            data:
              type: object
