Skip to content

Get Account

Get account information given an account ID.

Request:

  • requestType is getAccount
  • account is the account ID
  • includeLessors is true to include lessors (optional)
  • includeAssets is true to include assetBalances and unconfirmedAssetBalances (optional)
  • includeCurrencies is true to include accountCurrencies (optional)
  • includeEffectiveBalance is true to include effectiveBalanceXIN and guaranteedBalanceTQT (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:

  • unconfirmedBalanceTQT (S) is balanceTQT less unconfirmed outgoing transactions, the balance displayed in the client
  • effectiveBalanceXIN (N) is the balance (in XIN) of the account available for forging: the unleased guaranteedBalance of this account plus the leased
  • guaranteedBalance of all lessors to this account
  • lessorsInfo (A) is an array of lessor objects including the fields:
  • currentHeightTo (S)
  • nextHeightFrom (S)
  • effectiveBalanceXIN (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
  • forgedBalanceTQT (S) is the balance (in TQT) that the account has forged
  • balanceTQT (S) is the minimally confirmed basic balance (in TQT) of the account
  • publicKey (S) is the public key of the account
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • assetBalances (A) is an array of asset objects including the fields balanceQNT (S) and asset (S) ID
  • guaranteedBalanceTQT (S) is the balance (in TQT) of the account with at least 1440 confirmations
  • unconfirmedAssetBalances (A) is an array of asset objects including the fields unconfirmedBalanceQNT (S) and asset (S) ID
  • 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
  • accountCurrencies (A) is an array of currency objects (refer to Get Account Currencies for details)
  • name (S) is the name associated with the account, if applicable
  • description (S) is the description of the account, if applicable
  • 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)