Returns private information about this node.

GET 
//v1/node/info

Authorization: Authorization

name: Authorizationtype: apiKeydescription: JWT Tokenin: header

Returns private information about this node.

Request

Responses

200

Returns information about this node.

application/json

Schema

Schema

l1Params L1Paramsrequired

baseToken BaseTokenrequired

decimals int32required

The token decimals

name stringrequired

The base token name

subunit stringrequired

The token subunit

tickerSymbol stringrequired

The ticker symbol

unit stringrequired

The token unit

useMetricPrefix booleanrequired

Whether or not the token uses a metric prefix

maxPayloadSize int32required

The max payload size

protocol ProtocolParametersrequired

bech32Hrp stringrequired

The human readable network prefix

belowMaxDepth int32required

Possible values: >= 1

The networks max depth

minPowScore int32required

Possible values: >= 1

The minimal PoW score

networkName stringrequired

The network name

rentStructure RentStructurerequired

vByteCost int32required

Possible values: >= 1

The virtual byte cost

vByteFactorData int32required

The virtual byte factor for data fields

vByteFactorKey int32required

The virtual byte factor for key/lookup generating fields

tokenSupply stringrequired

The token supply

version int32required

The protocol version

peeringURL stringrequired

The net id of the node

publicKey stringrequired

The public key of the node (Hex)

version stringrequired

The version of the node

Example (from schema)

{
  "peeringURL": "0.0.0.0:4000",
  "l1Params": {
    "protocol": {
      "rentStructure": {
        "vByteFactorData": 1,
        "vByteCost": 500,
        "vByteFactorKey": 10
      },
      "minPowScore": 1,
      "tokenSupply": "2779530283277761",
      "networkName": "private_tangle1",
      "belowMaxDepth": 15,
      "version": 2,
      "bech32Hrp": "tst"
    },
    "maxPayloadSize": 32498,
    "baseToken": {
      "unit": "TEST",
      "decimals": 6,
      "name": "TestCoin",
      "tickerSymbol": "TEST",
      "subunit": "testies",
      "useMetricPrefix": true
    }
  },
  "publicKey": 6.50081931316715e+76,
  "version": "0.4.0-alpha.2-390-g5470f1925"
}

401

Unauthorized (Wrong permissions, missing token)

application/json

Schema

Schema

error stringrequired
missingPermission stringrequired

Example (from schema)

{
  "error": "string",
  "missingPermission": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET '/v1/node/info' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

Auth

Authorization

ResponseClear

Click the Send API Request button above and see the response here!