Network

Network connections

get

List the running P2P connection.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

incomingbooleanRequired

peer_idone ofRequired

stringOptional

or

remote_socket_portinteger · max: 65535Required

privatebooleanRequired

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/connections

HTTPcURLJavaScriptPython

GET /network/connections HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "incoming": true,
    "peer_id": "text",
    "id_point": {
      "addr": "text",
      "port": 1
    },
    "remote_socket_port": 1,
    "announced_version": {
      "chain_name": "text",
      "distributed_db_version": 1,
      "p2p_version": 1
    },
    "private": true,
    "local_metadata": {
      "disable_mempool": true,
      "private_node": true
    },
    "remote_metadata": {
      "disable_mempool": true,
      "private_node": true
    }
  }
]

Network connections

get

Details about the current P2P connection to the given peer.

Authorizations

api-keyAuth

api-keystringRequired

Path parameters

peer_idstringRequired

A cryptographic node identity (Base58Check-encoded)

Responses

200

Valid response

application/json

incomingbooleanRequired

peer_idone ofRequired

stringOptional

or

remote_socket_portinteger · max: 65535Required

privatebooleanRequired

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/connections/{peer_id}

HTTPcURLJavaScriptPython

GET /network/connections/{peer_id} HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "incoming": true,
  "peer_id": "text",
  "id_point": {
    "addr": "text",
    "port": 1
  },
  "remote_socket_port": 1,
  "announced_version": {
    "chain_name": "text",
    "distributed_db_version": 1,
    "p2p_version": 1
  },
  "private": true,
  "local_metadata": {
    "disable_mempool": true,
    "private_node": true
  },
  "remote_metadata": {
    "disable_mempool": true,
    "private_node": true
  }
}

Network greylist clear

get

DEPRECATED: Clear all greylists tables. This will unban all addresses and peers automatically greylisted by the system. Use DELETE /network/greylist instead

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

objectOptional

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/greylist/clear

HTTPcURLJavaScriptPython

GET /network/greylist/clear HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{}

Network greylist IPs

get

Returns an object that contains a list of IP and the field "not_reliable_since". If the field "not_reliable_since" is None then the list contains the currently greylisted IP addresses. If the field "not_reliable_since" Contains a date, this means that the greylist has been overflowed and it is no more possible to obtain the exact list of greylisted IPs. Since the greylist of IP addresses has been design to work whatever his size, there is no security issue related to this overflow. Reinitialize the ACL structure by calling "delete /network/greylist" to get back this list reliable.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

not_reliable_sinceone of · nullableRequired

stringOptional

or

or

stringOptional

Decimal representation of 64 bit integers

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/greylist/ips

HTTPcURLJavaScriptPython

GET /network/greylist/ips HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "ips": [
    "text"
  ],
  "not_reliable_since": "text"
}

Network greylist peers

get

List of the last greylisted peers.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

stringOptional

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/greylist/peers

HTTPcURLJavaScriptPython

GET /network/greylist/peers HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  "text"
]

Network log

get

Stream of all network events

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

An event that may happen during maintenance of and other operations on the p2p connection pool. Typically, it includes connection errors, peer swaps, etc.

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/log

HTTPcURLJavaScriptPython

GET /network/log HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "event": "too_few_connections"
}

Network points

get

List the pool of known IP:port used for establishing P2P connections.

Authorizations

api-keyAuth

api-keystringRequired

Query parameters

filterstringOptional

Responses

200

Valid response

application/json

itemsone ofOptional

stringOptional

or

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/points

HTTPcURLJavaScriptPython

GET /network/points HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  [
    "text"
  ]
]

Details about a given `IP:addr`

get

Details about a given IP:addr.

Authorizations

api-keyAuth

api-keystringRequired

Path parameters

pointstringRequired

A network point (ipv4:port or [ipv6]:port).

Responses

200

Valid response

application/json

Information about a peer point. Includes flags, state, and records about past events.

trustedbooleanRequired

greylisted_untilone ofOptional

A timestamp as seen by the underlying, local computer: subsecond-level precision, epoch or rfc3339 based.

stringOptional

or

or

stringOptional

Decimal representation of 64 bit integers

stateone ofRequired

The state a connection to a peer point can be in: requested (connection open from here), accepted (handshake), running (connection already established), disconnected (no connection).

or

or

or

p2p_peer_idone ofOptional

stringOptional

or

last_failed_connectionone ofOptional

A timestamp as seen by the underlying, local computer: subsecond-level precision, epoch or rfc3339 based.

stringOptional

or

or

stringOptional

Decimal representation of 64 bit integers

last_missone ofOptional

A timestamp as seen by the underlying, local computer: subsecond-level precision, epoch or rfc3339 based.

stringOptional

or

or

stringOptional

Decimal representation of 64 bit integers

expected_peer_idone ofOptional

stringOptional

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/points/{point}

HTTPcURLJavaScriptPython

GET /network/points/{point} HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "trusted": true,
  "greylisted_until": "text",
  "state": {
    "event_kind": "requested"
  },
  "p2p_peer_id": "text",
  "last_failed_connection": "text",
  "last_rejected_connection": [
    "text"
  ],
  "last_established_connection": [
    "text"
  ],
  "last_disconnection": [
    "text"
  ],
  "last_seen": [
    "text"
  ],
  "last_miss": "text",
  "expected_peer_id": "text"
}

Check if a given address is blacklisted or greylisted

get

Check if a given address is blacklisted or greylisted. Port component is unused.

Authorizations

api-keyAuth

api-keystringRequired

Path parameters

pointstringRequired

A network point (ipv4:port or [ipv6]:port).

Responses

200

Valid response

application/json

booleanOptional

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/points/{point}/banned

HTTPcURLJavaScriptPython

GET /network/points/{point}/banned HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

true

Monitor network events related to an `IP:addr`

get

Monitor network events related to an IP:addr.

Authorizations

api-keyAuth

api-keystringRequired

Path parameters

pointstringRequired

A network point (ipv4:port or [ipv6]:port).

Query parameters

monitorstringOptional

Responses

200

Valid response

application/json

Events happening during maintenance of and operations on a peer point pool (such as connections, disconnections, connection requests).

itemsone ofOptional

stringOptional

or

or

stringOptional

Decimal representation of 64 bit integers

or

or

or

or

or

or

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/points/{point}/log

HTTPcURLJavaScriptPython

GET /network/points/{point}/log HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  [
    "text"
  ]
]

DEPRECATED Trust a given address permanently

get

DEPRECATED: Trust a given address permanently and remove it from the blacklist if present. Connections from this address can still be closed on authentication if the peer is greylisted. Use PATCH/network/point/<point_id> instead.

Authorizations

api-keyAuth

api-keystringRequired

Path parameters

pointstringRequired

A network point (ipv4:port or [ipv6]:port).

Responses

200

Valid response

application/json

objectOptional

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/points/{point}/trust

HTTPcURLJavaScriptPython

GET /network/points/{point}/trust HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{}

DEPRECATED Remove an address from the blacklist

get

DEPRECATED: Remove an address from the blacklist. Use PATCH /network/point/<point_id> instead.

Authorizations

api-keyAuth

api-keystringRequired

Path parameters

pointstringRequired

A network point (ipv4:port or [ipv6]:port).

Responses

200

Valid response

application/json

objectOptional

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/points/{point}/unban

HTTPcURLJavaScriptPython

GET /network/points/{point}/unban HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{}

DEPRECATED Remove an address from the whitelist

get

DEPRECATED: Remove an address from the whitelist. Use PATCH /network/point/<point_id> instead.

Authorizations

api-keyAuth

api-keystringRequired

Path parameters

pointstringRequired

A network point (ipv4:port or [ipv6]:port).

Responses

200

Valid response

application/json

objectOptional

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/points/{point}/untrust

HTTPcURLJavaScriptPython

GET /network/points/{point}/untrust HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{}

Node's peer id

get

Return the node's peer id

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

stringOptional

or

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/self

HTTPcURLJavaScriptPython

GET /network/self HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

text

Global network bandwidth statistics in B/s

get

Global network bandwidth statistics in B/s.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

Statistics about the p2p network.

total_sentstringRequired

Decimal representation of 64 bit integers

total_recvstringRequired

Decimal representation of 64 bit integers

current_inflowinteger · min: -1073741824 · max: 1073741823Required

current_outflowinteger · min: -1073741824 · max: 1073741823Required

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/stat

HTTPcURLJavaScriptPython

GET /network/stat HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "total_sent": "text",
  "total_recv": "text",
  "current_inflow": 1,
  "current_outflow": 1
}

Network protocol version

get

DEPRECATED: use version instead.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

A version number for the network protocol (includes distributed DB version and p2p version)

chain_nameone ofRequired

A name for the distributed DB protocol

stringOptional

or

distributed_db_versioninteger · max: 65535Required

A version number for the distributed DB protocol

p2p_versioninteger · max: 65535Required

A version number for the p2p layer.

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/version

HTTPcURLJavaScriptPython

GET /network/version HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "chain_name": "text",
  "distributed_db_version": 1,
  "p2p_version": 1
}

Supported network protocol versions

get

DEPRECATED: use version instead.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Valid response

application/json

A version number for the network protocol (includes distributed DB version and p2p version)

chain_nameone ofRequired

A name for the distributed DB protocol

stringOptional

or

distributed_db_versioninteger · max: 65535Required

A version number for the distributed DB protocol

p2p_versioninteger · max: 65535Required

A version number for the p2p layer.

400

Bad Request - missing or invalid parameters

application/json

404

Not Found error

application/json

500

Internal server error

application/json

get

/network/versions

HTTPcURLJavaScriptPython

GET /network/versions HTTP/1.1
Host: xtz.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "chain_name": "text",
    "distributed_db_version": 1,
    "p2p_version": 1
  }
]