Node

Get all nodes

GET https://www.allnodes.com/api/v1/node

This endpoint allows to get list of all your hosted nodes.

Headers

Name	Type	Description
Authorization*	string	Bearer TOKEN

200

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

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

This endpoint allows to get info about specific node on your account.

Path Parameters

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

Headers

Name	Type	Description
Authorization*	string	Bearer TOKEN

200

{
  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 Node not found

{
  "error": "NODE_NOT_FOUND"
}

Remove a node

DELETE https://www.allnodes.com/api/v1/node/{id}

This endpoint allows you to remove node from hosting.

Path Parameters

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

Headers

Name	Type	Description
Authorization*	string	Bearer TOKEN

204 Node successfully removed

404 Example of error response

{
  "error": "NODE_NOT_FOUND"
}