ARDR Node API
v1.0.0https://ardr.nownodes.ioJSON-RPC API for ARDR network
Authentication
ApiKeyAuthapiKeyAPI Key: api-key in header
Account Control
getAccount
Get account information given an account ID
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Account information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAllPhasingOnlyControls
Get All Phasing Only Controls
Retrieve all accounts subject to phasing control with their respective restrictions.
Parameters
requestTypestringrequiredqueryfirstIndexintegerquerylastIndexintegerqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Phasing only controls information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetPhasingOnlyControl
Get Phasing Only Control
Retrieve phasing control with their respective restrictions for a specific account.
Parameters
requestTypestringrequiredqueryaccountstringrequiredqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Phasing control information for specific account
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerleaseBalance
Lease Balance
Lease the entire guaranteed balance of ARDR to another account, after 1440 confirmations. POST only.
Body
requestTypestringrequiredchainintegerrequiredperiodintegerrequiredrecipientstringrequiredrecipientPublicKeystringsecretPhrasestringfeeNQTstringdeadlineintegerResponse
Transaction creation response
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersetPhasingOnlyControl
Set Phasing Only Control
Sets (or removes) phasing control for a specific account. POST only.
Body
requestTypestringrequiredchainintegerrequiredcontrolVotingModelintegerrequiredcontrolQuorumintegercontrolMinBalanceintegercontrolMinBalanceModelintegercontrolHoldingstringcontrolWhitelistedArray<string>controlMaxFeesstringcontrolMinDurationintegercontrolMaxDurationintegersecretPhrasestringfeeNQTstringdeadlineintegerResponse
Transaction creation response
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerForging
leaseBalance
Lease the entire guaranteed balance of ARDR to another account, after 1440 confirmations
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Balance leased successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headeraddBundlingRule
Add a bundling rule to an account bundler
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Bundling rule added successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerblacklistBundler
Blacklist a specific bundler
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Bundler blacklisted successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerbundleTransactions
Bundle unconfirmed transactions
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Transactions bundled successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAllBundlersRates
Check all bundler rates ordered by chain
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
All bundler rates information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetBundlers
Get bundlers running
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Bundlers information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetBundlersRates
Get the most competitive rates per chain
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Most competitive bundler rates per chain
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetGuaranteedBalance
Get the balance of an account in ARDR that is confirmed at least a specified number of times
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Guaranteed balance information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetNextBlockGenerators
Returns the next block generators ordered by hit time
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Next block generators information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerstartBundler
Start a bundler with an account, or check to see if an account is bundling
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Bundler started successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerstartForging
Start or stop forging with an account, or check to see if an account is forging
Body
jsonrpcstringrequiredmethodstringstartForgingstopForginggetForgingrequiredparamsobjectrequiredidintegerrequiredResponse
Forging operation completed successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerstopForging
Start or stop forging with an account, or check to see if an account is forging
Body
jsonrpcstringrequiredmethodstringstartForgingstopForginggetForgingrequiredparamsobjectrequiredidintegerrequiredResponse
Forging operation completed successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetForging
Start or stop forging with an account, or check to see if an account is forging
Body
jsonrpcstringrequiredmethodstringstartForgingstopForginggetForgingrequiredparamsobjectrequiredidintegerrequiredResponse
Forging operation completed successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerstopBundler
Stop a bundler with an account
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Bundler stopped successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerAliases
deleteAlias
Delete an alias given an alias ID or name
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaliasstringqueryaliasNamestringqueryResponse
Successful alias deletion
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAlias
Get information about a given alias
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaliasstringqueryaliasNamestringqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful alias information retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAliasCount
Get the number of aliases owned by an account given the account ID
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful alias count retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersellAlias
Sell an alias to another account
Parameters
chainintegerrequiredqueryrequestTypestringrequiredquerysecretPhrasestringrequiredqueryaliasNamestringrequiredquerypriceNQTstringrequiredqueryrecipientstringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful alias sale transaction
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersetAlias
Create and/or assign an alias
Parameters
requestTypestringrequiredquerychainintegerrequiredquerysecretPhrasestringrequiredqueryaliasNamestringrequiredqueryaliasURIstringqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful alias creation/assignment
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerBip 32
deriveAccountFromMasterPublicKey
Derives an account from their serialized master public key
Parameters
requestTypestringrequiredqueryserializedMasterPublicKeystringrequiredquerychildIndexintegerrequiredqueryResponse
Successful account derivation
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerderiveAccountFromSeed
Derives an account from a seed
Parameters
requestTypestringrequiredquerymnemonicstringrequiredquerypassphrasestringquerybip32PathstringrequiredqueryResponse
Successful account derivation from seed
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetLedgerMasterPublicKey
Returns the hardware Ledger master public key
It requires the hardware wallet to be connected
Parameters
requestTypestringrequiredquerybip32PathstringrequiredqueryResponse
Successful Ledger master public key retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerBlocks
getBlock
Get a block object given a block ID or block height
Parameters
requestTypestringrequiredqueryblockstringqueryheightintegerquerytimestampintegerqueryincludeTransactionsbooleanqueryincludeExecutedPhasedbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful block retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetBlockchainStatus
Get the blockchain status
Parameters
requestTypestringrequiredqueryResponse
Successful blockchain status retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetBlockId
Get a block ID given a block height
Parameters
requestTypestringrequiredqueryheightintegerrequiredqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful block ID retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetBlocks
Get blocks from the blockchain in reverse block height order
Parameters
requestTypestringrequiredquerytimestampintegerqueryfirstIndexintegerquerylastIndexintegerqueryincludeTransactionsbooleanqueryincludeExecutedPhasedbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful blocks retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetECBlock
Get Economic Cluster block data
Parameters
requestTypestringrequiredquerytimestampintegerqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful EC block data retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerChild Chain Permissions
addAccountPermission
Grants a permission to an account
For extended information refer to Child Chain Control
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryrecipientstringrequiredquerypermissionstringrequiredquerypublicKeystringquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful account permission addition
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAccountPermissions
Queries the permissions of an account
For extended information refer to Child Chain Control
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful account permissions retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetChainPermissions
Queries the permissions of a chain
For extended information refer to Child Chain Control
Parameters
requestTypestringrequiredquerychainintegerrequiredquerypermissionstringquerygranterstringqueryfirstIndexintegerquerylastIndexintegerqueryadminPasswordstringqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful chain permissions retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerremoveAccountPermission
Revokes a permission to an account
For extended information refer to Child Chain Control
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryrecipientstringrequiredquerypermissionstringrequiredquerypublicKeystringquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful account permission removal
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerCoin Exchange
cancelCoinExchange
Cancel an existing coin exchange order
POST only
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryorderstringrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful coin exchange cancellation
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerexchangeCoins
Place an asset order
POST only. The transaction ID is also the order ID.
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryexchangeintegerrequiredqueryquantityQNTstringrequiredquerypriceNQTPerCoinstringrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredqueryfeeRateNQTPerFXTstringqueryResponse
Successful coin exchange order placement
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCoinExchangeOrder
Get a bid/ask coin exchange order given an order ID
Parameters
requestTypestringrequiredqueryorderstringrequiredqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful coin exchange order retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCoinExchangeOrders
Get bid/ask order IDs given an account or a chain/exchange pair
Parameters
requestTypestringrequiredquerychainintegerqueryexchangeintegerqueryaccountstringqueryfirstIndexintegerquerylastIndexintegerqueryshowExpectedCancellationsbooleanqueryadminPasswordstringqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful coin exchange orders retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCoinExchangeTrade
Get an executed trade given the full hash of the bid/ask coin exchange
Parameters
requestTypestringrequiredqueryorderFullHashstringrequiredquerymatchFullHashstringrequiredqueryrequireLastBlockstringqueryResponse
Successful coin exchange trade retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExpectedCoinExchangeOrderCancellations
Get the expected coin exchange order cancellations for a specific chain
Since version 2.3.0e it returns both bundled and non-bundled transactions
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful expected coin exchange order cancellations retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExpectedCoinExchangeOrders
Get the expected coin exchange orders to be completed for a specific chain/exchange or an account
Since version 2.3.0e it returns both bundled and non-bundled transactions
Parameters
requestTypestringrequiredquerychainintegerqueryexchangeintegerqueryaccountstringqueryResponse
Successful expected coin exchange orders retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersimulateCoinExchange
Simulate a coin exchange given a chain, exchange, quantity and a price per coin
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryexchangeintegerrequiredqueryquantityQNTstringrequiredquerypriceNQTPerCoinstringrequiredquerybidNQTPerCoinstringqueryResponse
Successful coin exchange simulation
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerDGS
dgsDelisting
Delist a listed product
POST only
Parameters
requestTypestringrequiredquerychainintegerrequiredquerygoodsstringrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful product delisting
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdgsDelivery
Deliver a product
POST only
Parameters
requestTypestringrequiredquerychainintegerrequiredquerypurchasestringrequiredquerydiscountNQTstringquerygoodsToEncryptstringquerygoodsIsTextbooleanquerygoodsDatastringquerygoodsNoncestringquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful product delivery
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdgsFeedback
Give feedback about a purchased product after delivery
POST only. The unencrypted message parameter is used for public feedback, but in addition or instead, an encrypted message can be used for private feedback to the seller and/or an encrypted message can be sent to self (buyer) although the current NRS client does not recognize non-public feedback messages.
Parameters
requestTypestringrequiredquerychainintegerrequiredquerypurchasestringrequiredquerymessagestringrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful feedback submission
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdgsListing
List a product in the DGS by creating a listing transaction
POST only. The transaction ID is also the goods ID.
Parameters
requestTypestringrequiredquerychainintegerrequiredquerynamestringrequiredquerydescriptionstringrequiredquerytagsstringqueryquantityintegerrequiredquerypriceNQTstringrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful product listing
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdgsPriceChange
Change the price of a listed product
POST only
Parameters
requestTypestringrequiredquerychainintegerrequiredquerygoodsstringrequiredquerypriceNQTstringrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful price change
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdgsPurchase
Purchase a product for sale
POST only. The transaction ID is also the purchase order ID.
Parameters
requestTypestringrequiredquerychainintegerrequiredquerygoodsstringrequiredquerypriceNQTstringrequiredqueryquantityintegerrequiredquerydeliveryDeadlineTimestampintegerrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful product purchase
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdgsQuantityChange
Change the quantity of a listed product
POST only
Parameters
requestTypestringrequiredquerychainintegerrequiredquerygoodsstringrequiredquerydeltaQuantityintegerrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful quantity change
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdgsRefund
Refund a purchase
POST only
Parameters
requestTypestringrequiredquerychainintegerrequiredquerypurchasestringrequiredqueryrefundNQTstringrequiredquerysecretPhrasestringrequiredqueryfeeNQTstringrequiredquerydeadlineintegerrequiredqueryResponse
Successful refund
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSExpiredPurchases
Get purchase orders which have expired without being delivered, given a seller ID, in reverse chronological order
Parameters
requestTypestringrequiredquerychainintegerrequiredquerysellerstringrequiredqueryfirstIndexintegerquerylastIndexintegerqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful expired purchases retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSGood
Get a DGS product given a goods ID
Parameters
requestTypestringrequiredquerychainintegerrequiredquerygoodsstringrequiredqueryincludeCountsbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS product retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSGoods
Get DGS products for sale in reverse chronological listing creation order unless a seller is given, then in product name order
If none of the optional parameters are specified, all in-stock products in the blockchain are retrieved at once, which may take a long time.
Parameters
requestTypestringrequiredquerychainintegerrequiredquerysellerstringqueryfirstIndexintegerquerylastIndexintegerqueryinStockOnlybooleanqueryhideDelistedbooleanqueryincludeCountsbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS goods retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSGoodsCount
Get the number of products for sale by a given seller or all sellers
The numberOfGoods field refers to the number of distinct products for sale, regardless of the quantity of each.
Parameters
requestTypestringrequiredquerychainintegerrequiredquerysellerstringqueryinStockOnlybooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS goods count retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSGoodsPurchaseCount
Get the number of completed purchase orders given a goods ID
Parameters
requestTypestringrequiredquerychainintegerrequiredquerygoodsstringrequiredquerywithPublicFeedbacksOnlybooleanquerycompletedbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS goods purchase count retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSGoodsPurchases
Get completed purchase orders given a goods ID and optionally a buyer ID in reverse chronological order
Parameters
requestTypestringrequiredquerychainintegerrequiredquerygoodsstringrequiredquerybuyerstringqueryfirstIndexintegerquerylastIndexintegerquerywithPublicFeedbacksOnlybooleanquerycompletedbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS goods purchases retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSPendingPurchases
Get pending purchase orders given a seller ID in reverse chronological order
Parameters
requestTypestringrequiredquerychainintegerrequiredquerysellerstringrequiredqueryfirstIndexintegerquerylastIndexintegerqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS pending purchases retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSPurchase
Get a purchase order given a purchase order ID
Parameters
requestTypestringrequiredquerychainintegerrequiredquerypurchasestringrequiredquerysharedKeystringqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS purchase retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSPurchaseCount
Get the number of purchase orders given a seller and/or buyer ID, or all orders combined
Parameters
requestTypestringrequiredquerychainintegerrequiredquerysellerstringquerybuyerstringquerywithPublicFeedbacksOnlybooleanquerycompletedbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS purchase count retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSPurchases
Get purchase orders given a seller and/or buyer ID in reverse chronological order
Parameters
requestTypestringrequiredquerychainintegerrequiredquerysellerstringquerybuyerstringqueryfirstIndexintegerquerylastIndexintegerquerywithPublicFeedbacksOnlybooleanquerycompletedbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS purchases retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetDGSTagCount
Get the number of tags used by all sellers
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryinStockOnlybooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS tag count retrieval
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersearchDGSGoods
Get product listings that have a name or description that match a given query in reverse relevance order, then name order (given a seller), then reverse chronological order
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryquerystringquerytagstringquerysellerstringqueryfirstIndexintegerquerylastIndexintegerqueryinStockOnlybooleanqueryhideDelistedbooleanqueryincludeCountsbooleanqueryrequireBlockstringqueryrequireLastBlockstringqueryResponse
Successful DGS goods search
Bad Request - Invalid parameters
Unauthorized - Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerMessages
decryptFrom
Decrypt an AES-encrypted message
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Message decrypted successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdownloadPrunableMessage
Downloading a prunable message attachments directly as binary data
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Prunable data as a binary file
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerencryptTo
Encrypt a message using AES without sending it
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Message encrypted successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAllPrunableMessages
Get all available prunable messages in reverse block timestamp order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
All prunable messages retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetPrunableMessage
Get the prunable message given a transaction ID, optionally decrypting it if encrypted
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Prunable message retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerreadMessage
Get a message given a transaction ID
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Message retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersendMessage
Create an Arbitrary Message transaction
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Message sent successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerverifyPrunableMessage
Verify that a prunable message obtained from any source, when hashed, matches the hash of the original prunable message
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Prunable message verification result
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerMonetary System
canDeleteCurrency
Determine if a currency can be deleted
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency deletion capability check result
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headercurrencyBuy
Make an exchange request to buy an exchangeable currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency buy request created successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headercurrencyMint
Submit a valid computed nonce to the blockchain in return for newly minted currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency minting request created successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headercurrencyReserveClaim
Claim currency reserve
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency reserve claim created successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headercurrencyReserveIncrease
Increase the currency reserve of an unissued reservable currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency reserve increase created successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headercurrencySell
Make an exchange request to sell an exchangeable currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency sell request created successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerdeleteCurrency
Delete a deletable currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency deletion request created successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAccountCurrencies
Get the currencies issued by a given account
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Account currencies retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAccountCurrencyCount
Get the number of currencies issued by a given account
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Account currency count retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAccountExchangeRequests
Get the exchange requests associated with a given account and/or currency in reverse chronological order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Account exchange requests retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAllCurrencies
Get all currencies in reverse creation order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
All currencies retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAllExchanges
Get all currency exchanges in reverse chronological order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
All exchanges retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAvailableToBuy
Calculates the rate required in order to completely fill an exchange request
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Available to buy calculation result
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAvailableToSell
Calculates the rate required in order to completely fill an exchange request
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Available to sell calculation result
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetBuyOffers
Get currency buy offers given a currency ID and/or an account ID
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Buy offers retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCurrencies
Get currencies given multiple currency IDs
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currencies retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCurrenciesByIssuer
Get currencies issued by multiple accounts in reverse creation order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currencies by issuer retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCurrencyAccountCount
Get the number of accounts that hold a given currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency account count retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCurrencyAccounts
Get the accounts that hold a given currency in reverse units order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency accounts retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCurrencyFounders
Get a reservable currency's founders
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency founders retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCurrencyIds
Get all currency IDs in reverse chronological creation order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency IDs retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCurrencyTransfers
Get currency transfers given a currency ID and/or an account ID in reverse block height order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency transfers retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExchanges
Get currency exchanges given a currency and/or an account in reverse chronological order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Exchanges retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExchangesByExchangeRequest
Get currency exchanges given an exchange request transaction ID in reverse chronological order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Exchanges by exchange request retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExchangesByOffer
Get currency exchanges given a currency offer ID in reverse chronological order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Exchanges by offer retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExpectedBuyOffers
Get expected buy offers from the unconfirmed transactions pool or phased transactions
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Expected buy offers retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExpectedCurrencyTransfers
Get expected currency transfers from the unconfirmed transactions pool or phased transactions
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Expected currency transfers retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExpectedExchangeRequests
Get expected exchange requests from the unconfirmed transactions pool or phased transactions scheduled to finish in the next block
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Expected exchange requests retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetExpectedSellOffers
Get expected sell offers from the unconfirmed transactions pool or phased transactions
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Expected sell offers retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetLastExchanges
Get the last exchange of each of multiple currencies
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Last exchanges retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetMintingTarget
Get the current minting target of a mintable currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Minting target retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetOffer
Get offer details given an offer ID
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Offer details retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetSellOffers
Get currency sell offers given a currency ID and/or an account ID
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Sell offers retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerissueCurrency
Issue a new currency or re-issue an existing currency with different properties
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency issued successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerpublishExchangeOffer
Publish an exchange offer for an exchangeable currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Exchange offer published successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersearchCurrencies
Get currencies having a code that matches a given query in reverse relevance order
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currencies search results
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headertransferCurrency
Transfer currency to a given recipient
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency transfer created successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerSearch
searchCurrencies
Search currencies by query
Parameters
requestTypestringrequiredqueryquerystringrequiredqueryResponse
Currencies matching the search query
Bad Request
Internal Server Error
searchPolls
Search polls by query
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryquerystringrequiredqueryincludeFinishedbooleanqueryResponse
Polls matching the search query
Bad Request
Internal Server Error
Phasing
approveTransaction
Approve (vote for) a phased transaction
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Transaction approved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headercreatePhasedTransaction
Create a phased transaction with conditional deferred execution
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Phased transaction created successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAccountPhasedTransactionCount
Get the number of pending phased transactions associated with an account
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Account phased transaction count retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAccountPhasedTransactions
Get pending phased transactions associated with an account
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Account phased transactions retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetAssetPhasedTransactions
Get pending phased transactions based on an asset
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Asset phased transactions retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetCurrencyPhasedTransactions
Get pending phased transactions based on a currency
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Currency phased transactions retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetHashedSecretPhasedTransactions
Returns a list of phased by hash transactions
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Hashed secret phased transactions retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headernull
Gets the phased transactions with by-transaction voting model
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Linked phased transactions retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetPhasingPoll
Get the details of a phasing poll
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Phasing poll details retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetPhasingPollVote
Get a cast phasing poll vote
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Phasing poll vote retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetPhasingPollVotes
Get all cast phasing poll votes in a phasing poll
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Phasing poll votes retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headergetVoterPhasedTransactions
Get pending phased transactions which include a whitelist
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Voter phased transactions retrieved successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerparsePhasingParams
Parse phasing parameters
Body
jsonrpcstringrequiredmethodstringrequiredparamsobjectrequiredidintegerrequiredResponse
Phasing parameters parsed successfully
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerServer info
eventRegister
Register event listener
Body
Parameters
requestTypestringrequiredqueryResponse
Event registration status
Bad Request
Internal Server Error
eventWait
Wait for registered events
Body
Parameters
requestTypestringrequiredquerytokenstringrequiredqueryResponse
Events response
Bad Request
Internal Server Error
getBundlingOptions
Get bundling options
Parameters
requestTypestringrequiredqueryResponse
Available bundling options and filters
Bad Request
Internal Server Error
getConstants
Get system constants
Parameters
requestTypestringrequiredqueryResponse
System constants and configuration
Bad Request
Internal Server Error
getPlugins
Get installed plugins
Parameters
requestTypestringrequiredqueryResponse
List of installed plugins
Bad Request
Internal Server Error
getState
Get node state
Parameters
requestTypestringrequiredqueryResponse
Node and network state information
Bad Request
Internal Server Error
getTime
Get current time
Parameters
requestTypestringrequiredqueryResponse
Current time information
Bad Request
Internal Server Error
Shuffling
getAccountShufflings
Get account shufflings
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredqueryResponse
Account shufflings information
Bad Request
Internal Server Error
getAllShufflings
Get all shufflings
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryResponse
All shufflings information
Bad Request
Internal Server Error
getAssignedShufflings
Get assigned shufflings
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredqueryResponse
Assigned shufflings information
Bad Request
Internal Server Error
getHoldingShufflings
Get holding shufflings
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryholdingstringrequiredqueryincludeFinishedbooleanqueryResponse
Holding shufflings information
Bad Request
Internal Server Error
getShufflers
Get active shufflers
Parameters
requestTypestringrequiredqueryadminPasswordstringrequiredqueryResponse
Active shufflers information
Bad Request
Internal Server Error
getShuffling
Get shuffling info
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryshufflingstringrequiredqueryResponse
Shuffling information
Bad Request
Internal Server Error
getShufflingParticipants
Get shuffling participants
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryshufflingstringrequiredqueryResponse
Shuffling participants information
Bad Request
Internal Server Error
shufflingCreate
Create shuffling
Body
secretPhrasestringchainintegerparticipantCountintegerregistrationPeriodintegerfeeNQTstringdeadlineintegerParameters
requestTypestringrequiredqueryResponse
Shuffling creation result
Bad Request
Internal Server Error
shufflingProcess
Process shuffling
Body
secretPhrasestringchainintegerfeeNQTstringdeadlineintegerParameters
requestTypestringrequiredqueryResponse
Shuffling processing result
Bad Request
Internal Server Error
shufflingRegister
Register to shuffling
Body
secretPhrasestringshufflingFullHashstringchainintegerfeeNQTstringdeadlineintegerParameters
requestTypestringrequiredqueryResponse
Shuffling registration result
Bad Request
Internal Server Error
shufflingVerify
Verify shuffling
Body
secretPhrasestringshufflingFullHashstringshufflingStateHashstringchainintegerfeeNQTstringdeadlineintegerParameters
requestTypestringrequiredqueryResponse
Shuffling verification result
Bad Request
Internal Server Error
startShuffler
Start automated shuffler
Body
secretPhrasestringshufflingFullHashstringrecipientSecretPhrasestringchainintegerfeeRateNQTPerFXTstringParameters
requestTypestringrequiredqueryResponse
Shuffler start result
Bad Request
Internal Server Error
stopShuffler
Stop automated shuffler
Body
secretPhrasestringshufflingFullHashstringParameters
requestTypestringrequiredqueryResponse
Shuffler stop result
Bad Request
Internal Server Error
Tagged Data
detectMimeType
Detect MIME type
Body
datastringisTextbooleanParameters
requestTypestringrequiredqueryResponse
MIME type detection result
Bad Request
Internal Server Error
downloadTaggedData
Download tagged data
Parameters
requestTypestringrequiredquerychainintegerrequiredquerytransactionFullHashstringrequiredqueryResponse
Tagged data download result
Bad Request
Internal Server Error
getAccountTaggedData
Get account tagged data
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredquerylastIndexintegerqueryResponse
Account tagged data
Bad Request
Internal Server Error
getAllTaggedData
Get all tagged data
Parameters
requestTypestringrequiredquerychainintegerrequiredquerylastIndexintegerqueryResponse
All tagged data
Bad Request
Internal Server Error
getChannelTaggedData
Get channel tagged data
Parameters
requestTypestringrequiredquerychainintegerrequiredquerychannelstringrequiredquerylastIndexintegerqueryResponse
Channel tagged data
Bad Request
Internal Server Error
getDataTagCount
Get data tag count
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryResponse
Data tag count
Bad Request
Internal Server Error
getTaggedData
Get tagged data by transaction hash
Parameters
requestTypestringrequiredquerytransactionFullHashstringrequiredquerychainintegerrequiredqueryResponse
Tagged data
Bad Request
Internal Server Error
searchTaggedData
Search tagged data
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryquerystringrequiredquerylastIndexintegerqueryResponse
Search results
Bad Request
Internal Server Error
uploadTaggedData
Upload tagged data
Body
chainintegernamestringdescriptionstringtagsstringchannelstringdatastringsecretPhrasestringfeeNQTstringdeadlineintegerParameters
requestTypestringrequiredqueryResponse
Upload result
Bad Request
Internal Server Error
verifyTaggedData
Verify tagged data
Parameters
requestTypestringrequiredquerychainintegerrequiredquerytransactionFullHashstringrequiredquerydatastringrequiredquerynamestringrequiredquerydescriptionstringrequiredquerytagsstringrequiredquerychannelstringrequiredqueryResponse
Verification result
Bad Request
Internal Server Error
Tokens
decodeFileToken
Decode file token
Body
tokenstringParameters
requestTypestringrequiredqueryResponse
File token decoding result
Bad Request
Internal Server Error
decodeToken
Decode token
Parameters
requestTypestringrequiredquerywebsitestringrequiredquerytokenstringrequiredqueryResponse
Token decoding result
Bad Request
Internal Server Error
generateFileToken
Generate file token
Body
tokenstringParameters
requestTypestringrequiredqueryResponse
File token generation result
Bad Request
Internal Server Error
generateToken
Generate token
Body
secretPhrasestringwebsitestringParameters
requestTypestringrequiredqueryResponse
Token generation result
Bad Request
Internal Server Error
Transactions
broadcastTransaction
Broadcast transaction
Body
transactionBytesstringParameters
requestTypestringrequiredqueryResponse
Transaction broadcast result
Bad Request
Internal Server Error
calculateFee
Calculate transaction fee
Parameters
requestTypestringrequiredquerytransactionBytesstringrequiredqueryResponse
Fee calculation result
Bad Request
Internal Server Error
calculateFullHash
Calculate transaction full hash
Parameters
requestTypestringrequiredqueryunsignedTransactionBytesstringrequiredquerysignatureHashstringrequiredqueryResponse
Full hash calculation result
Bad Request
Internal Server Error
getBlockchainTransactions
Get blockchain transactions
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredquerylastIndexintegerqueryResponse
Blockchain transactions
Bad Request
Internal Server Error
getExecutedTransactions
Get executed transactions
Parameters
requestTypestringrequiredquerychainintegerrequiredquerysenderstringrequiredqueryResponse
Executed transactions
Bad Request
Internal Server Error
getExpectedTransactions
Get expected transactions
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredqueryResponse
Expected transactions
Bad Request
Internal Server Error
getFxtTransaction
Get FXT transactions
Parameters
requestTypestringrequiredquerytransactionstringrequiredqueryfullHashstringrequiredqueryResponse
FXT transactions
Bad Request
Internal Server Error
getReferencingTransactions
Get referencing transactions
Parameters
requestTypestringrequiredquerychainintegerrequiredquerytransactionFullHashstringrequiredqueryResponse
Referencing transactions
Bad Request
Internal Server Error
getTransaction
Get transaction
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryfullHashstringrequiredqueryResponse
Transaction information
Bad Request
Internal Server Error
getTransactionBytes
Get transaction bytes
Parameters
requestTypestringrequiredquerychainintegerrequiredquerytransactionstringrequiredqueryResponse
Transaction bytes
Bad Request
Internal Server Error
getUnconfirmedTransactionIds
Get unconfirmed transaction IDs
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredqueryResponse
Unconfirmed transaction IDs
Bad Request
Internal Server Error
getUnconfirmedTransactions
Get unconfirmed transactions
Parameters
requestTypestringrequiredquerychainintegerrequiredqueryaccountstringrequiredqueryResponse
Unconfirmed transactions
Bad Request
Internal Server Error
parseTransaction
Parse transaction
Parameters
requestTypestringrequiredquerytransactionBytesstringrequiredqueryResponse
Parsed transaction
Bad Request
Internal Server Error
processVoucher
Process voucher
Body
secretPhrasestringtransactionBytesstringParameters
requestTypestringrequiredqueryResponse
Voucher processing result
Bad Request
Internal Server Error
retrievePrunedTransaction
Retrieve pruned transaction
Parameters
requestTypestringrequiredquerychainintegerrequiredquerytransactionFullHashstringrequiredqueryResponse
Pruned transaction retrieval result
Bad Request
Internal Server Error