Nym Technologies Unstable Nym Nodes API

openapi: 3.1.0
info:
  title: Node Status API Status Unstable Nym Nodes API
  description: ''
  contact:
    name: Nym Technologies SA
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  version: 4.6.2
tags:
- name: Unstable Nym Nodes
paths:
  /v1/unstable/nym-nodes/by-addresses:
    post:
      tags:
      - Unstable Nym Nodes
      operationId: nodes_by_addresses
      parameters:
      - name: output
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Output'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodesByAddressesRequestBody'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodesByAddressesResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NodesByAddressesResponse'
            application/bincode:
              schema:
                $ref: '#/components/schemas/NodesByAddressesResponse'
  /v1/unstable/nym-nodes/full-fat:
    get:
      tags:
      - Unstable Nym Nodes
      operationId: nodes_detailed
      parameters:
      - name: role
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - type: string
            enum:
            - active-mixnode
            - entry-gateway
            - exit-gateway
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: no_legacy
        in: query
        required: false
        schema:
          type:
          - boolean
          - 'null'
      - name: page
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Output'
      responses:
        '501':
          description: ''
  /v1/unstable/nym-nodes/gateways/skimmed:
    get:
      tags:
      - Unstable Nym Nodes
      summary: Deprecated query that gets ALL gateways
      operationId: deprecated_gateways_basic
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CachedNodesResponse_SkimmedNodeV1'
            application/yaml:
              schema:
                $ref: '#/components/schemas/CachedNodesResponse_SkimmedNodeV1'
            application/bincode:
              schema:
                $ref: '#/components/schemas/CachedNodesResponse_SkimmedNodeV1'
      deprecated: true
  /v1/unstable/nym-nodes/mixnodes/skimmed:
    get:
      tags:
      - Unstable Nym Nodes
      summary: Deprecated query that gets ACTIVE-ONLY mixnodes
      operationId: deprecated_mixnodes_basic
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CachedNodesResponse_SkimmedNodeV1'
            application/yaml:
              schema:
                $ref: '#/components/schemas/CachedNodesResponse_SkimmedNodeV1'
            application/bincode:
              schema:
                $ref: '#/components/schemas/CachedNodesResponse_SkimmedNodeV1'
      deprecated: true
  /v1/unstable/nym-nodes/semi-skimmed:
    get:
      tags:
      - Unstable Nym Nodes
      operationId: nodes_expanded
      parameters:
      - name: role
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - type: string
            enum:
            - active-mixnode
            - entry-gateway
            - exit-gateway
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: no_legacy
        in: query
        required: false
        schema:
          type:
          - boolean
          - 'null'
      - name: page
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Output'
      responses:
        '501':
          description: ''
  /v1/unstable/nym-nodes/skimmed:
    get:
      tags:
      - Unstable Nym Nodes
      summary: 'Return all Nym Nodes and optionally legacy mixnodes/gateways (if `no-legacy` flag is not used)

        that are currently bonded.'
      operationId: nodes_basic_all
      parameters:
      - name: role
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - type: string
            enum:
            - active-mixnode
            - entry-gateway
            - exit-gateway
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: no_legacy
        in: query
        required: false
        schema:
          type:
          - boolean
          - 'null'
      - name: page
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
      deprecated: true
  /v1/unstable/nym-nodes/skimmed/active:
    get:
      tags:
      - Unstable Nym Nodes
      summary: 'Return Nym Nodes and optionally legacy mixnodes/gateways (if `no-legacy` flag is not used)

        that are currently bonded and are in the **active set**'
      operationId: nodes_basic_active
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
      deprecated: true
  /v1/unstable/nym-nodes/skimmed/entry-gateways/active:
    get:
      tags:
      - Unstable Nym Nodes
      summary: 'Returns Nym Nodes and optionally legacy gateways (if `no-legacy` flag is not used)

        that are currently bonded and are in the active set with the entry role.'
      operationId: entry_gateways_basic_active
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
      deprecated: true
  /v1/unstable/nym-nodes/skimmed/entry-gateways/all:
    get:
      tags:
      - Unstable Nym Nodes
      summary: 'Returns Nym Nodes and optionally legacy gateways (if `no-legacy` flag is not used)

        that are currently bonded and support entry gateway role.'
      operationId: entry_gateways_basic_all
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
      deprecated: true
  /v1/unstable/nym-nodes/skimmed/exit-gateways/active:
    get:
      tags:
      - Unstable Nym Nodes
      summary: 'Returns Nym Nodes and optionally legacy gateways (if `no-legacy` flag is not used)

        that are currently bonded and are in the active set with the exit role.'
      operationId: exit_gateways_basic_active
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
      deprecated: true
  /v1/unstable/nym-nodes/skimmed/exit-gateways/all:
    get:
      tags:
      - Unstable Nym Nodes
      summary: 'Returns Nym Nodes and optionally legacy gateways (if `no-legacy` flag is not used)

        that are currently bonded and support exit gateway role.'
      operationId: exit_gateways_basic_all
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
      deprecated: true
  /v1/unstable/nym-nodes/skimmed/mixnodes/active:
    get:
      tags:
      - Unstable Nym Nodes
      summary: 'Returns Nym Nodes and optionally legacy mixnodes (if `no-legacy` flag is not used)

        that are currently bonded and are in the active set with one of the mixing roles.'
      operationId: mixnodes_basic_active
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
      deprecated: true
  /v1/unstable/nym-nodes/skimmed/mixnodes/all:
    get:
      tags:
      - Unstable Nym Nodes
      summary: 'Returns Nym Nodes and optionally legacy mixnodes (if `no-legacy` flag is not used)

        that are currently bonded and support mixing role.'
      operationId: mixnodes_basic_all
      parameters:
      - name: semver_compatibility
        in: query
        required: false
        schema:
          type: string
      - name: no_legacy
        in: query
        required: false
        schema:
          type: boolean
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: epoch_id
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedCachedNodesResponseSchema'
      deprecated: true
components:
  schemas:
    BasicEntryInformation:
      type: object
      required:
      - ws_port
      properties:
        hostname:
          type:
          - string
          - 'null'
        ws_port:
          type: integer
          format: int32
          minimum: 0
        wss_port:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
    SkimmedNodeV1:
      type: object
      required:
      - node_id
      - ed25519_identity_pubkey
      - ip_addresses
      - mix_port
      - x25519_sphinx_pubkey
      - role
      - performance
      properties:
        ed25519_identity_pubkey:
          type: string
        entry:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/BasicEntryInformation'
        ip_addresses:
          type: array
          items:
            type: string
        mix_port:
          type: integer
          format: int32
          minimum: 0
        node_id:
          type: integer
          format: int32
          minimum: 0
        performance:
          type: string
          description: Average node performance in last 24h period
        role:
          $ref: '#/components/schemas/NodeRole'
        supported_roles:
          $ref: '#/components/schemas/DeclaredRolesV1'
        x25519_sphinx_pubkey:
          type: string
    CachedNodesResponse_SkimmedNodeV1:
      type: object
      required:
      - refreshed_at
      - nodes
      properties:
        nodes:
          type: array
          items:
            type: object
            required:
            - node_id
            - ed25519_identity_pubkey
            - ip_addresses
            - mix_port
            - x25519_sphinx_pubkey
            - role
            - performance
            properties:
              ed25519_identity_pubkey:
                type: string
              entry:
                oneOf:
                - type: 'null'
                - $ref: '#/components/schemas/BasicEntryInformation'
              ip_addresses:
                type: array
                items:
                  type: string
              mix_port:
                type: integer
                format: int32
                minimum: 0
              node_id:
                type: integer
                format: int32
                minimum: 0
              performance:
                type: string
                description: Average node performance in last 24h period
              role:
                $ref: '#/components/schemas/NodeRole'
              supported_roles:
                $ref: '#/components/schemas/DeclaredRolesV1'
              x25519_sphinx_pubkey:
                type: string
        refreshed_at:
          $ref: '#/components/schemas/OffsetDateTimeJsonSchemaWrapper'
    Output:
      type: string
      enum:
      - json
      - yaml
      - bincode
    NodeRole:
      oneOf:
      - type: object
        required:
        - Mixnode
        properties:
          Mixnode:
            type: object
            required:
            - layer
            properties:
              layer:
                type: integer
                format: int32
                minimum: 0
      - type: string
        enum:
        - EntryGateway
      - type: string
        enum:
        - ExitGateway
      - type: string
        enum:
        - Standby
      - type: string
        enum:
        - Inactive
    PaginatedCachedNodesResponseSchema:
      type: object
      title: PaginatedCachedNodesResponse
      required:
      - refreshed_at
      - nodes
      properties:
        nodes:
          $ref: '#/components/schemas/SkimmedNodeV1'
        refreshed_at:
          $ref: '#/components/schemas/OffsetDateTimeJsonSchemaWrapper'
    NodesByAddressesResponse:
      type: object
      required:
      - existence
      properties:
        existence:
          type: object
          additionalProperties:
            type:
            - integer
            - 'null'
            format: int32
            minimum: 0
          propertyNames:
            type: string
    NodesByAddressesRequestBody:
      type: object
      required:
      - addresses
      properties:
        addresses:
          type: array
          items:
            type: string
    DeclaredRolesV1:
      type: object
      required:
      - mixnode
      - entry
      - exit_nr
      - exit_ipr
      properties:
        entry:
          type: boolean
        exit_ipr:
          type: boolean
        exit_nr:
          type: boolean
        mixnode:
          type: boolean
    OffsetDateTimeJsonSchemaWrapper:
      type: string
      format: date-time