Accounts

From ArdorDocs
Jump to: navigation, search

Contents

Get Account

Get account information given an account ID. Javadoc

Request:

  • requestType is getAccount
  • account is the account ID
  • includeLessors is true to include lessors, lessorsRS and lessorsInfo (optional)
  • includeAssets is true to include assetBalances and unconfirmedAssetBalances (optional)
  • includeCurrencies is true to include accountCurrencies (optional)
  • includeEffectiveBalance is true to include effectiveBalanceNXT and guaranteedBalanceNQT (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • forgedBalanceFQT (S) is the balance (in FQT) that the account has forged
  • assetBalances (A) is an array of asset objects including the fields balanceQNT (S) and asset (S) ID
  • unconfirmedAssetBalances (A) is an array of asset objects including the fields unconfirmedBalanceQNT (S) and asset (S) ID
  • accountCurrencies (A) is an array of currency objects (refer to Get Account Currencies for details)
  • lessorsInfo (A) is an array of lessor objects including the fields:
    • currentHeightTo (S)
    • nextHeightFrom (S)
    • nextLesseeRS (S)
    • currentLesseeRS (S)
    • currentHeightFrom (S)
    • nextHeightTo (S)
  • lessors (A) is an array of lessor account IDs
  • currentLessee (S) is the account number of the lessee, if applicable
  • currentLeasingHeightTo (N) is the block height when the lease completes, if applicable
  • balanceNQT (S) is the minimally confirmed basic balance (in NQT) of the account
  • publicKey (S) is the public key of the account
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • guaranteedBalanceFQT (S) is the balance (in NQT) of the account with at least 1440 confirmations
  • currentLesseeRS (S) is the Reed-Solomon address of the lessee account
  • accountRS (S) is the Reed-Solomon address of the account
  • lessorsRS (A) is an array of Reed-Solomon lessor account addresses
  • name (S) is the name associated with the account, if applicable
  • description (S) is the description of the account, if applicable
  • 'effectiveBalanceFXT' (S) is the effective balance in FQT available for the account
  • account (S) is the account number
  • currentLeasingHeightFrom (N) is the block height when the lease starts, if applicable
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)

Get Account Example

http://localhost:27876/nxt?
  requestType=getAccount&
  account=ARDOR-4VNQ-RWZC-4WWQ-GVM8S
{
 "forgedBalanceFQT": "0",
 "effectiveBalanceFXT": 13983,
 "lessorsInfo": [
  { 
   "currentHeightTo": "341420",
   "nextHeightFrom": "341420",
   "effectiveBalanceFXT": "544525",
   "nextLesseeRS": "ARDOR-7WVC-W7TJ-REQ2-4VDJD",
   "currentLesseeRS": "ARDOR-7WVC-W7TJ-REQ2-4VDJD",
   "currentHeightFrom": "308653",
   "nextHeightTo": "374187"
  }
 ],
 "currentLessee": "7114946486381367146",
 "currentLeasingHeightTo": 281179,
 "forgedBalanceFQT": "0",
 "balanceNQT": "2501162882344",
 "publicKey": "73080c6a224062660184f10ebb7fb431d4593...",
 "requestProcessingTime": 2,
 "assetBalances": [
  {
   "balanceQNT": "96651298",
   "asset": "4551058913252105307"
  }
 ],
 "guaranteedBalanceFQT": "1398383666344",
 "unconfirmedAssetBalances": [
  {
   "unconfirmedBalanceFNT": "96651298",
   "asset": "4551058913252105307"
  }
 ],
 "currentLesseeRS": "ARDOR-TMVC-69YC-SJB4-8YCH7",
 "accountRS": "ARDOR-4VNQ-RWZC-4WWQ-GVM8S",
 "name": "mystical",
 "account": "17013046603665206934",
 "currentLeasingHeightFrom": 279739
}


Get Account Asset Count

Get the number of assets owned by an account given the account ID. Javadoc

Request:

  • requestType is getAccountAssetCount
  • account is the account ID
  • height is the height of the blockchain to determine the asset count (optional, default is last block)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Note: If table trimming is enabled (default), the height must be within 1440 blocks of the last block.

Response:

  • numberOfAssets (N) is the number of assets owned by the account
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Asset Count Example

http://localhost:27876/nxt?
  requestType=getAccountAssetCount&
  account=ARDOR-8N9W-TN4F-YA2S-H5B7R
{
 "requestProcessingTime": 1,
 "numberOfAssets": 3
}


Get Account Assets

Get the assets owned by a given account in reverse quantity order. Javadoc

Request:

  • requestType is getAccountAssets
  • account is the account ID
  • asset is an asset ID filter (optional)
  • height is the blockchain height at which to retrieve balances (optional, default is the last block in the blockchain)
  • includeAssetInfo is true if asset information is to be included (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Note: If table trimming is enabled (default), the height must be within 1440 blocks of the last block.

Response:

  • accountAssets (A) is an array of asset objects (unless the asset parameter is specified) with the following fields for each asset:
    • quantityQNT (S) is the quantity (in QNT) of the asset
    • unconfirmedQuantityQNT (S) is the unconfirmed quantity (in QNT) of the asset
    • decimals (N) is the number of decimal places used by the asset (if includeAssetInfo is true)
    • name (S) is the asset name (if includeAssetInfo is true)
    • asset (S) is the asset ID
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Assets Example

http://localhost:27876/nxt?
  requestType=getAccountAssets&
  account=ARDOR-4VNQ-RWZC-4WWQ-GVM8S
{
 "accountAssets": [
  {
   "quantityQNT": "68013764",
   "unconfirmedQuantityQNT": "68013764",
   "decimals": 0,
   "name": "Test",
   "asset": "17554243582654188572"
  }
 ],
 "requestProcessingTime": 1
}


Get Account Block Count

Get the number of blocks forged by an account. Javadoc

Request:

  • requestType is getAccountBlockCount
  • account is an account ID
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • numberOfBlocks (N) is the number of blocks forged by the account
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Block Count Example

http://localhost:27876/nxt?
  requestType=getAccountBlockCount&
  account=7114946486381367146
{
 "numberOfBlocks": 460,
 "requestProcessingTime": 70
}


Get Account Block Ids

Get the block IDs of all blocks forged (generated) by an account in reverse block height order. Javadoc

Request:

  • requestType is getAccountBlockIds
  • account is the account ID
  • timestamp is the earliest block (in seconds since the genesis block) to retrieve (optional)
  • firstIndex is a zero-based index to the first block ID to retrieve (optional)
  • lastIndex is a zero-based index to the last block ID to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • blockIds (A) is an array of block IDs
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millsec)

Example:

Get Account Block Ids Example

http://localhost:27876/nxt?
  requestType=getAccountBlockIds&
  account=7114946486381367146&
  lastIndex=5
{
 "blockIds": [
  "6021945980475236545",
  "11040962152457477526",
  "1157648883168692101",
  "9322994768555364845",
  "12862636636638339558",
  "11535040705139271493"
 ],
 "requestProcessingTime": 3
}


Get Account Blocks

Get all blocks forged (generated) by an account in reverse block height order. Javadoc

Request:

  • requestType is getAccountBlocks
  • account is the account ID
  • timestamp is the earliest block (in seconds since the genesis block) to retrieve (optional)
  • firstIndex is a zero-based index to the first block to retrieve (optional)
  • lastIndex is a zero-based index to the last block to retrieve (optional)
  • includeTransactions is true to retrieve transaction details, otherwise only transaction IDs are retrieved (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • blocks (A) is an array of blocks (refer to Get Block for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Blocks Example

http://localhost:27876/nxt?
  requestType=getAccountBlocks&
  account=7114946486381367146&
  lastIndex=0
{
 "blocks": [
  {
   "previousBlockHash": "bd8948556e968f1d532cd286a5dd8fde0159d7950467f1ed8fbf26a31d663e99",
   "payloadLength": 386,
   "totalAmountNQT": "0",
   "generationSignature": "74138446cacdb30075492670f7e24fb839434818cb877bba174e37361fc899a1",
   "generator": "7114946486381367146",
   "generatorPublicKey": "dbc809e8237914f25add0d349ea16b2ac05cae6882d0a1782d23605af264d97a",
   "baseTarget": "325377698",
   "payloadHash": "32df67383f63b74f1331bbdb6f1be424c87a1e6423fc7091d81683481eb6c4ca",
   "generatorRS": "ARDOR-TMVC-69YC-SJB4-8YCH7",
   "nextBlock": "3553212706398858282",
   "numberOfTransactions": 2,
   "blockSignature": "d30e3f95d547fa922feb31303f877a345d0ad8c232778a4507adf9082b5df3...",
   "transactions": [
    "1199750337785535382",
    "8975701802988160413"
   ],
   "version": 3,
   "totalFeeFQT": "200000000",
   "previousBlock": "2130086549390920125",
   "block": "6021945980475236545",
   "height": 278953,
   "timestamp": 30130340
  }
 ],
 "requestProcessingTime": 3
}


Get Account Currencies

Get the currencies issued by a given account. Javadoc

Request:

  • requestType is getAccountCurrencies
  • account is the account ID
  • currency is a currency ID filter (optional)
  • height is the blockchain height at which the response applies (optional, default is the current height)
  • includeCurrencyInfo is true if several currency information properties is to be included (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • accountCurrencies (A) is an array of currency objects with the following fields:
    • code (S) is the currency code
    • unconfirmedUnits (S) is the amount of unconfirmed currency units (in QNT)
    • decimals (N) is the number of currency decimal places
    • name (S) is the currency name
    • currency (S) is the currency ID
    • units (S) is the amount of currency (in QNT)
    • issuanceHeight (N) is the blockchain height of issuance for a reservable currency
    • type (N) is the currency type bitmask (refer to Get Currency)
    • issuerAccountRS (S) is the Reed-Solomon address of the issuer account
    • issuerAccount (S) is the issuer account ID
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

G=Get Account Currencies Example====

http://localhost:27876/nxt?
  requestType=getAccountCurrencies&
  account=ARDOR-4VDY-LNVT-LMAY-FMCKA&
  includeCurrencyInfo=true
{
 "accountCurrencies": [
  {
   "chain": 2,
   "issuerAccountRS": "ARDOR-4VDY-LNVT-LMAY-FMCKA",
   "code": "MYSTX",
   "unconfirmedUnitsQNT": "10000",
   "decimals": 2,
   "name": "MystcoinX",
   "currency": "6520756875632314476",
   "unitsQNT": "10000",
   "issuanceHeight": 0,
   "type": 1,
   "issuerAccount": "15295723609781267838"
  }
 ],
 "requestProcessingTime": 1
}


Get Account Currency Count

Get the number of currencies issued by a given account. Javadoc

Request:

  • requestType is getAccountCurrencyCount
  • account is the account ID
  • height is the blockchain height at which the response applies (optional, default is the current height)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • numberOfCurrencies (N) is the number of currencies issued
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Currency Count Example

http://localhost:27876/nxt?
  requestType=getAccountCurrencyCount&
  account=ARDOR-4VDY-LNVT-LMAY-FMCKA
{
 "numberOfCurrencies": 1,
 "requestProcessingTime": 1
}


Get Account Current Order Ids

Get current asset order IDs given an account ID in reverse block height order. Javadoc getAccountCurrentBidOrderIds and Javadoc getAccountCurrentAskOrderIds

Request:

  • requestType is either getAccountCurrentBidOrderIds or getAccountCurrentAskOrderIds
  • chain the chain related to the operation
  • account is the account ID
  • asset is an asset ID filter (optional)
  • firstIndex is a zero-based index to the first order ID to retrieve (optional)
  • lastIndex is a zero-based index to the last order ID to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • bidOrderIds or askOrderIds (A) is an array of order IDs
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Current Order Ids Example

http://localhost:27876/nxt?
  requestType=getAccountCurrentBidOrderIds&
  chain=2&
  account=ARDOR-L6FM-89WK-VK8P-FCRBB&
  asset=17554243582654188572
{
 "bidOrderIds": [
  "17185236428295897167"
 ],
 "requestProcessingTime": 4
}


Get Account Current Orders

Get current asset orders given an account ID in reverse block height order. Javadoc getAccountCurrentBidOrders and Javadoc getAccountCurrentAskOrders

Request:

  • requestType is either getAccountCurrentBidOrders or getAccountCurrentAskOrders
  • chain the chain related to the operation
  • account is the account ID
  • asset is an asset ID filter (optional)
  • firstIndex is a zero-based index to the first order to retrieve (optional)
  • lastIndex is a zero-based index to the last order to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • bidOrders or askOrders (A) is an array of order objects (refer to Get Order for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Current Orders Example

http://localhost:27876/nxt?
  requestType=getAccountCurrentBidOrders&
  chain=2&
  account=ARDOR-L6FM-89WK-VK8P-FCRBB
{
 "bidOrders": [
  {
   "quantityQNT": "1000000",
   "priceNQTPerShare": "100",
   "accountRS": "ARDOR-L6FM-89WK-VK8P-FCRBB",
   "asset": "17554243582654188572",
   "type": "bid",
   "account": "15323192282528158131",
   "order": "17185236428295897167",
   "height": 285549
  }
 ],
 "requestProcessingTime": 1
}


Get Account Current Order Ids

Get current asset order IDs given an account ID in reverse block height order. Javadoc getAccountCurrentBidOrderIds and Javadoc getAccountCurrentAskOrderIds

Request:

  • requestType is either getAccountCurrentBidOrderIds or getAccountCurrentAskOrderIds
  • chain the chain related to the operation
  • account is the account ID
  • asset is an asset ID filter (optional)
  • firstIndex is a zero-based index to the first order ID to retrieve (optional)
  • lastIndex is a zero-based index to the last order ID to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • bidOrderIds or askOrderIds (A) is an array of order IDs
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Current Order Ids Example

http://localhost:27876/nxt?
  requestType=getAccountCurrentBidOrderIds&
  chain=2&
  account=ARDOR-L6FM-89WK-VK8P-FCRBB&
  asset=17554243582654188572
{
 "bidOrderIds": [
  "17185236428295897167"
 ],
 "requestProcessingTime": 4
}


Get Account Exchange Requests

Get the exchange requests associated with a given account and/or currency in reverse chronological order (or in expected order of execution for expected requests). Javadoc getAccountExchangeRequests and Javadoc getExpectedExchangeRequests

Request:

  • requestType is either getAccountExchangeRequests or getExpectedExchangeRequests, where expected requests are from the unconfirmed transactions pool or are phased transactions scheduled to finish in the next block
  • chain the chain related to the operation
  • account is the account ID (optional for expected requests)
  • currency is the currency ID (optional for expected requests if account provided)
  • includeCurrencyInfo is true to include the response fields code, decimals, name, issuanceHeight, type, timestamp, issuerAccountRS and issuerAccount (optional, applies only to expected requests)
  • firstIndex is a zero-based index to the first request to retrieve (optional, does not apply to expected requests)
  • lastIndex is a zero-based index to the last request to retrieve (optional, does not apply to expected requests)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • exchangeRequests (A) is an array of requests with the following fields for each request:
    • code (S) is a currency code
    • subtype (N) is 5 for buy and 6 for sell
    • decimals (N) is the number of decimal places
    • name (S) is the currency name
    • units (S) is the number of currency units to buy or sell (in QNT)
    • issuanceHeight (N) is the blockchain height of issuance for a reservable currency, zero otherwise
    • type (N) is the currency type bitmask (refer to Get Currency)
    • transaction (S) is the transaction ID
    • timestamp (N) is the timestamp (in seconds since the genesis block) of the block when the request was executed
    • rateNQTPerUnit (S) is the exchange rate (in NQT per QNT)
    • issuerAccountRS (S) is the Reed-Solomon address of the issuer account
    • issuerAccount (S) is the issuer account ID
    • phased (B) is true if the transaction is phased (applies only to expected requests)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Notes: Even expired, unfilled requests will be retrieved. As of the former blockchain Nxt [Software Version 1.5.13] phased exchange requests that have not yet finished, or have not been approved, are now excluded if requestType is getAccountExchangeRequests.

Get Account Exchange Requests Example

http://localhost:27876/nxt?
  requestType=getAccountExchangeRequests&
  chain=2&
  account=ARDOR-4VDY-LNVT-LMAY-FMCKA&
  currency=6520756875632314476
{
 "exchangeRequests": [
  {
   "issuerAccountRS": "ARDOR-4VDY-LNVT-LMAY-FMCKA",
   "code": "MYSTX",
   "subtype": 6,
   "decimals": 2,
   "name": "MystcoinX",
   "unitsQNT": "200",
   "issuanceHeight": 0,
   "type": 1,
   "transaction": "14840146504449624275",
   "timestamp": 34130695,
   "rateNQTPerUnit": "1500000000",
   "issuerAccount": "15295723609781267838"
  }
 ],
 "requestProcessingTime": 1
}


Get Account Id

Get an account ID given a secret passphrase or public key. POST only. Javadoc

Request:

  • requestType is getAccountId
  • secretPhrase is the secret passphrase of the account (optional)
  • publicKey is the public key of the account (optional if secretPhrase provided)

Response:

  • accountRS (S) is the Reed-Solomon address of the account
  • publicKey (S) is the public key of the account
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • account (S) is the account number

Get Account Id Example

http://localhost:27876/nxt?
  requestType=getAccountId&
  secretPhrase=IWontTellYou
{
 "accountRS": "ARDOR-L6FM-89WK-VK8P-FCRBB",
 "publicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
 "requestProcessingTime": 2,
 "account": "15323192282528158131"
}


Get Account Ledger

Get multiple account ledger entries. Javadoc

Request:

  • requestType is getAccountLedger
  • account is the account ID (optional)
  • firstIndex is a zero-based index to the first block to retrieve (optional)
  • lastIndex is a zero-based index to the last block to retrieve (optional)
  • event is the event ID (optional)
  • eventType is a string representing the event type (optional)
  • holdingType is a string representing the holding type (optional)
  • holding is the holding ID (optional)
  • includeTransactions is true to retrieve transaction details, otherwise only transaction IDs are retrieved (optional)
  • includeHoldingInfo is true to retrieve asset or currency info (optional) with each ledger entry. The default is false.
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • entries (A) is an array of ledger objects including the fields:
    • change (S) is the change in the balance for the holding identified by 'holdingType'
    • eventType (S) is the event type causing the account change
    • ledgerId (S) is the ledger entry ID
    • holding (S) is the item identifier for an asset or currency balance
    • isTransactionEvent (B) is true if the event is associated with a transaction and false if it is associated with a block.
    • balance (S) is the balance for the holding identified by 'holdingType'
    • holdingType (S) is the item being changed (account balance, asset balance or currency balance)
    • accountRS (S) is the Reed-Solomon address of the account
    • block (S) is the block ID that created the ledger entry
    • event (S) is the block or transaction associated with the event
    • account (S) is the account number
    • height (N) is the the block height associated with the event
    • timestamp (N) is the the block timestamp associated with the event
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Ledger Example

http://localhost:27876/nxt?
  requestType=getAccountLedger&
  account=ARDOR-7A48-47JL-T7LD-D5FS3
{
  "entries": [
    {
      "change": "100",
      "eventType": "CURRENCY_OFFER_EXPIRED",
      "ledgerId": "532246",
      "holding": "6112509426732269765",
      "isTransactionEvent": true,
      "balance": "90000",
      "holdingType": "UNCONFIRMED_CURRENCY_BALANCE",
      "accountRS": "ARDOR-7A48-47JL-T7LD-D5FS3",
      "block": "2303344830040052747",
      "event": "13236557417702245931",
      "account": "12745647715474645062",
      "height": 736757,
      "timestamp": 78995635
    }
  ],
    "requestProcessingTime": 1
}


Get Account Ledger Entry

Get a specific account ledger entry. Javadoc

Request:

  • requestType is getAccountLedger
  • ledgerId is the ledger ID
  • includeTransactions is true to retrieve transaction details, otherwise only transaction IDs are retrieved (optional)
  • includeHoldingInfo is true to retrieve asset or currency info (optional) with the ledger entry. The default is false.

Response:

  • change (S) is the change in the balance for the holding identified by 'holdingType'
  • eventType (S) is the event type causing the account change
  • ledgerId (S) is the ledger entry ID
  • holding (S) is the item identifier for an asset or currency balance
  • isTransactionEvent (B) is true if the event is associated with a transaction and false if it is associated with a block.
  • balance (S) is the balance for the holding identified by 'holdingType'
  • holdingType (S) is the item being changed (account balance, asset balance or currency balance)
  • accountRS (S) is the Reed-Solomon address of the account
  • block (S) is the block ID that created the ledger entry
  • event (S) is the block or transaction associated with the event
  • account (S) is the account number
  • height (N) is the the block height associated with the event
  • timestamp (N) is the the block timestamp associated with the event
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Ledger Entry Exanple

http://localhost:27876/nxt?
  requestType=getAccountLedgerEntry&
  ledgerId=532246
{
  "change": "100",
  "eventType": "CURRENCY_OFFER_EXPIRED",
  "requestProcessingTime": 1,
  "ledgerId": "532246",
  "holding": "6112509426732269765",
  "isTransactionEvent": true,
  "balance": "90000",
  "holdingType": "UNCONFIRMED_CURRENCY_BALANCE",
  "accountRS": "ARDOR-7A48-47JL-T7LD-D5FS3",
  "block": "2303344830040052747",
  "event": "13236557417702245931",
  "account": "12745647715474645062",
  "height": 736757,
  "timestamp": 78995635
}


Get Account Lessors

Get the lessors to an account. Javadoc

Request:

  • requestType is getAccountLessors
  • account is the account ID
  • height is the height of the blockchain to determine the lessors (optional, default is last block)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Note: If table trimming is enabled (default), the height must be within 1440 blocks of the last block.

Response:

  • accountRS (S) is the Reed-Solomon address of the account
  • account (S) is the account number
  • height (N) is the height of the blockchain
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • lessors (A) is an array of lessor objects including the fields:
    • lessorRS (S)
    • lessor (S)
    • guaranteedBalanceNQT (S)

Get Account Lessors Example

http://localhost:27876/nxt?
  requestType=getAccountLessors&
  account=7114946486381367146&
  height=282497
{
 "lessors": [
  {
   "guaranteedBalanceFQT": "2643314085738687",
   "lessorRS": "ARDOR-MRBN-8DFH-PFMK-A4DBM",
   "lessor": "9918441724915080500"
  }
 ],
 "accountRS": "ARDOR-TMVC-69YC-SJB4-8YCH7",
 "requestProcessingTime": 1,
 "account": "7114946486381367146",
 "height": 282497
}


Get Account Phased Transaction Count

Get the number of pending phased transactions associated with an account given the account ID. Javadoc

Request:

  • requestType is getAccountPhasedTransactionCount
  • chain the chain related to the operation
  • account is the account ID
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • numberOfPhasedTransactions (N) is the number of pending phased transactions
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Phased Transaction Count Example

http://localhost:27876/nxt?
  requestType=getAccountPhasedTransactionCount&
  chain=2&
  account=15295723609781267838
{
 "requestProcessingTime": 1,
 "numberOfPhasedTransactions": 3
}


Get Account Phased Transactions

Get pending phased transactions associated with an account given the account ID in reverse chronological creation order. Javadoc

Request:

  • requestType is getAccountPhasedTransactions
  • chain the chain related to the operation
  • account is the account ID
  • firstIndex is a zero-based index to the first phased transaction to retrieve (optional)
  • lastIndex is a zero-based index to the last phased transaction to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response: Refer to Get Transaction for details.

Get Account Phased Transactions Example

http://localhost:27876/nxt?
  requestType=getAccountPhasedTransactions&
  chain=2&
  account=15382970207090678772&
  lastIndex=0
{
 "requestProcessingTime": 1,
 "transactions": [
  {
   "signature": "fa088e98126784e1f502267aadc5acc078346b99088734f668b91f9e257bd00c50b219fbd8eb15ac8a7ae5163e03d973521e02d8e20b73e899dcffd74afd6237",
   "transactionIndex": 1,
   "type": 1,
   "fxtTransaction": "3631739759413271110",
   "phased": true,
   "ecBlockId": "2329106975025976796",
   "signatureHash": "889c856fb4ecc359f9a7b19f85f6f2b79d1646d29b0cc785825239140f48dcec",
   "attachment": {
    "phasingFinishHeight": 364148,
    "phasingHolding": "0",
    "phasingQuorum": "1",
    "encryptedMessage": {
     "data": "5f579d6533662b45ab1099ba76c73175e130429b...",
     "nonce": "96d6e3f308f65fbd915b5fb907f9e0261849c15e53fcb20384fe70e17f270091",
     "isText": true,
     "isCompressed": true
   },
   "version.Phasing": 1,
   "version.ArbitraryMessage": 0,
   "phasingWhitelist": [
    "15382970207090678772"
   ],
   "phasingMinBalance": "0",
   "phasingMinBalanceModel": 0,
   "version.PrunableEncryptedMessage": 1,
   "phasingVotingModel": 0,
   "encryptedMessageHash": "7a9a2dfe8a1d7eaa79f4bba91285a95f3d72b4f89823628320acd363bd8ba623"
  },
  "senderRS": "ARDOR-X8ZN-WUJ2-SXY3-FBUYC",
  "subtype": 0,
  "amountNQT": "0",
  "recipientRS": "ARDOR-GHKP-XWB5-XMZB-CTUE3",
  "block": "15757251541504155235",
  "blockTimestamp": 21532047,
  "timestamp": 21532018,
  "deadline": 15,
  "height": 362709,
  "senderPublicKey": "df21142bd38c04bd5c5c342c6ca36802f9de89b75b2a0a8cbd32d29dca481e5c",
  "chain": 2,
  "feeNQT": "200000",
  "confirmations": 40,
  "fullHash": "dcfed8eb4b9c7395e57c7e37f2e269d4915f35e77edfc29075c8050acec1f826",
  "version": 1,
  "sender": "15382970207090678772",
  "recipient": "11579697950237343285",
  "ecBlockHeight": 230000
  }
 ]
}


Get Account Properties

Get the Account properties for a specific account or setter. Javadoc

Request:

  • requestType is getAccountProperties
  • recipient is the account ID to which the property is attached to
  • setter is the account ID who set the property (optional if recipient provided)
  • property is the property key (optional)
  • firstIndex is a zero-based index to the first block to retrieve (optional)
  • lastIndex is a zero-based index to the last block to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • setterRS: (S) is the Reed-Solomon address of the setter account (only if setter is defined in the request)
  • recipientRS: (S) is the Reed-Solomon address of the recipient account (only if recipient is defined in the request)
  • recipient: (S) is the account number of the recipient account (only if recipient is defined in the request)
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • setter: (S) is the account number of the setter account (only if setter is defined in the request)
  • properties: (A) is an array of properties including the fields:
    • setterRS: (S) is the Reed-Solomon address of the setter account (only if setter is omitted in the request)
    • recipientRS: (S) is the Reed-Solomon address of the recipient account (only if recipient is omitted in the request)
    • recipient: (S) is the account number of the recipient account (only if recipient is omitted in the request)
    • property: (S) property name
    • setter: (S) is the account number of the setter account (only if setter is omitted in the request)
    • value: (S) property value

Get Account Properties

http://localhost:27876/nxt?
  requestType=getAccountProperties&
  recipient=ARDOR-7A48-47JL-T7LD-D5FS3
{
  "recipientRS": "ARDOR-7A48-47JL-T7LD-D5FS3",
  "recipient": "12745647715474645062",
  "requestProcessingTime": 0,
  "properties": [
    {
      "setterRS": "ARDOR-7A48-47JL-T7LD-D5FS3",
      "property": "testkey1",
      "setter": "12745647715474645062",
      "value": "testvalue1"
    }
  ]
}


Get Account Public Key

Get the public key associated with an account ID. Javadoc

Request:

  • requestType is getAccountPublicKey
  • account is the account ID
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • publicKey (S) is the 32-byte public key associated with the account, returned as a hex string
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Account Public Key Example

http://localhost:27876/nxt?
  requestType=getAccountPublicKey&
  account=ARDOR-L6FM-89WK-VK8P-FCRBB
{
 "publicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d...",
 "requestProcessingTime": 36
}


Get Assets By Issuer

Get asset information given multiple creation account IDs in reverse block height of creation order. Javadoc

Request:

  • requestType is getAssetsByIssuer
  • account is one of the multiple account IDs
  • account is one of the multiple account IDs

  • firstIndex is a zero-based index to the first asset to retrieve (optional)
  • lastIndex is a zero-based index to the last asset to retrieve (optional)
  • includeCounts is true if the fields beginning with numberOf... are to be included (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • assets (A) is an array of asset objects (refer to Get Asset)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Assets By Issuer Example

http://localhost:27876/nxt?
  requestType=getAssetsByIssuer&
  account=ARDOR-DE2F-W76R-GL25-HMFPR&
  lastIndex=0
{
 "assets": [
  [
   {
    "quantityQNT": "10000000000",
    "numberOfAccounts": 222,
    "accountRS": "ARDOR-DE2F-W76R-GL25-HMFPR",
    "decimals": 4,
    "numberOfTransfers": 278,
    "name": "NXTprivacy",
    "description": "NXTprivacy will contain various privacy related projects...",
    "numberOfTrades": 456,
    "asset": "17911762572811467637",
    "account": "18146608053740744717"
   }
  ]
 ],
 "requestProcessingTime": 9
}


Get Balance

Get the balance of an account. Javadoc

Request:

  • chain is the chain to retrieve the balance (for example ARDOR(1) or IGNIS(2))
  • requestType is getBalance
  • account is an account ID
  • height is the height to retrieve account balance for, if still available (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • unconfirmedBalanceNQT (S) is balanceNQT less unconfirmed outgoing transactions, the balance displayed in the client
  • balanceNQT (S) is the minimally confirmed basic balance (in NQT) of the account in the chain specified in the request
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Balance Example

http://localhost:27876/nxt?
  requestType=getBalance&
  chain=1&
  account=7114946486381367146
{
    "unconfirmedBalanceNQT": "29700000000",
    "balanceNQT": "29700000000",
    "requestProcessingTime": 0
}


Get Balances

Get the balance of an account. Javadoc

Request:

  • chain is the chains to retrieve the balance (for example ARDOR(1) or IGNIS(2))
  • requestType is getBalances
  • account is an account ID
  • height is the height to retrieve account balance for, if still available (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • balances includes the balances for each chain.
    • unconfirmedBalanceNQT (S) is balanceNQT less unconfirmed outgoing transactions, the balance displayed in the client
    • balanceNQT (S) is the minimally confirmed basic balance (in NQT) of the account in the chain specified in the request
    • requestProcessingTime (N) is the API request processing time (in millisec)

Get Balance Example

http://localhost:27876/nxt?
  requestType=getBalance&
  chain=1&
  chain=2&
  chain=3&
  account=7114946486381367146
{
    "balances": {
        "1": {
            "unconfirmedBalanceNQT": "29700000000",
            "balanceNQT": "29700000000"
        },
        "2": {
            "unconfirmedBalanceNQT": "216362457000",
            "balanceNQT": "216362457000"
        },
        "3": {
            "unconfirmedBalanceNQT": "0",
            "balanceNQT": "0"
        }
    },
    "requestProcessingTime": 18
}


Get Blockchain Transactions

Get the transactions associated with an account in reverse block timestamp order. Javadoc

Request:

  • chain is the chain to retrieve the transactions (for example ARDOR(1) or IGNIS(2))
  • requestType is getBlockchainTransactions
  • account is the account ID
  • timestamp is the earliest block (in seconds since the genesis block) to retrieve (optional)
  • type is the type of transactions to retrieve (optional)
  • subtype is the subtype of transactions to retrieve (optional)
  • firstIndex is a zero-based index to the first transaction to retrieve (optional)
  • lastIndex is a zero-based index to the last transaction to retrieve (optional)
  • numberOfConfirmations is the required number of confirmations per transaction (optional)
  • withMessage is true to retrieve only only transactions having a message attachment, either non-encrypted or decryptable by the account (optional)
  • phasedOnly is true to retrieve only phased transactions (optional unless nonPhasedOnly provided)
  • nonPhasedOnly is true to retrieve only nonphased transactions (optional unless phasedOnly provided)
  • includeExpiredPrunable is true' to retrieve pruned data if available (optional)
  • includePhasingResult is true to retrieve execution status of each phased transaction (optional)
  • executedOnly is true to exclude phased transactions that are not yet executed (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Note: Refer to Get Constants for definitions of types and subtypes

Response:

  • transactions (A) is an array of transactions (refer to Get Transaction for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Blockchain Transactions Example

http://localhost:27876/nxt?
  requestType=getBlockchainTransactions&
  chain=1&
  account=ARDOR-4VDY-LNVT-LMAY-FMCKA&
  lastIndex=0
{
 "requestProcessingTime": 2,
 "transactions": [
  {
   "signature": "0bc2045c2e4291e9595702fc6a9e805f11b65a88a867d515e44b980ef72b440a2...",
   "transactionIndex": 0,
   "type": 0,
   "phased": false,
   "ecBlockId": "441034190304176853",
   "signatureHash": "31f92d5612115e174748c7a261cd0412e00028639301aae0f0c1ddfc7618b7e7",
   "attachment": {
    "version.OrdinaryPayment": 0
   },
   "senderRS": "ARDOR-4VDY-LNVT-LMAY-FMCKA",
   "subtype": 0,
   "amountNQT": "1400000000",
   "recipientRS": "ARDOR-BMUV-8QQR-47VK-CR7F3",
   "block": "6752144003309284467",
   "blockTimestamp": 46567698,
   "deadline": 1440,
   "timestamp": 46567612,
   "height": 291611,
   "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
   "chain": 1,
   "feeNQT": "100000000",
   "confirmations": 2046,
   "fullHash": "a26a2a36086e5d13f069dd9da06ce4e6b0418e9a299bec0cda39bfa04a2ca5e3",
   "version": 1,
   "sender": "15295723609781267838",
   "recipient": "11580081983047651163",
   "ecBlockHeight": 291600,
   "transaction": "1395392441102264994"
  }
 ]
}


Get Contract References

Get contracts references for a certain account. Javadoc

Request:

  • requestType is getContractReferences
  • account is the address of the account to get contracts
  • contractName is the contract name to retrieve information (optional)
  • firstIndex is a zero-based index to the first block ID to retrieve (optional)
  • lastIndex is a zero-based index to the last block ID to retrieve (optional)
  • adminPassword is a string with the admin password (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • accountRS is the transaction ID (optional)
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • contractReferences (A) is an array of contracts
    • contract** contains two elements, chain and transactionFullHash
    • chain** the chain where the contract was deployed
    • transactionFullHash** (S) the transactionFullHash of the contract
    • name** (S) the name of the contract, if the request parameter 'contractName' is specified then only shows the contract name requested
    • id** (N) is the ID of the contract
    • params** (N) is the contract setup parameters

Get Contract References Example

http://localhost:27876/nxt?
  requestType=getContractReferences&
  account=5873880488492319831
{
 "accountRS": "ARDOR-XK4R-7VJU-6EQG-7R335",
 "requestProcessingTime": 0,
 "contractReferences": [
  {
   "contract": {
    "chain": 2,
    "transactionFullHash": "c4f81b22aed33f1aed3d75ac4c6a0024698ea41e03263ffd5763dc1b1c8f6cf3"
   },
   "name": "AllForOnePayment",
   "id": "17889857658659529708",
   "params": "{\"chain\":2,\"frequency\":10}"
  },
  {
   "contract": {
    "chain": 2,
    "transactionFullHash": "ff374385044519900147c145beeaa07520f0a9850b95d84b835c88ff1ce81015"
   },
   "name": "DistributedRandomNumberGenerator",
   "id": "10806939862175194746",
   "params": "{}"
  }
 ] 
"account": "5873880488492319831"
}


Get Currencies By Issuer

Get currencies issued by multiple accounts in reverse creation order. Javadoc

Request:

  • requestType is getCurrenciesByIssuer
  • account is one of multiple account IDs
  • account is one of multiple account IDs

  • firstIndex is a zero-based index to the first currency to retrieve (optional)
  • lastIndex is a zero-based index to the last currency to retrieve (optional)
  • includeCounts is true if numberOf... fields are to be included (optional)
  • adminPassword is the administrator password (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • currencies (A) is an array of arrays of currency objects, where the outer array is indexed by the given account IDs (refer to Get Currency for details about the currency objects)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Currencies By Issuer Example

http://localhost:27876/nxt?
  requestType=getCurrenciesByIssuer&
  account=ARDOR-4VDY-LNVT-LMAY-FMCKA
{
 "requestProcessingTime": 334,
 "currencies": [
  [
   {
    "initialSupply": "10000",
    "currentReservePerUnitNQT": "0",
  "chain": 2,
    "types": [
     "EXCHANGEABLE"
    ],
    "code": "PTNT",
    "currentSupplyQNT": "100000000",
    "creationHeight": 361192,
    "minDifficulty": 0,
    "description": "Potential coin",
    "minReservePerUnitNQT": "0",
    "initialSupplyQNT": "100000000",
    "issuanceHeight": 0,
    "type": 1,
    "maxSupplyQNT": "100000000",
    "maxDifficulty": 0,
    "accountRS": "ARDOR-X8ZN-WUJ2-SXY3-FBUYC",
    "decimals": 2,
    "name": "POTENTIAL",
    "reserveSupplyQNT": "0",
    "currency": "7978322511509619701",
    "account": "15382970207090678772",
    "algorithm": 0
   }
  ]
 ]
}


Get Effective Balance

Get the balance of an account in ARDR. Javadoc

Request:

  • requestType is getEffectiveBalance
  • account is an account ID
  • height height is the height of the blockchain to determine the effective balance (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • forgedBalanceFQT (S) is the account forged balance.
  • *height (N) is the height of the effective balance
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Effective Balance Example

http://localhost:27876/nxt?
  requestType=getEffectiveBalance&
  account=7114946486381367146
{
    "forgedBalanceFQT": "0",
    "guaranteedBalanceFQT": "29700000000",
    "effectiveBalanceFXT": 0,
    "requestProcessingTime": 0
}


Get Funding Monitor

Get a funding monitor. The monitors for a single funding account will be returned when the secret phrase is specified. A single monitor will be returned if holding and property are specified. Otherwise, all monitors for the funding account will be returned The administrator password is not required and will be ignored. When the administrator password is specified, all monitors will be returned unless the funding account is also specified. A single monitor will be returned if holding and property are specified. Otherwise, all monitors for the funding account will be returned. Holding type codes are listed in getConstants. In addition, the holding identifier must be specified when the holding type is ASSET or CURRENCY. Javadoc

Request:

  • requestType is getFundingMonitor
  • chain is the chain to retrieve the balance (for example ARDOR(1) or IGNIS(2))
  • holdingType is a string representing the holding type (optional)
  • holding is the holding ID (optional)
  • property is the name of the account property (optional)
  • secretPhraseis the secret passphrase of the account (optional)
  • includeMonitoredAccounts is true to include monitored accounts (optional)
  • account is the account ID (optional)
  • adminPassword is a string with the admin password (optional)

Response:

  • monitors (A) is an array that contains the monitors requested.
    • holding (N) is the holding ID
    • amount (N) is the amount of the funding monitor
    • monitoredAccounts (A) is an array that contains the monitors requested.
      • amount (N) is the amount of the funding monitor
      • accountRS (S) is the Reed-Solomon address of the accounte
      • interval (N) is the the number of blocks to wait after before funding the recipient
      • threshold (N) is the NQT threshold for funding the account
      • account (N) is the account ID
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Funding Monitors Example

http://localhost:27876/nxt?
 requestType=getFundingMonitor&
 property=funding&
 secretPhrase=IWontTellYou&
 includeMonitoredAccounts:true
{
 "requestProcessingTime": 0,
 "monitors": [
  {
   "holding": "0",
   "amount": "1000000000",
   "monitoredAccounts": [
    {
     "amount": "1000000000",
     "accountRS": "ARDR-5MYN-AP7M-NKMH-CRQJZ",
     "threshold": "15000000000",
     "interval": 10,
     "account": "12664921794733526996"
    },
    {
     "amount": "1000000000",
     "accountRS": "ARDR-G885-AKDX-5G2B-BLUCG",
     "threshold": "15000000000",
     "interval": 10,
     "account": "10892890577210644675"
    }
   ],
   "holdingType": 0,
   "accountRS": "ARDR-7A48-47JL-T7LD-D5FS3",
   "property": "funding",
   "threshold": "15000000000",
   "interval": 10,
   "account": "12745647715474645062"
  }
 ]
}


Get Guaranteed Balance

Get the balance of an account in ARDR. This is the minimum balance the account had in the interval:

(currentHeight - numberOfConfirmations, currentHeight)

Amounts in unconfirmed transactions are not deduced from the result (or included to the result). Javadoc

Request:

  • requestType is getGuaranteedBalance
  • account is an account ID
  • numberOfConfirmations is the minimum number of confirmations for a transaction to be included in the guaranteed balance (optional, if omitted or zero then minimally confirmed transactions are included)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • guaranteedBalanceNQT (S) is the balance (in NQT) of the account with at least numberOfConfirmations confirmations
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Guaranteed Balance Example

http://localhost:27876/nxt?
  requestType=getGuaranteedBalance&
  account=7114946486381367146&
  numberOfConfirmations=1440
{
 "guaranteedBalanceNQT": "9242231058415",
 "requestProcessingTime": 0
}


Get Polls

Get poll details in reverse creation order. Javadoc

Request:

  • requestType is getPolls
  • chain the chain related to the operation (eg: IGNIS)
  • account is a creation account ID filter (optional)
  • timestamp is the earliest poll (in seconds since the genesis block) to retrieve (optional)
  • firstIndex is a zero-based index to the first poll to retrieve (optional)
  • lastIndex is a zero-based index to the last poll to retrieve (optional)
  • includeFinished is true to include completed polls (optional)
  • finishedOnly is true to exclude not yet executed, phased transactions (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • polls (A) is an array of polls (refer to Get Poll for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Polls Example

http://localhost:27876/nxt?
  requestType=getPolls&
  chain=2&
  lastIndex=0
{
 "polls": [
  {
   "minRangeValue": 0,
   "votingModel": 3,
   "description": "Should we start fully backing Credits with something tangible?",
   "finished": false,
   "poll": "10307833923604182368",
   "minNumberOfOptions": 1,
   "holding": "415923435949896799",
   "minBalance": "1000000000",
   "accountRS": "ARDOR-3BCV-8Q5G-9NP6-576DP",
   "name": "CRDTS owners poll",
   "options": [
    "Yes",
    "No",
    "go for fractional reserve backing"
   ],
   "finishHeight": 260218,
   "maxNumberOfOptions": 1,
   "minBalanceModel": 3,
   "account": "4227900615136683355",
   "maxRangeValue": 1
  }
 ],
 "requestProcessingTime": 0
}


Get Unconfirmed Transaction Ids

Get a list of unconfirmed transaction IDs associated with an account. Javadoc

Request:

  • chain is the chain to retrieve the transactions Ids (for example ARDOR(1) or IGNIS(2))
  • requestType is getUnconfirmedTransactionIds
  • account is one account ID (optional)
  • account is one account ID (optional)

  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)
  • firstIndex is a zero-based index to the first transaction ID to retrieve (optional)
  • lastIndex is a zero-based index to the last transaction ID to retrieve (optional)

Response:

  • unconfirmedTransactionIds (A) is an array of unconfirmed transaction IDs
  • chain is the chain specified for retrieving the unconfirmed transactions Ids (for example ARDOR(1) or IGNIS(2))
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Unconfirmed Transaction Ids Example

http://localhost:27876/nxt?
  requestType=getUnconfirmedTransactionIds&
  account=ARDOR-L6FM-89WK-VK8P-FCRBB
{
 "requestProcessingTime": 1,
 "unconfirmedTransactionIds": []
}

Get Unconfirmed Transactions

Get a list of unconfirmed transactions associated with an account. Javadoc

Request:

  • chain is the chain to retrieve the unconfirmed transactions (for example ARDOR(1) or IGNIS(2))
  • requestType is getUnconfirmedTransactions
  • account is one account ID (optional)
  • account is one account ID (optional)

  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)
  • firstIndex is a zero-based index to the first unconfirmed transaction to retrieve (optional)
  • lastIndex is a zero-based index to the last unconfirmed transaction to retrieve (optional)

Response:

  • unconfirmedTransactions (A) is an array of unconfirmed transactions (refer to Get Transaction for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Unconfirmed Transactions Example

http://localhost:27876/nxt?
  chain=2&
  requestType=getUnconfirmedTransactions&
  account=ARDOR-L6FM-89WK-VK8P-FCRBB
{
 "unconfirmedTransactions": [],
 "requestProcessingTime": 1
}


Get Voter Phased Transactions

Get pending phased transactions which include a whitelist in reverse chronological creation order. These transactions can be considered transaction approval requests. Javadoc

Request:

  • requestType is getVoterPhasedTransactions
  • chain the chain related to the operation
  • account is a whitelisted account ID included in the phased transactions
  • firstIndex is a zero-based index to the first phased transaction to retrieve (optional)
  • lastIndex is a zero-based index to the last phased transaction to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response: Refer to Get Transaction for details.

Get Voter Phased Transactions Example

http://localhost:27876/nxt?
  requestType=getVoterPhasedTransactions&
  chain=2&
  account=15295723609781267838
{
 "requestProcessingTime": 1,
 "transactions": [
  {
   "signature": "e527fce6591049b61d232ebbf4171319ae4e208f34d8a055ffb09f07dec7d9033527...",
   "transactionIndex": 0,
   "type": 0,
   "fxtTransaction": "3631739759413271110",
   "phased": true,
   "ecBlockId": "13625660527605830055",
   "signatureHash": "2a3cc644b1cb48130a172de92a418d48522b45a25a36d4d48c2347f032e430ab",
   "attachment": {
    "phasingFinishHeight": 263850,
    "phasingHolding": "0",
    "phasingQuorum": "2",
    "version.Phasing": 1,
    "phasingWhitelist": [
     "11580081983047651163",
     "15295723609781267838"
    ],
    "phasingMinBalance": "0",
    "phasingMinBalanceModel": 0,
    "version.OrdinaryPayment": 0,
    "phasingVotingModel": 0
   },
   "senderRS": "ARDOR-4VDY-LNVT-LMAY-FMCKA",
   "subtype": 0,
   "amountNQT": "1100000000",
   "recipientRS": "ARDOR-BMUV-8QQR-47VK-CR7F3",
   "block": "16550954176569210781",
   "blockTimestamp": 44074579,
   "deadline": 1440,
   "timestamp": 44074556,
   "height": 263813,
   "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
   "chain": 2,
   "feeNQT": "200000000",
   "confirmations": 0,
   "fullHash": "b54a7e14c910e0750af0b29c0328347e27411dbe5d158d5d358ee2165b781968",
   "version": 1,
   "sender": "15295723609781267838",
   "recipient": "11580081983047651163",
   "ecBlockHeight": 263804,
   "transaction": "8493807353039047349"
  }
 ]
}


RS Convert

Get both the Reed-Solomon account address and the account number given an account ID. Javadoc

Request:

  • requestType is rsConvert
  • account is an account ID (either RS address or number)

Response:

  • accountRS (S) is the Reed-Solomon address of the account
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • account (S) is the account number

RS Convert Example

http://localhost:27876/nxt?
  requestType=rsConvert&
  account=ARDOR-L6FM-89WK-VK8P-FCRBB
{
 "accountRS": "ARDOR-L6FM-89WK-VK8P-FCRBB",
 "requestProcessingTime": 1,
 "account": "15323192282528158131"
}


Search Accounts

Get accounts having a name or description that match a given query in reverse relevance order. Javadoc

Request:

  • requestType is searchAccounts
  • query is a full text query on the account fields name (S) and description (S) in the standard Lucene syntax
  • firstIndex is a zero-based index to the first account to retrieve (optional)
  • lastIndex is a zero-based index to the last account to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • accounts (A) is an array of account objects with the following fields:
    • account (S) is the account number
    • accountRS (S) is the Reed-Solomon address of the account
    • name (S) is the name of the account
    • description (S) is the description of the account (if applicable)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Search Accounts Example

http://localhost:27876/nxt?
  requestType=searchAccounts&
  query=testnet AND tyler
{
 "accounts": [
  {
   "accountRS": "ARDOR-7C4U-3Z9K-GZM8-CU8EJ",
   "name": "Tyler Jordan",
   "description": "testnet account",
   "account": "12119426358687475802"
  }
 ],
 "requestProcessingTime": 16
}


Send Money

Send chain tokens to an account. POST only. Javadoc

Request: Refer to Create Transaction Request for common parameters.

  • requestType is sendMoney
  • chain is the chain to use for sending tokens (for example ARDOR(1) or IGNIS(2))
  • amountNQT is the amount (in NQT) in the transaction
  • recipient is the account ID of the recipient
  • recipientPublicKey is the public key of the receiving account (optional, enhances security of a new account)

Response: Refer to Create Transaction Response.

Send Money Example

http://localhost:27876/nxt?
  chain=2&
  requestType=sendMoney&
  secretPhrase=IWontTellYou&
  recipient=ARDOR-4VNQ-RWZC-4WWQ-GVM8S&
  amountNQT=100000000&
  feeNQT=1000000&
  deadline=60
{
 "signatureHash": "b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7",
 "unsignedTransactionBytes": "001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
 "transactionJSON": {
  "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
  "chain": 2,
  "signature": "5f0378b7390ff5a815eadd1354de533eef682f139362b153576e2207320a6...",
  "feeNQT": "1000000",
  "type": 0,
  "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
  "version": 1,
  "ecBlockId": "17321329645912574173",
  "signatureHash": "b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7",
  "senderRS": "ARDOR-L6FM-89WK-VK8P-FCRBB",
  "subtype": 0,
  "amountNQT": "100000000",
  "sender": "15323192282528158131",
  "recipientRS": "ARDOR-4VNQ-RWZC-4WWQ-GVM8S",
  "recipient": "17013046603665206934",
  "ecBlockHeight": 275727,
  "deadline": 60,
  "transaction": "15200507403046301754",
  "timestamp": 29796934,
  "height": 2147483647
 },
 "broadcasted": true,
 "requestProcessingTime": 8475,
 "transactionBytes": "001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
 "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
 "transaction": "15200507403046301754"
}


Set Account Info

Set account information. POST only. Javadoc

Request: Refer to Create Transaction Request for common parameters.

  • chain is reserved for 2, the Ignis child chain
  • requestType is setAccountInfo
  • name is a name to associate with the account (optional)
  • description is a description to associate with the account (optional)

Response: Refer to Create Transaction Response.

Set Account Info Example

http://localhost:27876/nxt?
  chain=2&
  requestType=setAccountInfo&
  secretPhrase=IWontTellYou&
  name=iwonttellyou
  description=example account
  feeNQT=100000000&
  deadline=60
{
 "signatureHash": "15917aafd59ad9cece7dfc127ab256711d1c58a8ed1a0dc7334949ca826d8a32",
 "unsignedTransactionBytes": "0115dfeecb013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
 "transactionJSON": {
  "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
  "signature": "3f5167a3a23677c85aba7fbbc8bc31cddf540a632abebee4a80fe08ba92b9a0...",
  "feeNQT": "100000000",
  "type": 1,
  "fullHash": "2d31c26aa2b0ae4cf233cc4035c555bca0c579bdcef24bc9819132dc2ce5b2e5",
  "version": 1,
  "ecBlockId": "17558522603047297060",
  "signatureHash": "15917aafd59ad9cece7dfc127ab256711d1c58a8ed1a0dc7334949ca826d8a32",
  "attachment": {
   "name": "iwonttellyou",
   "description": "example account",
   "version.AccountInfo": 1
  },
  "senderRS": "ARDOR-L6FM-89WK-VK8P-FCRBB",
  "subtype": 5,
  "amountNQT": "0",
  "sender": "15323192282528158131",
  "ecBlockHeight": 279080,
  "deadline": 60,
  "transaction": "5525548004452479277",
  "timestamp": 30142175,
  "height": 2147483647
 },
 "broadcasted": true,
 "requestProcessingTime": 8553,
 "transactionBytes": "0115dfeecb013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
 "fullHash": "2d31c26aa2b0ae4cf233cc4035c555bca0c579bdcef24bc9819132dc2ce5b2e5",
 "transaction": "5525548004452479277"
}


Set Account Property

Set account property. POST only. Javadoc

Request: Refer to Create Transaction Request for common parameters

  • chain is reserved for 2, the Ignis child chain
  • requestType is setAccountProperty
  • recipient is the account ID of the recipient.
  • property is the property name.
  • value is the property value.

Response: Refer to Create Transaction Response.

Set Account Property Example

http://localhost:27876/nxt?requestType=setAccountProperty&secretPhrase=
iwonttellyou&chain=2&property=country&value=switzerland&recipient=
ARDOR-EZQ9-35P5-XZ8C-4LW87&feeNQT=100000000&deadline=60

The request is shown above in URL format for consistency. The actual request must be an HTTP POST request with a multipart content type. For example, the corresponding cURL command is as follows:

cURL -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "secretPhrase=
iwonttellyou&chain=2&property=country&value=switzerland&recipient=
ARDOR-EZQ9-35P5-XZ8C-4LW87&feeNQT=100000000&deadline=60" "http://localhost:27876/nxt?requestType=setAccountProperty"
{
    "signatureHash": "34a690abc9f7fe4749da49d996e875e961aa0d38d6b80cdca9a01a7614004089",
    "transactionJSON": {
        "senderPublicKey": "b0db10704a831f1a0fd028e947784811e88fbe0fde25dc1f68209a2d9f93be13",
        "chain": 2,
        "signature": "f5fd4b881c5625c778ffe38bced33d44231eda406e95d9068dea69407ea3370dc873f52a123a0cbe590ecf4adf2a3c6238dc26c73ee63aeb7ac4331958b53a1e",
        "feeNQT": "100000000",
        "type": 1,
        "fullHash": "d94baf764f0b7e47dbbe30c5aef1694fef6dfd2ecc7c86e29eefee7e6d1b2b39",
        "version": 1,
        "phased": false,
        "ecBlockId": "1026208230615777523",
        "signatureHash": "34a690abc9f7fe4749da49d996e875e961aa0d38d6b80cdca9a01a7614004089",
        "attachment": {
            "property": "\"switzerland\"",
            "value": "\"country\"",
            "version.AccountProperty": 1
        },
        "senderRS": "ARDOR-EZQ9-35P5-XZ8C-4LW87",
        "subtype": 10,
        "amountNQT": "0",
        "sender": "2493747385666535111",
        "recipientRS": "ARDOR-EZQ9-35P5-XZ8C-4LW87",
        "recipient": "2493747385666535111",
        "ecBlockHeight": 684730,
        "deadline": 360,
        "transaction": "5151567459679947737",
        "timestamp": 72072027,
        "height": 2147483647
    },
    "unsignedTransactionBytes": "011a5bbb4b046801b0db10704a831f1a0fd028e947784811e88fbe0fde25dc1f68209a2d9f93be13c77e36ea08929b22000000000000000000e1f5050000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000ba720a00f3806fdbf2d23d0e010d22737769747a65726c616e64220922636f756e74727922",
    "broadcasted": true,
    "requestProcessingTime": 83,
    "transactionBytes": "011a5bbb4b046801b0db10704a831f1a0fd028e947784811e88fbe0fde25dc1f68209a2d9f93be13c77e36ea08929b22000000000000000000e1f505000000000000000000000000000000000000000000000000000000000000000000000000f5fd4b881c5625c778ffe38bced33d44231eda406e95d9068dea69407ea3370dc873f52a123a0cbe590ecf4adf2a3c6238dc26c73ee63aeb7ac4331958b53a1e00000000ba720a00f3806fdbf2d23d0e010d22737769747a65726c616e64220922636f756e74727922",
    "fullHash": "d94baf764f0b7e47dbbe30c5aef1694fef6dfd2ecc7c86e29eefee7e6d1b2b39",
    "transaction": "5151567459679947737"


Delete Account Property

Deletes an account property. POST only. Javadoc

Request:

  • chain is reserved for 2, the Ignis child chain
  • requestType is deleteAccountProperty
  • property is the name of the property
  • recipient is the account where a property should be removed (optional)
  • setter is the account who did set the property (optional)

Response: Refer to Create Transaction Response.

Delete Account Property Example

http://localhost:27876/nxt?
  chain=2&
  requestType=deleteAccountProperty&
  recipient=ARDOR-7A48-47JL-T7LD-D5FS3&
  property=testkey1&
  secretPhrase=iWontTellYou&
  feeNQT=100000000&
  deadline=60
{
  "signatureHash": "4ff58a03d056ee8a3fee89766bf8e4acd008c2147216...",
  "transactionJSON": {
    "senderPublicKey": "373522bcd8904f4707472e590cbb67976d40e7af...",
    "chain": "2";
    "signature": "26ed697fc82f3b15e6d2c972eff5b195445314aa4bacc8...",
    "feeNQT": "100000",
    "type": 1,
    "fullHash": "33f7edaec1034153f8e28a996b13b2b2665d0d0a3e4a194...",
    "version": 1,
    "phased": false,
    "ecBlockId": "10023643060833833497",
    "signatureHash": "4ff58a03d056ee8a3fee89766bf8e4acd008c21472...",
    "attachment": {
        "property": "940296349549404868",
        "version.AccountPropertyDelete": 1
    },
    "senderRS": "ARDOR-7A48-47JL-T7LD-D5FS3",
    "subtype": 11,
    "amountNQT": "0",
    "sender": "12745647715474645062",
    "recipientRS": "ARDOR-7A48-47JL-T7LD-D5FS3",
    "recipient": "12745647715474645062",
    "ecBlockHeight": 754255,
    "deadline": 60,
    "transaction": "5999080309032613683",
    "timestamp": 80189128,
    "height": 2147483647
  },
  "unsignedTransactionBytes": "011bc896c7043c00373522bcd8904f4707472e590cbb67976d40e7af39650ea11c...",
  "broadcasted": false,
  "requestProcessingTime": 3,
  "transactionBytes": "011bc896c7043c00373522bcd8904f4707472e590cbb67976d40e7af39650ea11cb2be5734...",
  "fullHash": "33f7edaec1034153f8e28a996b13b2b2665d0d0a3e4a1942718aa480c6097cf6",
  "transaction": "5999080309032613683"
}


Delete Contract Reference

Deletes a contract reference for a specific account (the contract itself is not deleted). POST only. Javadoc

Request:

  • chain is the chain where the contract was deployed
  • requestType is deleteContractReference
  • contractName is the name of the contract

Response: Refer to Create Transaction Response.

Delete Contract Reference Example

http://localhost:27876/nxt?
  chain=2&
  requestType=deleteContractReference&
  contractName=HelloWorld&
  secretPhrase=iWontTellYou&
  feeNQT=-1&
  feeRateNQTPerFXT=-1
{
    "minimumFeeFQT": "1000000",
    "signatureHash": "3f02544a0a58f1bf8a8c34aa1f41869d498358b41ec1598832b11cec6185f7b5",
    "transactionJSON": {
        "senderPublicKey": "df21142bd38c04bd5c5c342c6ca36802f9de89b75b2a0a8cbd32d29dca481e5c",
        "chain": 2,
        "signature": "cacc1c4d3bfa6b27c080f6f0950b99c7b80eb2892862f4d595f20c79b1ac570c6c938e7242f6c30c7761216d050d366d514af63f4fa2e9b3de4adcc52960aad3",
        "feeNQT": "100000",
        "type": 12,
        "fullHash": "f0ea6d68dd6a5a98d7ebb90628a6651cb50fc3f8472a6632c3af335d6c908ac4",
        "version": 1,
        "fxtTransaction": "0",
        "phased": false,
        "ecBlockId": "2500202528731563913",
        "signatureHash": "3f02544a0a58f1bf8a8c34aa1f41869d498358b41ec1598832b11cec6185f7b5",
        "attachment": {
            "contractReference": "3840654910244209564",
            "version.ContractReferenceDelete": 1
        },
        "senderRS": "ARDOR-X8ZN-WUJ2-SXY3-FBUYC",
        "subtype": 1,
        "amountNQT": "0",
        "sender": "15382970207090678772",
        "ecBlockHeight": 399638,
        "deadline": 15,
        "timestamp": 23765974,
        "height": 2147483647
    },
    "unsignedTransactionBytes": "020000000c0101d6a36a010f00df21142bd38c04bd5c5c342c6ca36802f9de89b75b2a0a8cbd32d29dca481e5c00000000000000000000000000000000a086010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001619060089079407f480b22200000000019c43f7cd4abf4c35000000000000000000000000000000000000000000000000000000000000000000000000",
    "broadcasted": false,
    "requestProcessingTime": 4,
    "transactionBytes": "020000000c0101d6a36a010f00df21142bd38c04bd5c5c342c6ca36802f9de89b75b2a0a8cbd32d29dca481e5c00000000000000000000000000000000a086010000000000cacc1c4d3bfa6b27c080f6f0950b99c7b80eb2892862f4d595f20c79b1ac570c6c938e7242f6c30c7761216d050d366d514af63f4fa2e9b3de4adcc52960aad31619060089079407f480b22200000000019c43f7cd4abf4c35000000000000000000000000000000000000000000000000000000000000000000000000",
    "fullHash": "f0ea6d68dd6a5a98d7ebb90628a6651cb50fc3f8472a6632c3af335d6c908ac4",
    "bundlerRateNQTPerFXT": "10000000"
}


Set Contract Reference

Sets a contract reference for a specific account. Refer to Lightweight contracts POST only. Javadoc

Request: Refer to Create Transaction Request for common parameters.

  • chain is the chain to set the contract reference (eg: 2 for IGNIS chain)
  • requestType is setContractReference
  • contractName is the name of the contract
  • contractParams are the setup parameters
  • contract is the contract specified in the notation chainId:FullHash of the data cloud file uploaded.


Response: Refer to Create Transaction Response.

Set Contract Reference Example

http://localhost:27876/nxt?
  chain=2&
  requestType=setContractReference&
  contractName=HelloWorld&
  contract=2:98ad60e6fc95e794216fc49a62e7f0ba2f37e2aed62dd3598c804d7a71ca2b32&
  secretPhrase=iWontTellYou&
  feeNQT=-1&
  feeRateNQTPerFXT=-1
{
    "minimumFeeFQT": "20000000",
    "signatureHash": "bbf4153ec57c645a88687619c5d7b7f3277a74bb6582da13388ebc822ab52983",
    "transactionJSON": {
        "senderPublicKey": "df21142bd38c04bd5c5c342c6ca36802f9de89b75b2a0a8cbd32d29dca481e5c",
        "chain": 2,
        "signature": "9f5d31676013401c73371e511785f6cedbc39ab148170278ad0ead6ba8f7f30dec147d2cad4818a364458398c2420fee6106456fb07524d4ba161e41f5a22b22",
        "feeNQT": "2000000",
        "type": 12,
        "fullHash": "8f7595d2869da7109f3c001cc69aed37d6f160dd75b4198986302606abad4097",
        "version": 1,
        "fxtTransaction": "0",
        "phased": false,
        "ecBlockId": "12170007748744184219",
        "signatureHash": "bbf4153ec57c645a88687619c5d7b7f3277a74bb6582da13388ebc822ab52983",
        "attachment": {
            "contractName": "HelloWorld",
            "version.ContractReference": 1,
            "contractParams": "",
            "contract": {
                "chain": 2,
                "transactionFullHash": "98ad60e6fc95e794216fc49a62e7f0ba2f37e2aed62dd3598c804d7a71ca2b32"
            }
        },
        "senderRS": "ARDOR-X8ZN-WUJ2-SXY3-FBUYC",
        "subtype": 0,
        "amountNQT": "0",
        "sender": "15382970207090678772",
        "ecBlockHeight": 399822,
        "deadline": 15,
        "timestamp": 23776637,
        "height": 2147483647
    },
    "unsignedTransactionBytes": "020000000c00017dcd6a010f00df21142bd38c04bd5c5c342c6ca36802f9de89b75b2a0a8cbd32d29dca481e5c0000000000000000000000000000000080841e000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000ce1906009b01a669918de4a800000000010a48656c6c6f576f726c64000200000098ad60e6fc95e794216fc49a62e7f0ba2f37e2aed62dd3598c804d7a71ca2b32000000000000000000000000000000000000000000000000000000000000000000000000",
    "broadcasted": false,
    "requestProcessingTime": 3,
    "transactionBytes": "020000000c00017dcd6a010f00df21142bd38c04bd5c5c342c6ca36802f9de89b75b2a0a8cbd32d29dca481e5c0000000000000000000000000000000080841e00000000009f5d31676013401c73371e511785f6cedbc39ab148170278ad0ead6ba8f7f30dec147d2cad4818a364458398c2420fee6106456fb07524d4ba161e41f5a22b22ce1906009b01a669918de4a800000000010a48656c6c6f576f726c64000200000098ad60e6fc95e794216fc49a62e7f0ba2f37e2aed62dd3598c804d7a71ca2b32000000000000000000000000000000000000000000000000000000000000000000000000",
    "fullHash": "8f7595d2869da7109f3c001cc69aed37d6f160dd75b4198986302606abad4097",
    "bundlerRateNQTPerFXT": "10000000"
}


Start Funding Monitor

Starts a funding monitor that will transfer ARDR, ASSET, CURRENCY or child chain tokens (ie: IGNIS) from the funding account to a recipient account when the amount held by the recipient account drops below the threshold. The transfer will not be done until the current block height is greater than equal to the block height of the last transfer plus the interval. The funding account is identified by the secret phrase.

The recipient accounts are identified by the specified account property (see Set Account Property). Each account that has this property set by the funding account will be monitored for changes. The property value can be omitted or it can consist of a JSON string containing one or more values in the format: {"amount":long,"threshold":long,"interval":integer} . POST only. Javadoc

Request:

  • chain is the chain for the funding monitor
  • requestType is startFundingMonitor
  • property is the name of the account property
  • amount is the amount to fund the recipient account with (in NQT or QNT)
  • threshold is the NQT threshold for funding the account
  • interval is the the number of blocks to wait after before funding the recipient
  • secretPhrase is the secret phrase of the funding account
  • holdingType is a string representing the holding type (optional)
  • holding is the holding ID (optional)

Response:

  • started (B) is true if the monitor has been started
  • requestProcessingTime (N) is the API request processing time (in millisec)

Start Funding Monitor Example

http://localhost:27876/nxt?
 requestType=startFundingMonitor&
 chain=2&
 property=funding&
 amount=1000000000&
 threshold=15000000000&
 interval=10&
 secretPhrase=IWontTellYou
{
 "started": true,
 "requestProcessingTime": 5
}


Stop Funding Monitor

Stop a funding monitor. When the secret phrase is specified, a single monitor will be stopped. The monitor is identified by the secret phrase, holding and account property. The administrator password is not required and will be ignored.

When the administrator password is specified, a single monitor can be stopped by specifying the funding account, holding and account property. If no account is specified, all monitors will be stopped.

The holding type and account property name must be specified when the secret phrase or account is specified. Holding type codes are listed in getConstants. In addition, the holding identifier must be specified when the holding type is ASSET or CURRENCY. POST only. Javadoc

Request:

  • requestType is s
  • chain is the chain for the funding monitor to be stopped
  • secretPhrase is the secret phrase of the funding account, used to stop a single monitor. (optional)
  • adminPassword is the admin password, used to stop a single monitor or all monitors (optional if secretPhrase is provided)
  • property is the name of the account property (optional)
  • holdingType is a string representing the holding type (optional)
  • holding is the holding ID (optional)
  • account is the account ID (optional)

Response:

  • stopped (N) is the number of the monitors that have been stopped
  • requestProcessingTime (N) is the API request processing time (in millisec)

Stop Funding Monitor Example

http://localhost:27876/nxt?
 requestType=stopFundingMonitor&
 chain=2&
 property=funding&
 secretPhrase=IWontTellYou
{
 "stopped": 1,
 "requestProcessingTime": 5
}