Node

Host a node

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

This endpoint allows you to host new node.

Headers

Name	Type	Description
Authorization*	string	Bearer TOKEN

Request Body

Name	Type	Description
currencySymbol	string	Must be "FIRO"
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"

201 Node successfully added.

{
  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;
  };
}

404 Example of error response.

{
  "error": "INVALID_CURRENCY_SYMBOL"
}

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

Name	Type	Description
address*	string	Your collateral address

Headers

Name	Type	Description
Authorization*	string	Bearer TOKEN

200

[
  {
    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

Name	Type	Description
hash*	string	Your collateral UTXO hash
index*	number	Your collateral UTXO index

Headers

Name	Type	Description
Authorization*	string	Bearer TOKEN

200

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

400

{
  "error": "INVALID_COLLATERAL_HASH_AND_INDEX"
}

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

Name	Type	Description
id*	string	Node you want to register. ID can be extracted from the “Get all nodes” call

Query Parameters

Name	Type	Description
payeeAddress	string	Address for receiving masternode rewards

Headers

Name	Type	Description
Authorization*	string	Bearer TOKEN

200

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

400

{
  "error": "INVALID_PAYEE_ADDRESS"
}

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

Name	Type	Description
id*	string	Node you want to register. ID can be extracted from the “Get all nodes” call

Headers

Name	Type	Description
Authorization*	string	Bearer TOKEN

Request Body

Name	Type	Description
signature	string	Signed "signMessage" from protx register_prepare command output
tx	string	"tx" from protx register_prepare command output

200

{
  hash: string;
}

400

{
  "error": "INVALID_SIGNATURE"
}