Node

Host a node

POST https://www.allnodes.com/api/v1/node/hosting

This endpoint allows you to host new node.

Headers

NameTypeDescription

Authorization*

string

Bearer TOKEN

Request Body

NameTypeDescription

currencySymbol

string

Must be "SYS"

collateralHash

string

Hash of your collateral UTXO

collateralIndex

number

Index of your collateral UTXO

nodeName

string

Name of your new node

walletType

string

"ledger" | "trezor" | "core"

{
  id: string;
  ip: string;
  name: string;
  currencySymbol: string;
  createdAt: string;
  payoutFrequencySeconds: number | null;
  apr: string | null;
  instance: {
    version: string;
    status: string;
    uptimeSeconds: number | null;
    lastSeenAt: string | null;
  };
  address: {
    collateralAddress: string;
    collateralHash: string;
    collateralIndex: number;
    payeeAddress: string;
    balanceAmount: number;
    rewardsEarned: number;
    lastRewardAt: string | null;
  };
  settings: {
    walletType: 'ledger' | 'trezor' | 'core' | null;
  };
}

Get UTXO

GET https://www.allnodes.com/api/v1/node/utxo/{address}

This endpoint allows you to get list of all your collateral utxo.

Path Parameters

NameTypeDescription

address*

string

Your collateral address

Headers

NameTypeDescription

Authorization*

string

Bearer TOKEN

[
  {
    hash: string;
    index: number;
  }
]

Get hosting state

GET https://www.allnodes.com/api/v1/node/state/{hash}-{index}

This endpoint allows you to get hosting state of your collateral utxo.

Path Parameters

NameTypeDescription

hash*

string

Your collateral UTXO hash

index*

number

Your collateral UTXO index

Headers

NameTypeDescription

Authorization*

string

Bearer TOKEN

{
  isAlreadyHosted: boolean;
  isAlreadyHostedOnAllnodes: boolean;
  isActivated: boolean;
  isBanned: boolean;
}

Execute "protx register_prepare" command and get output

GET https://www.allnodes.com/api/v1/node/{id}/deterministic/prepare

This endpoint allows you to get results of "protx register_submit" command executed on our full node.

Path Parameters

NameTypeDescription

id*

string

Node you want to register. ID can be extracted from the “Get all nodes” call

Query Parameters

NameTypeDescription

payeeAddress

string

Address for receiving masternode rewards

Headers

NameTypeDescription

Authorization*

string

Bearer TOKEN

{
  tx: string;
  collateralAddress: string;
  signMessage: string;
}

Execute "protx register_submit" command

POST https://www.allnodes.com/api/v1/node/{id}/deterministic/submit

This endpoint allows you to execute "protx register_submit" command on our full node with data provided through the API call. Registration in deterministic list will happen in 1 block after execution.

Path Parameters

NameTypeDescription

id*

string

Node you want to register. ID can be extracted from the “Get all nodes” call

Headers

NameTypeDescription

Authorization*

string

Bearer TOKEN

Request Body

NameTypeDescription

signature

string

Signed "signMessage" from protx register_prepare command output

tx

string

"tx" from protx register_prepare command output

{
  hash: string;
}

Last updated