Home

NEM NIS API

v1.0.0
Base URL
https://xem.nownodes.io

Version 1.19

19:27, March 20, 2017

http://bob.nem.ninja/docs/

Authentication

api-keyAuthapiKey

API Key: api-key in header

General

Heartbeat

Heart beat

GET
https://xem.nownodes.io/heartbeat

Heart beat

Response

200OK

Authorization

api-keyAuthapiKey in header

Status

Status

GET
https://xem.nownodes.io/status

Status

Response

200OK

Authorization

api-keyAuthapiKey in header

Account

Retrieving account data

GET
https://xem.nownodes.io/account/generate

Retrieving account data

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting the account data

GET
https://xem.nownodes.io/account/get

Requesting the account data

Parameters

addressstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting the account data (public key)

GET
https://xem.nownodes.io/account/get/from-public-key

Requesting the account data (public key)

Parameters

publicKeystringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting the original account data for a delegate account

GET
https://xem.nownodes.io/account/get/forwarded

Requesting the original account data for a delegate account

Parameters

addressstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting the original account data for a delegate account (Public key)

GET
https://xem.nownodes.io/account/get/forwarded/from-public-key

Requesting the original account data for a delegate account (Public key)

Parameters

publicKeystringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting the account status

GET
https://xem.nownodes.io/account/status

Requesting the account status

Parameters

addressstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting transaction data for an account (Incoming)

GET
https://xem.nownodes.io/account/transfers/incoming

Requesting transaction data for an account (Incoming)

Parameters

addressstringquery
hashstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting transaction data for an account (Outgoing)

GET
https://xem.nownodes.io/account/transfers/outgoing

Requesting transaction data for an account (Outgoing)

Parameters

addressstringquery
hashstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting transaction data for an account (All)

GET
https://xem.nownodes.io/account/transfers/all

Requesting transaction data for an account (All)

Parameters

addressstringquery
hashstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Unconfirmed transactions

GET
https://xem.nownodes.io/account/unconfirmedTransactions

Unconfirmed transactions

Parameters

addressstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting harvest info data for an account

GET
https://xem.nownodes.io/account/harvests

Requesting harvest info data for an account

Parameters

addressstringquery
hashstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Retrieving account importances for accounts

GET
https://xem.nownodes.io/account/importances

Retrieving account importances for accounts

Response

200OK

Authorization

api-keyAuthapiKey in header

Retrieving namespaces that an account owns

GET
https://xem.nownodes.io/account/namespace/page

Retrieving namespaces that an account owns

Parameters

addressstringquery
parentstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Retrieving mosaic definitions that an account has created

GET
https://xem.nownodes.io/account/mosaic/definition/page

Retrieving mosaic definitions that an account has created

Parameters

addressstringquery
parentstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Retrieving mosaics that an account owns

GET
https://xem.nownodes.io/account/mosaic/owned

Retrieving mosaics that an account owns

Parameters

addressstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Retrieving historical account data

GET
https://xem.nownodes.io/account/historical/get

Retrieving historical account data

Parameters

addressstringquery
startHeightstringquery
endHeightstringquery
incrementstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Unlocking the account (enables harvesting)

POST
https://xem.nownodes.io/account/unlock

Unlocking the account (enables harvesting)

Body

multipart/form-data
privateKeystring

Response

200OK

Authorization

api-keyAuthapiKey in header

Locking the account (stops harvesting)

POST
https://xem.nownodes.io/account/lock

Locking the account (stops harvesting)

Body

multipart/form-data
privateKeystring

Response

200OK

Authorization

api-keyAuthapiKey in header

Retrieving the unlock info

POST
https://xem.nownodes.io/account/unlocked/info

Retrieving the unlock info

Response

200OK

Authorization

api-keyAuthapiKey in header

Chain

Block chain height

GET
https://xem.nownodes.io/chain/height

Block chain height

Response

200OK

Authorization

api-keyAuthapiKey in header

Block chain score

GET
https://xem.nownodes.io/chain/score

Block chain score

Response

200OK

Authorization

api-keyAuthapiKey in header

Last block of the block chain score

GET
https://xem.nownodes.io/chain/last-block

Last block of the block chain score

Response

200OK

Authorization

api-keyAuthapiKey in header

Block

Getting a block with a given hash

GET
https://xem.nownodes.io/block/get

Getting a block with a given hash

Parameters

blockHashstringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Getting a block with a given height

POST
https://xem.nownodes.io/block/at/public

Getting a block with a given height

Body

multipart/form-data
blockHeight string

Response

200OK

Authorization

api-keyAuthapiKey in header

Node

Basic node information

GET
https://xem.nownodes.io/node/info

Basic node information

Response

200OK

Authorization

api-keyAuthapiKey in header

Extended node information

GET
https://xem.nownodes.io/node/extended-info

Extended node information

Response

200OK

Authorization

api-keyAuthapiKey in header

Complete neighborhood

GET
https://xem.nownodes.io/node/peer-list/all

Complete neighborhood

Response

200OK

Authorization

api-keyAuthapiKey in header

Reachable neighborhood

GET
https://xem.nownodes.io/node/peer-list/reachable

Reachable neighborhood

Response

200OK

Authorization

api-keyAuthapiKey in header

Active neighborhood

GET
https://xem.nownodes.io/node/peer-list/active

Active neighborhood

Response

200OK

Authorization

api-keyAuthapiKey in header

Maximum chain height in the active neighborhood

GET
https://xem.nownodes.io/node/active-peers/max-chain-height

Maximum chain height in the active neighborhood

Response

200OK

Authorization

api-keyAuthapiKey in header

Requesting node experiences

GET
https://xem.nownodes.io/node/experiences

Requesting node experiences

Response

200OK

Authorization

api-keyAuthapiKey in header

Booting the local node

POST
https://xem.nownodes.io/node/boot

Booting the local node

Body

multipart/form-data
bootNodeRequeststring

Response

200OK

Authorization

api-keyAuthapiKey in header

Namespace

Retrieving root namespaces

GET
https://xem.nownodes.io/namespace/roots

Retrieving root namespaces

Parameters

idstringquery
pageSize;stringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Retrieving a specific namespace

GET
https://xem.nownodes.io/namespace

Retrieving a specific namespace

Parameters

namespacestringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Retrieving mosaic definitions

GET
https://xem.nownodes.io/namespace/mosaic/definition/page

Retrieving mosaic definitions

Parameters

namespacestringquery

Response

200OK

Authorization

api-keyAuthapiKey in header

Debug

Monitoring the network time

GET
https://xem.nownodes.io/debug/time-synchronization

Monitoring the network time

Response

200OK

Authorization

api-keyAuthapiKey in header

Monitoring incoming calls

GET
https://xem.nownodes.io/debug/connections/incoming

Monitoring incoming calls

Response

200OK

Authorization

api-keyAuthapiKey in header

Monitoring outgoing calls

GET
https://xem.nownodes.io/debug/connections/outgoing

Monitoring outgoing calls

Response

200OK

Authorization

api-keyAuthapiKey in header

Monitoring timers

GET
https://xem.nownodes.io/debug/timers

Monitoring timers

Response

200OK

Authorization

api-keyAuthapiKey in header

Local

Incoming transactions with decoded messages

POST
https://xem.nownodes.io/local/account/transfers/incoming

Incoming transactions with decoded messages

Body

multipart/form-data
pagestring

Response

200OK

Authorization

api-keyAuthapiKey in header

Outgoing transactions with decoded messages

POST
https://xem.nownodes.io/local/account/transfers/outgoing

Outgoing transactions with decoded messages

Body

multipart/form-data
pagestring

Response

200OK

Authorization

api-keyAuthapiKey in header

All transactions with decoded messages

POST
https://xem.nownodes.io/local/account/transfers/all

All transactions with decoded messages

Body

multipart/form-data
pagestring

Response

200OK

Authorization

api-keyAuthapiKey in header

Getting part of a chain

POST
https://xem.nownodes.io/local/chain/blocks-after

Getting part of a chain

Body

multipart/form-data
blockHeightstring

Response

200OK

Authorization

api-keyAuthapiKey in header

Transaction

Initiating a transaction

POST
https://xem.nownodes.io/transaction/prepare-announce

Initiating a transaction

Body

multipart/form-data
requestPrepareAnnouncestring

Response

200OK

Authorization

api-keyAuthapiKey in header

Sending the data to NIS

POST
https://xem.nownodes.io/transaction/announce

Sending the data to NIS

Body

multipart/form-data
requestAnnouncestring

Response

200OK

Authorization

api-keyAuthapiKey in header