Skip to content

Latest commit

 

History

History
321 lines (238 loc) · 9.72 KB

api.md

File metadata and controls

321 lines (238 loc) · 9.72 KB

The following API list is not yet complete and will likely be changed during implementation. The web-context is defined as /ncc/api (full URI would be, for instance, /ncc/api/client/info)

Amount values are all in the smallest possible NEM fraction, that means that 1000000 means 1.000000 NEM.

Rest calls must have the content type set:

Content-Type: application/json

/info/ncc

Gets information about the NCC server.

  • Request Method: GET
  • Request: -
  • Response: NisInfoViewModel
  • Dependent from NIS: No

/info/nis

Gets information about the NIS server.

  • Request Method: GET
  • Request: -
  • Response: NisInfoViewModel
  • Dependent from NIS: Yes

/info/nis/check

Checks availability of NIS server.

  • Request Method: GET
  • Request: -
  • Response:

** 0 - NIS server is not running ** 1 - NIS server is running (but may not be booted)

  • Dependent from NIS: Yes

/configuration/get

Gets the current configuration.

/configuration/update

Updates the current configuration with the given values.

/wallet/list

Gets all wallets that are located at the configured storage location for wallets.

/wallet/create

Creates a new wallet with one account in it. The wallet is stored encrypted in the configured wallet directory. The name of the wallet file is the encoded (URL encoded) version of the wallet name. The provided password is used to encrypt the wallet.

/wallet/open

Open a wallet. The wallet is defined by the wallet name. The wallet has to be located in the wallet storage location. The password must match the password of the given wallet. For opening a wallet at a different location the function importWallet has to be used.

/wallet/info

Returns information about a wallet that is already open.

/wallet/close

Closes a wallet by removing it from the list of opened wallets.

  • Request Method: POST
  • Request: WalletName
  • Response: -
  • Dependent from NIS: No

/wallet/password/change

Changes the password of a wallet.

/wallet/name/change

Changes the password of a wallet.

/wallet/account/new

Adds a new account to the wallet.

/wallet/account/primary

Sets an existing account to be the primary account.

/wallet/account/remove

Removes an existing account from a wallet.

/wallet/account/label

Updates the label of an existing account.

/wallet/account/transaction/send

Sends a new transaction (i.e., sending NEM, messages, assets).

/wallet/account/transaction/validate

Validates a new transaction (i.e., sending NEM, messages, assets) and provides information on fee and encryption possibility.

/wallet/account/unlock

Unlock the account on the connected NIS server (start foraging).

/wallet/account/lock

Lock the account on the connected NIS server (stop foraging).

/wallet/account/remote/activate

Announces activation of remote harvesting account to the network (FEE: 1)

/wallet/account/remote/deactivate

Announces deactivation of remote harvesting account to the network (FEE: 1)

/wallet/account/remote/status

Checks if account is unlocked on remote server, will return an error if

/wallet/account/remote/unlock

Unlock the account on the remote NIS server (start secure foraging).

/wallet/account/remote/lock

Lock the account on the remote NIS server (stop secure foraging).

/account/find

Gets information about the specified account. Looks-up an account which is known by its address id

/account/transactions/unconfirmed

Gets information about the specified account and unconfirmed transactions.

/account/transactions/incoming

Gets information about the specified account and incoming transactions.

/account/transactions/outgoing

Gets information about the specified account and outgoing transactions.

/account/transactions/all

Gets information about the specified account and incoming and outgoing transactions.

/account/harvests

Retrieves a list of infos on harvested blocks for an account.

/node/boot

Boots the local node.

/node/status

Checks the status of the local node.

  • Request Method: GET
  • Request: -
  • Response: NemRequestResult
  • Dependent from NIS: Yes

/network

Requests a view model for the peers to which the specified peers are connected.

/network/local

Requests a view model for the peers to which the local NIS is connected.

  • Request Method: GET
  • Request: -
  • Response: GraphViewModel
  • Dependent from NIS: Yes

/shutdown

Stops the NCC server. After that NCC GUI does not respond to any clicks.

  • Request Method: GET
  • Request: -
  • Response: -
  • Dependent from NIS: No

/status

Gets the current status of the NCC server. Currently it is only 'running' (3).

  • Request Method: GET
  • Request: -
  • Response: NemRequestResult
  • Dependent from NIS: No