---
title: "Returns the list of known nodes that are compatible with the current catapult version."
method: GET
path: "/nodes"
tags: ["node"]
---

# Returns the list of known nodes that are compatible with the current catapult version.

`GET /nodes`

## Query parameters

- `filter` 'suggested' | 'preferred' — suggested: all available api nodes that have a rest endpoint and are online. preferred: all preferred api nodes that have a rest endpoint and are online. Prefered are nodes that match some specific domains.
- `limit` integer
- `ssl` boolean

## Response `200`

The list of known nodes

- NodeInfo[]
  - `publicKey` string, required
  - `roles` integer, required — A number that defines the different roles the node provides. Possible roles are: * 1 - Peer node. * 2 - Api node. * 4 - Voting node. * 64 - IPv4 compatible node * 128 - IPv6 compatible node. The values are bitwise added together, Examples: 1 = Just Peer. 2 = Just Api. 3 = Peer and Api node. 7 = Peer, Api and Voting node. 65 = IPv4 and Peer node.
  - `version` integer, required — The client version. Each pair of digits represent a digit number. E.g. 16777728 is 1.0.2.0
  - `friendlyName` string, required — Node friendly name.
  - `networkGenerationHashSeed` string, required
  - `port` integer, required — Port used for the communication.
  - `networkIdentifier` 104 | 152 — Network type: * 0x68 (104 decimal) - Public main network. * 0x98 (152 decimal) - Public test network.
  - `host` string, required — Server IP or Hostname
  - `peerStatus` PeerStatus, required — The status of the peer node.
    - `lastStatusCheck` integer, required
    - `isAvailable` boolean, required
  - `apiStatus` ApiStatus — The status of the api node. Information is from the rest gateway.
    - `restGatewayUrl` string, required — The rest gateway url ready to be connected.
    - `isAvailable` boolean, required
    - `lastStatusCheck` integer, required
    - `nodeStatus` NodeStatus — The status of the rest gateway.
      - `apiNode` string
      - `db` string
    - `isHttpsEnabled` boolean, required
    - `nodePublicKey` string, required
    - `chainHeight` integer, required
    - `finalization` Finalization, required
      - `height` integer — The finalized block of the blockchain.
      - `epoch` integer
      - `point` integer
      - `hash` string
    - `restVersion` string, required
  - `hostDetail` HostDetail, required — Location detils of the node.
    - `host` string, required — The IP or hostname of the node.
    - `coordinates` Coordinates — The world coordinates of the node based on the ip address.
      - `latitude` integer, required
      - `longitude` integer, required
    - `location` string
    - `ip` string
    - `organization` string
    - `as` string
    - `continent` string
    - `country` string
    - `region` string
    - `city` string
    - `district` string
    - `zip` string

---

[API](https://skmtc.dev/symbol/apis/symbol-statistic-service-api-documentation.md) · [All operations](https://skmtc.dev/symbol/apis/symbol-statistic-service-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/symbol/apis/symbol-statistic-service-api-documentation/revisions/afe12e640827?raw)