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.
- Request Method: GET
- Request:
-
- Response: ConfigurationViewModel
- Dependent from NIS: No
/configuration/update
Updates the current configuration with the given values.
- Request Method: POST
- Request: ConfigurationViewModel
- Response:
-
- Dependent from NIS: No
/addressbook/create
Creates a new, empty address book. The address book is stored encrypted in the configured address book directory. The name of the address book file is the encoded (URL encoded) version of the address book name. The provided password is used to encrypt the address book.
- Request Method: POST
- Request: AddressBookNamePasswordPair
- Response: AddressBookViewModel
- Dependent from NIS: No
/addressbook/open
Open an address book. The address book is defined by the address book name. The address book has to be located in the address book storage location. The password must match the password of the given address book.
- Request Method: POST
- Request: AddressBookNamePasswordPair
- Response: AddressBookViewModel
- Dependent from NIS: No
/addressbook/info
Returns information about an address book that is already open.
- Request Method: POST
- Request: AddressBookName
- Response: AddressBookViewModel
- Dependent from NIS: No
/addressbook/close
Closes an address book by removing it from the list of opened address books.
- Request Method: POST
- Request: AddressBookName
- Response:
-
- Dependent from NIS: No
/addressbook/password/change
Changes the password of an address book.
- Request Method: POST
- Request: AddressBookNamePasswordBag
- Response:
-
- Dependent from NIS: No
/addressbook/name/change
Changes the name of an address book.
- Request Method: POST
- Request: AddressBookNamePasswordBag
- Response:
-
- Dependent from NIS: No
/addressbook/accountlabel/remove
Removes an existing account label from an address book.
- Request Method: POST
- Request: AddressBookNamePasswordBag
- Response: AddressBookViewModel
- Dependent from NIS: No
/addressbook/accountlabel/add
Adds an account label to an address book.
- Request Method: POST
- Request: AddressBookNamePasswordBag
- Response: AccountLabel
- Dependent from NIS: No
/addressbook/accountlabel/change
Changes an existing account label in an address book.
- Request Method: POST
- Request: AddressBookNamePasswordBag
- Response: AccountLabel
- Dependent from NIS: No
/addressbook/accountlabel/find
Gets an existing account label from an address book. The address parameter in the AddressBookNamePasswordBag must be supplied.
- Request Method: POST
- Request: AddressBookNamePasswordBag
- Response: AccountLabel
- Dependent from NIS: No
/wallet/list
Gets all wallets that are located at the configured storage location for wallets.
- Request Method: GET
- Request:
-
- Response: ListOfWalletDescriptorViewModel
- Dependent from NIS: No
/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.
- Request Method: POST
- Request: WalletNamePasswordPair
- Response: WalletViewModel
- Dependent from NIS: No
/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.
- Request Method: POST
- Request: WalletNamePasswordPair
- Response: WalletViewModel
- Dependent from NIS: No
/wallet/info
Returns information about a wallet that is already open.
- Request Method: POST
- Request: WalletName
- Response: WalletViewModel
- Dependent from NIS: No
/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.
- Request Method: POST
- Request: WalletNamePasswordBag
- Response:
-
- Dependent from NIS: No
/wallet/name/change
Changes the name of a wallet.
- Request Method: POST
- Request: WalletNamePasswordBag
- Response:
-
- Dependent from NIS: No
/wallet/account/new
Adds a new account to the wallet.
- Request Method: POST
- Request: WalletNamePasswordBag
- Response: AccountViewModel
- Dependent from NIS: No
/wallet/account/primary
Sets an existing account to be the primary account.
- Request Method: POST
- Request: WalletNamePasswordBag
- Response: WalletViewModel
- Dependent from NIS: No
/wallet/account/remove
Removes an existing account from a wallet.
- Request Method: POST
- Request: WalletNamePasswordBag
- Response: WalletViewModel
- Dependent from NIS: No
/wallet/account/label
Updates the label of an existing account.
- Request Method: POST
- Request: WalletNamePasswordBag
- Response: AccountViewModel
- Dependent from NIS: No
/wallet/account/transaction/send
Sends a new transaction (i.e., sending NEM, messages, assets).
- Request Method: POST
- Request: TransferSendRequest
- Response:
-
- Dependent from NIS: Yes
/wallet/account/transaction/validate
Validates a new transaction (i.e., sending NEM, messages, assets) and provides information on fee and encryption possibility.
- Request Method: POST
- Request: PartialTransferInformationRequest
- Response: PartialTransferInformationViewModel
- Dependent from NIS: Yes
/wallet/account/unlock
Unlock the account on the connected NIS server (start harvesting).
- Request Method: POST
- Request: AccountWalletRequest
- Response:
-
- Dependent from NIS: Yes
/wallet/account/lock
Lock the account on the connected NIS server (stop harvesting).
- Request Method: POST
- Request: AccountWalletRequest
- Response:
-
- Dependent from NIS: Yes
/wallet/account/remote/activate
Announces activation of delegated harvesting account to the network (FEE: 1)
- Request Method: POST
- Request: TransferImportanceRequest
- Response:
-
- Dependent from NIS: Yes
/wallet/account/remote/deactivate
Announces deactivation of delegated harvesting account to the network (FEE: 1)
- Request Method: POST
- Request: TransferImportanceRequest
- Response:
-
- Dependent from NIS: Yes
/wallet/account/remote/status
Checks if account is unlocked on remote server, will return an error if
- Request Method: POST
- Request: AccountWalletRequest
- Response: AccountStatusViewModel
- Dependent from NIS: Yes
/wallet/account/remote/unlock
Unlock the account on the remote NIS server (start delegated harvesting).
- Request Method: POST
- Request: AccountWalletPasswordRequest
- Response:
-
- Dependent from NIS: Yes
/wallet/account/remote/lock
Lock the account on the remote NIS server (stop delegated harvesting).
- Request Method: POST
- Request: AccountWalletPasswordRequest
- Response:
-
- Dependent from NIS: Yes
/account/find
Gets information about the specified account. Looks-up an account which is known by its address id
- Request Method: POST
- Request: AccountIdRequest
- Response: AccountViewModel
- Dependent from NIS: Yes
/account/transactions/unconfirmed
Gets information about the specified account and unconfirmed transactions.
- Request Method: POST
- Request: AccountHashRequest
- Response: AccountTransactionsPair
- Dependent from NIS: Yes
/account/transactions/confirmed
Gets information about the specified account and confirmed transactions.
- Request Method: POST
- Request: AccountTransactionIdRequest
- Response: AccountTransactionsPair
- Dependent from NIS: Yes
/account/transactions/incoming
Gets information about the specified account and incoming transactions.
- Request Method: POST
- Request: AccountTransactionIdRequest
- Response: AccountTransactionsPair
- Dependent from NIS: Yes
/account/transactions/outgoing
Gets information about the specified account and outgoing transactions.
- Request Method: POST
- Request: AccountTransactionIdRequest
- Response: AccountTransactionsPair
- Dependent from NIS: Yes
/account/transactions/all
Gets information about the specified account and incoming and outgoing transactions.
- Request Method: POST
- Request: AccountTransactionIdRequest
- Response: TransferViewModel
- Dependent from NIS: Yes
/account/harvests
Retrieves a list of infos on harvested blocks for an account.
- Request Method: POST
- Request: AccountHashRequest
- Response: HarvestInfoViewModelList
- Dependent from NIS: Yes
/node/boot
Boots the local node.
- Request Method: POST
- Request: BootNodeRequest
- Response: -
- Dependent from NIS: Yes
/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.
- Request Method: POST
- Request: NodeEndpointList
- Response: GraphViewModel
- Dependent from NIS: Yes
/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