Infos

Get basic ALPH node information

get

Returns the build version, commit hash, UPnP configuration, and the external address (if available) of the ALPH node.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Node information retrieved successfully.

application/json

upnpbooleanRequired

Indicates whether UPnP (Universal Plug and Play) is enabled.

Example: true

externalAddressstring · nullableRequired

The external IP address detected by the node. May be null if not available or not configured.

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/node

HTTPcURLJavaScriptPython

GET /infos/node HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "buildInfo": {
    "releaseVersion": "4.0.4",
    "commit": "cdcf3e2a09e4414729de08b21c7087992b98eb18"
  },
  "upnp": true,
  "externalAddress": null
}

Get ALPH Node Software Version

get

Returns the current version of the ALPH node software.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Version information retrieved successfully.

application/json

versionstringRequired

Current version of the ALPH node.

Example: v4.0.4

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/version

HTTPcURLJavaScriptPython

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

{
  "version": "v4.0.4"
}

Get Chain Parameters

get

Returns various blockchain configuration parameters used by the ALPH node.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Chain parameters retrieved successfully.

application/json

networkIdintegerRequired

Numeric ID representing the blockchain network (e.g. 0 = mainnet, 1 = testnet).

Example: 0

numZerosAtLeastInHashintegerRequired

Minimum number of leading zeros required in the block hash (difficulty setting).

Example: 37

groupNumPerBrokerintegerRequired

Number of groups handled per broker.

Example: 4

groupsintegerRequired

Total number of groups in the network.

Example: 4

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/chain-params

HTTPcURLJavaScriptPython

GET /infos/chain-params HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "networkId": 0,
  "numZerosAtLeastInHash": 37,
  "groupNumPerBroker": 4,
  "groups": 4
}

Get Self Clique Information

get

Returns information about the current node's clique, including clique ID, participating nodes, and sync status.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Self clique information retrieved successfully.

application/json

cliqueIdstringRequired

Unique identifier of the clique the node belongs to.

Example: 0272a124586f31dbe068b953fb2214657f4747f109d2e9b15c36cb222082979067

selfReadybooleanRequired

Indicates whether the current node is ready within the clique.

Example: true

syncedbooleanRequired

Indicates whether the current node is fully synchronized.

Example: true

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/self-clique

HTTPcURLJavaScriptPython

GET /infos/self-clique HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "cliqueId": "0272a124586f31dbe068b953fb2214657f4747f109d2e9b15c36cb222082979067",
  "nodes": [
    {
      "address": "0.0.0.0",
      "restPort": 12973,
      "wsPort": 11973,
      "minerApiPort": 10973
    }
  ],
  "selfReady": true,
  "synced": true
}

Get Inter-Clique Peer Information

get

Returns a list of peers from other cliques that the node is aware of, including their clique IDs, sync status, and client version.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Peer information retrieved successfully.

application/json

cliqueIdstringRequired

Unique identifier of the peer's clique.

Example: 03de24c07d2e742cd4ad4053e1a3234d198bc6a076432d9cca5f654792074dd96f

brokerIdintegerRequired

Broker ID associated with the peer.

Example: 0

groupNumPerBrokerintegerRequired

Number of groups managed by the peer's broker.

Example: 4

isSyncedbooleanRequired

Indicates whether the peer is synchronized.

Example: true

clientVersionstringRequired

Version and platform details of the peer's client.

Example: scala-alephium/v4.0.4/Linux/p2p-v2

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/inter-clique-peer-info

HTTPcURLJavaScriptPython

GET /infos/inter-clique-peer-info HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "cliqueId": "03de24c07d2e742cd4ad4053e1a3234d198bc6a076432d9cca5f654792074dd96f",
    "brokerId": 0,
    "groupNumPerBroker": 4,
    "address": {
      "addr": "139.99.16.105",
      "port": 9973
    },
    "isSynced": true,
    "clientVersion": "scala-alephium/v4.0.4/Linux/p2p-v2"
  }
]

Get Discovered Neighboring Peers

get

Returns a list of discovered neighbors from other cliques, including their clique ID, broker ID, broker number, and network address.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Discovered neighbors retrieved successfully.

application/json

cliqueIdstringRequired

Unique identifier of the discovered peer's clique.

Example: 037e0a046eda3de8e42cfe2bdebea7033bb779d99efa7b9c36b2c940695eb21942

brokerIdintegerRequired

ID of the broker within the clique.

Example: 0

brokerNumintegerRequired

Number of brokers in the clique.

Example: 1

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/discovered-neighbors

HTTPcURLJavaScriptPython

GET /infos/discovered-neighbors HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "cliqueId": "037e0a046eda3de8e42cfe2bdebea7033bb779d99efa7b9c36b2c940695eb21942",
    "brokerId": 0,
    "brokerNum": 1,
    "address": {
      "addr": "195.154.210.36",
      "port": 19140
    }
  }
]

Get Misbehaving Peers

get

Returns a list of peers that have been flagged for misbehavior, including their status and ban information.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Misbehaving peer list retrieved successfully.

application/json

peerstringRequired

IP address of the misbehaving peer.

Example: 77.223.102.9

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/misbehaviors

HTTPcURLJavaScriptPython

GET /infos/misbehaviors HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "peer": "77.223.102.9",
    "status": {
      "type": "Banned",
      "until": 1754943461295
    }
  }
]

Get Unreachable Peers

get

Returns a list of peer IP addresses that are currently unreachable from this node.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

List of unreachable peers retrieved successfully.

application/json

string · ipv4[]Optional

IP address of an unreachable peer.

Example: 77.223.102.9

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/unreachable

HTTPcURLJavaScriptPython

GET /infos/unreachable HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

[
  "77.223.102.9"
]

Get Historical Hashrate Summary

get

Returns a summary string representing the node's hashrate over the specified time range.

Authorizations

api-keyAuth

api-keystringRequired

Query parameters

fromTsinteger · int64Required

Start timestamp (Unix ms) for the requested hashrate history.

Example: 1622548800000

toTsinteger · int64Required

End timestamp (Unix ms) for the requested hashrate history.

Example: 1622635200000

Responses

200

Historical hashrate summary retrieved successfully.

application/json

hashratestringRequired

Hashrate summary with unit (e.g., "0 MH/s").

Example: 0 MH/s

400

Invalid or missing query parameters.

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/history-hashrate

HTTPcURLJavaScriptPython

GET /infos/history-hashrate?fromTs=1622548800000&toTs=1622635200000 HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "hashrate": "0 MH/s"
}

Get Current Hashrate

get

Returns the current hashrate of the node as a string with units.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Current hashrate retrieved successfully.

application/json

hashratestringRequired

Current hashrate with unit (e.g., "19812439796 MH/s").

Example: 19812439796 MH/s

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/current-hashrate

HTTPcURLJavaScriptPython

GET /infos/current-hashrate HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "hashrate": "19812439796 MH/s"
}

Get Current Difficulty

get

Returns the current network difficulty as a string.

Authorizations

api-keyAuth

api-keystringRequired

Responses

200

Current difficulty retrieved successfully.

application/json

difficultystringRequired

Current network difficulty value.

Example: 617922583757445

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

500

InternalServerError

application/json

503

ServiceUnavailable

application/json

get/infos/current-difficulty

HTTPcURLJavaScriptPython

GET /infos/current-difficulty HTTP/1.1
Host: alephium.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

{
  "difficulty": "617922583757445"
}