show navigation 
/ help /
REST API
This Application Programming Interface can be used to retrieve information from hybrixd. The requests are formatted as forward-slash ('/') separated commands (similar to a website url or file path.)
Examples
/asset returns the assets supported by the hybrixd node.
/asset/btc/balance/32FCGFdRGeho2HBeWQPaAYawJfPqHHvsCJ returns the balance of the Bitcoin address 32FCGFdRGeho2HBeWQPaAYawJfPqHHvsCJ.
/command/reload reload hybrixd and reinitialize modules and recipes.
/proc returns the list of processes running on the hybrixd node.
/proc/1543921378626236 returns the progress and result of process 1543921378626236.
The response will be in JSON format. For the balance request /asset/btc/balance/32FCGFdRGeho2HBeWQPaAYawJfPqHHvsCJ this will be of the form:
{"error":0,"info":"Process data.","id":"1543921378626236","progress":1,"started":1543923093402,"stopped":1543923093695,"data":"0.00000000","request":"/asset/btc/balance/32FCGFdRGeho2HBeWQPaAYawJfPqHHvsCJ"}From which we see that the balance on this address is 0.00000000.
Two-Stage Requests
For some requests, the response will consist of a process reference. This means that the response to your request is not yet finished, but you can follow up on it using the given process id.
Example
Result
/asset/btc/balance/32FCGFdRGeho2HBeWQPaAYawJfPqHHvsCJ
Result
{"error":0,"info":"Command process ID.","id":"id","request":"/asset/btc/balance/32FCGFdRGeho2HBeWQPaAYawJfPqHHvsCJ","data":"1543921378626236"}The same is true for the following request.
Example
Result
/proc/1543921378626236
Result
{"error":0,"info":"Process data.","id":"1543921378626236","progress":1,"started":1543923093402,"stopped":1543923093695,"data":"0.00000000","request":"/asset/btc/balance/32FCGFdRGeho2HBeWQPaAYawJfPqHHvsCJ"}hybrix JS library
To facilitate integration of the API into you Javascript projects we have created a library. This library will handle two stage request and all client side steps for the encyrption and signing of transactions.
Read more about the hybrix JS library »
Reference
No results. Change your search filter or reset the filter.
/assetAssets are cryptocurrencies or tokens. List all available assets.
Alias: /a
/asset
/asset/$ASSET/balanceGet the balance of an asset.
Get the balance of an asset.
Query an address to get its balance.
/asset//balance/
/asset/$ASSET/fee-balanceGet the fee balance of an asset.
Get the fee balance of an asset.
Query an address to get its fee balance.
/asset//fee-balance/
/asset/$ASSET/subbalancesGet detailed balances of an asset.
Get detailed balances of an asset.
Query an address to get its sub balance details.
/asset//subbalances/
/asset/$ASSET/transaction-detailsGet details required to prepare a transaction.
Get details required to prepare a transaction.
Specify the source address from which you wish to retrieve transaction details.
Specify the amount to retrieve transaction details for.
Specify the target address to retrieve transaction details for.
Optional: specify the public key (needed for certain cryptocurrencies, like NXT for example).
Optional: specify a message to be send with the transaction.
/asset//transaction-details/
/asset//transaction-details//
/asset//transaction-details///
/asset//transaction-details////
/asset//transaction-details/////
/asset/$ASSET/block Get data from a block.
/asset//block
/asset//block/
/asset/$ASSET/confirmGet confirmation status.
Get confirmation status.
Retrieve the confirmation status for a given a transaction ID.
/asset//confirm/
/asset/$ASSET/confirmed Get confirmation count. No input returns needed confirmations in general for the ledger.
/asset//confirmed
/asset//confirmed/
/asset/$ASSET/contract Get the contract unique identifier for a token asset.
/asset//contract
/asset/$ASSET/details Retrieve detailed information of an asset.
/asset//details
/asset/$ASSET/factor Retrieve the factor. The number of decimal digits used for this asset.
/asset//factor
/asset/$ASSET/features Retrieve available features for this asset.
/asset//features
/asset//features/
/asset/$ASSET/fee Retrieve the average transaction fee for sending an asset.
/asset//fee
/asset//fee/
/asset/$ASSET/fee-factor Retrieve the factor belonging to an asset's fee.
/asset//fee-factor
/asset/$ASSET/fee-symbol Retrieve the symbol in which the transaction fee is calculated.
/asset//fee-symbol
/asset/$ASSET/keygen-base Retrieve the base symbol used to generated the private and public keys of an asset.
/asset//keygen-base
/asset/$ASSET/mode Retrieve the mode for proper initialization of deterministic code blobs on the client-side.
/asset//mode
/asset/$ASSET/heightReturn the height of the asset ledger, denominated in its own measurable unit (e.g. blocks, parts or consensus decisions).
/asset//height
/asset/$ASSET/historyRetrieve the transaction history for an asset.
Retrieve the transaction history for an asset.
Get the history belonging to an address on the ledger.
Specify the amount of entries to return.
Specify the offset starting from the latest transaction.
/asset//history/
/asset//history//
/asset//history///
Root only.
/asset//history////
(Root only)
Specify whether to use any cached result./asset/$ASSET/infoRetrieve info about the asset.
/asset//info
/asset/$ASSET/iconRetrieve the svg icon for this asset.
/asset//icon
/asset/$ASSET/notesRetrieve any notes for this asset.
/asset//notes
/asset/$ASSET/sample Retrieve a sample address and transaction id for test purposes.
/asset//sample
/asset/$ASSET/reportRetrieve test results.
/asset//report
/asset/$ASSET/testRetrieve data used for testing.
/asset//test
/asset/$ASSET/test-hosts Tests the hosts used for this asset
Root only.
/asset//test-hosts
(Root only)
Tests the hosts used for this asset/asset/$ASSET/test-cli Tests the asset methods.
Root only.
/asset//test-cli
(Root only)
Tests the asset methods./asset/$ASSET/transactionGet transaction information.
Get transaction information.
Retrieve the details belonging to a transaction ID.
Specify a specific target address.
/asset//transaction/
/asset//transaction//
/asset/$ASSET/descriptionGet transaction description data.
Get transaction description data.
The description belonging to a transaction ID is returned.
/asset//description/
/asset/$ASSET/messageGet transaction attachment data, and decode its message.
Get transaction attachment data, and decode its message.
The message belonging to a transaction ID is decoded.
/asset//message/
/asset/$ASSET/statusGet status hash of an address. When the hash changes, a transaction has gone in or out.
Get status hash of an address. When the hash changes, a transaction has gone in or out.
Retrieve the status hash belonging to the history of an address.
/asset//status/
/asset/$ASSET/pushPush a signed transaction to a blockchain, DAG or other ledger system.
Push a signed transaction to a blockchain, DAG or other ledger system.
Signed transaction data pushed into the network will return a transaction ID.
/asset//push/
/asset/$ASSET/unified-symbols Retrieve the unified symbols that form a hybrid asset.
/asset//unified-symbols
/asset/$ASSET/unspentRetrieve the unspents for an asset. Unspent is a bitcoin related term that in hybrixd is used for pre-transactional data. Bitcoin: 'unspent' means available inputs for creating a transaction. Ethereum: 'unspent' means the most recent nonce of the cryptocurrency account needed for constructing a transaction. NXT: 'unspent' means the server reply information needed to construct a deterministic transaction.
Retrieve the unspents for an asset. Unspent is a bitcoin related term that in hybrixd is used for pre-transactional data. Bitcoin: 'unspent' means available inputs for creating a transaction. Ethereum: 'unspent' means the most recent nonce of the cryptocurrency account needed for constructing a transaction. NXT: 'unspent' means the server reply information needed to construct a deterministic transaction.
Specify the source address from which you wish to calculate unspents.
Specify the amount to calculate unspents for.
Specify the target address to calculate unspents for.
Optional: specify the public key (needed for certain cryptocurrencies, like NXT for example).
Optional: specify a message to be send with the transaction.
/asset//unspent/
/asset//unspent//
/asset//unspent///
/asset//unspent////
/asset//unspent/////
/asset/$ASSET/validate
/asset//validate/
/commandExecute a direct command to hybrixd.
Alias: /c
Root only.
Execute a direct command to hybrixd./command/eventsList all running event hooks.
/command/events
(Root only)
List all running event hooks./command/apiqueueCommands to control and check the API Queue.
Commands to control and check the API Queue.
/command/apiqueue/pausePause the API Queue
/command/apiqueue/pause
(Root only)
Pause the API Queue/command/apiqueue/resumeResume the API Queue when it is paused.
/command/apiqueue/resume
(Root only)
Resume the API Queue when it is paused./command/apiqueue/statusCheck the status of the API Queue.
/command/apiqueue/status
(Root only)
Check the status of the API Queue./command/apiqueue/test
/command/apiqueue/test/startEnable test mode using cached values as fallback.
/command/apiqueue/test/start
(Root only)
Enable test mode using cached values as fallback./command/apiqueue/test/forceEnable test mode using cached values as default.
/command/apiqueue/test/force
(Root only)
Enable test mode using cached values as default./command/apiqueue/test/stopDisable test mode using cached values.
/command/apiqueue/test/stop
(Root only)
Disable test mode using cached values./command/apiqueue/test/statusCheck the status of the test mode.
/command/apiqueue/test/status
(Root only)
Check the status of the test mode./command/cacheCommands to control and check the cache.
Commands to control and check the cache.
/command/cache/clear
(Root only)
Clear the cache./command/confCommands to control and check hybrixd configuration. Configuration Web UI.
Commands to control and check hybrixd configuration.
/command/conf
(Root only)
Configuration Web UI./command/conf/get
/command/conf/get/
(Root only)
Retrieve a configuration value/command/conf/list List all configuration details
/command/conf/list
(Root only)
List all configuration details
/command/conf/list/
(Root only)
List configuration details/command/conf/set
/command/conf/set//
(Root only)
Set configuration details/command/conf/conf.js test
/command/conf/conf.js
(Root only)
test/command/execExecute a Qrtz script.
Execute a Qrtz script.
/command/exec/
(Root only)
Specify the file containing the code to execute./command/update Update hybrixd to latest release version
/command/update
(Root only)
Update hybrixd to latest release version
/command/update/check
(Root only)
Check if update is available/command/reloadCommands to reload hybrixd or specific components Reload hybrixd.
Commands to reload hybrixd or specific components
/command/reload
(Root only)
Reload hybrixd./command/reload/confReload hybrixd configuration files.
/command/reload/conf
(Root only)
Reload hybrixd configuration files./command/reload/modulesReload hybrixd modules.
/command/reload/modules
(Root only)
Reload hybrixd modules./command/reload/recipesReload hybrixd recipes.
/command/reload/recipes
(Root only)
Reload hybrixd recipes./command/schedulerCommands to control and check the Scheduler.
Commands to control and check the Scheduler.
/command/scheduler/pausePause the Scheduler.
/command/scheduler/pause
(Root only)
Pause the Scheduler./command/scheduler/resumeResume the Scheduler when it is paused.
/command/scheduler/resume
(Root only)
Resume the Scheduler when it is paused./command/scheduler/statusCheck the status of the Scheduler.
/command/scheduler/status
(Root only)
Check the status of the Scheduler./command/endpoint List all interface endpoints.
/command/endpoint
(Root only)
List all interface endpoints.Commands to control and check the interface endpoints.
/command/endpoint/$PROTOCOL/$ENDPOINT/closeClose the endpoint.
/command/endpoint///close
(Root only)
Close the endpoint./command/endpoint/$PROTOCOL/$ENDPOINT/openResume the listening on the endpoint when it is closed.
/command/endpoint///open
(Root only)
Resume the listening on the endpoint when it is closed./command/endpoint/$PROTOCOL/$ENDPOINT/statusCheck the status of the endpoint.
/command/endpoint///status
(Root only)
Check the status of the endpoint./command/startStart hybrixd (only available through CLI).
/command/start
(Root only)
Start hybrixd (only available through CLI)./command/restartRestart hybrixd.
/command/restart
(Root only)
Restart hybrixd./command/stop Stop hybrixd.
/command/stop
(Root only)
Stop hybrixd.
/command/stop/debug
(Root only)
Stop hybrixd and debug the lingering processes/engineEngines are scriptable modules that can be built to do a variety of tasks. List available engines.
Alias: /e
/engine
/engine/allocationAccount engine for sequestration actions between node and clients.
Account engine for sequestration actions between node and clients.
Get the used security symbol
Test stub
/engine/allocation/pairManage swap pairs.
Manage swap pairs.
List all available swap pairs on offer.
/engine/allocation/pair/listList all available swap pairs on offer.
/engine/allocation/pair/list
/engine/allocation/pair/findFind allocated swap pairs on offer.
Find allocated swap pairs on offer.
Base source symbol for the pair.
Swap target symbol for the pair.
/engine/allocation/pair/find//
/engine/allocation/pair/rebalanceRebalance a swap pair, and mutate associated fees.
Rebalance a swap pair, and mutate associated fees.
Provide the account ID to check for its existance.
Target symbol to rebalance.
Amount to rebalance available funds with. For example for reserving a balance. Without this option the amount is checked on the blockchain.
Signature for the operation.
/engine/allocation/pair/rebalance//
/engine/allocation/pair/rebalance///
/engine/allocation/pair/rebalance////
/engine/allocation/pair/selectSelect an allocated swap pair according to available amount and cheapest fee.
Select an allocated swap pair according to available amount and cheapest fee.
Base source symbol for the pair.
Swap target symbol for the pair.
Amount of target asset you wish to receive.
/engine/allocation/pair/select//
/engine/allocation/pair/select///
/engine/allocation/pair/statsShow pairs allocation status information. Specifying no symbols will return all pairs.
Show pairs allocation status information.
Specifying no symbols will return all pairs.
Base source symbol for the pair.
Swap target symbol for the pair.
/engine/allocation/pair/stats
/engine/allocation/pair/stats/
/engine/allocation/pair/stats//
/engine/allocation/pair/historyShow pairs history over the last 24 hours. Specifying pairs for this is mandatory.
Show pairs history over the last 24 hours.
Specifying pairs for this is mandatory.
Base source symbol for the pair.
Swap target symbol for the pair.
/engine/allocation/pair/history
/engine/allocation/pair/history/
/engine/allocation/pair/history//
/engine/allocation/pair/getGet information about an allocation swap pair.
Get information about an allocation swap pair.
Provide the account ID to check for its existance.
Base source symbol for the pair.
Swap target symbol for the pair.
Signature for the operation.
/engine/allocation/pair/get///
/engine/allocation/pair/get////
/engine/allocation/pair/setSet information for an allocation swap pair, or create a new pair.
Set information for an allocation swap pair, or create a new pair.
Provide the account ID to check for its existance.
Base source symbol for the pair.
Swap target symbol for the pair.
Fee to ask for a swap on this pair.
Maximum amount of risked capital per swap.
Deadline in seconds for swap completion.
Signature for the operation.
/engine/allocation/pair/set////
/engine/allocation/pair/set/////
/engine/allocation/pair/set//////
/engine/allocation/pair/set///////
/engine/allocation/pair/deleteDelete an allocation swap pair.
Delete an allocation swap pair.
Provide the account ID to check for its existance.
Base source symbol for the pair.
Swap target symbol for the pair.
Signature for the operation.
/engine/allocation/pair/delete///
/engine/allocation/pair/delete////
/engine/allocation/accountManage derived keypair sequestrated accounts.
Manage derived keypair sequestrated accounts.
/engine/allocation/account/list List all accountIDs.
Root only.
/engine/allocation/account/list
(Root only)
List all accountIDs./engine/allocation/account/initInitialize a new account.
Initialize a new account.
You must specify an account ID that matches the secret key input.
Secret key to use for the newly initialized account.
/engine/allocation/account/init//
/engine/allocation/account/existsCheck if an account exists.
Check if an account exists.
Provide the account ID to check for its existance.
/engine/allocation/account/exists/
/engine/allocation/account/detailsGet the details of an account.
Get the details of an account.
Provide the account ID to get the details.
Signature for the operation.
/engine/allocation/account/details/
/engine/allocation/account/details//
/engine/allocation/account/contactGet the notifier target of an account.
Get the notifier target of an account.
Provide the account ID to get the details.
Signature for the operation.
/engine/allocation/account/contact//
/engine/allocation/account/setContactSet the notifier target of an account.
Set the notifier target of an account.
Provide the account ID to get the details.
Notifier target email address.
Signature for the operation.
/engine/allocation/account/setContact//
/engine/allocation/account/setContact///
/engine/allocation/account/addressGet the address of an account belonging to a symbol.
Get the address of an account belonging to a symbol.
Provide the account ID to get the details.
Symbol to get the address of.
Signature for the operation.
/engine/allocation/account/address//
/engine/allocation/account/address///
/engine/allocation/account/setAddressSet the address of a virtual account.
Set the address of a virtual account.
Provide the account ID to get the details.
Symbol to get the address of.
Address of virtual account.
Signature for the operation.
/engine/allocation/account/setAddress//
/engine/allocation/account/setAddress///
/engine/allocation/account/setAddress////
/engine/allocation/account/balanceGet the address balance of an account belonging to a symbol.
Get the address balance of an account belonging to a symbol.
Provide the account ID to get the details.
Symbol to get the balance of.
Signature for the operation.
/engine/allocation/account/balance//
/engine/allocation/account/balance///
/engine/allocation/account/mintMint virtual currency for legacy banking mirroring purposes.
Mint virtual currency for legacy banking mirroring purposes.
Provide the account ID to perform action for.
Symbol to mint new units for.
Amount to mint.
Signature for the operation.
/engine/allocation/account/mint///
/engine/allocation/account/mint////
/engine/allocation/account/burnBurn virtual currency for legacy banking mirroring purposes.
Burn virtual currency for legacy banking mirroring purposes.
Provide the account ID to perform action for.
Symbol to burn units of.
Amount to burn.
Signature for the operation.
/engine/allocation/account/burn//
/engine/allocation/account/burn///
/engine/allocation/account/burn////
/engine/allocation/account/securityReserve
Provide the account ID to check for its existance.
The action to take: balance, details, deposit or withdraw.
Amount to sequestrate between the allocation account and the security reserve.
Signature for the operation.
/engine/allocation/account/securityReserve//
/engine/allocation/account/securityReserve///
/engine/allocation/account/securityReserve////
/engine/allocation/security-symbolGet the used security symbol
/engine/allocation/security-symbol
/engine/allocation/testTest stub
/engine/allocation/test
/engine/assetAssets are cryptocurrencies or tokens. List all available assets.
Assets are cryptocurrencies or tokens.
List all available assets.
Get data from a block.
Retrieve block information by specifying the block number. Omitting this input will return the latest block.
Get confirmation count. No input returns needed confirmations in general for the ledger.
/engine/asset
/engine/asset/$ASSET/balanceGet the balance of an asset.
Get the balance of an asset.
Query an address to get its balance.
/engine/asset//balance/
/engine/asset/$ASSET/fee-balanceGet the fee balance of an asset.
Get the fee balance of an asset.
Query an address to get its fee balance.
/engine/asset//fee-balance/
/engine/asset/$ASSET/subbalancesGet detailed balances of an asset.
Get detailed balances of an asset.
Query an address to get its sub balance details.
/engine/asset//subbalances/
/engine/asset/$ASSET/transaction-detailsGet details required to prepare a transaction.
Get details required to prepare a transaction.
Specify the source address from which you wish to retrieve transaction details.
Specify the amount to retrieve transaction details for.
Specify the target address to retrieve transaction details for.
Optional: specify the public key (needed for certain cryptocurrencies, like NXT for example).
Optional: specify a message to be send with the transaction.
/engine/asset//transaction-details/
/engine/asset//transaction-details//
/engine/asset//transaction-details///
/engine/asset//transaction-details////
/engine/asset//transaction-details/////
/engine/asset/$ASSET/block Get data from a block.
/engine/asset//block
/engine/asset//block/
/engine/asset/$ASSET/confirmGet confirmation status.
Get confirmation status.
Retrieve the confirmation status for a given a transaction ID.
/engine/asset//confirm/
/engine/asset/$ASSET/confirmed Get confirmation count. No input returns needed confirmations in general for the ledger.
/engine/asset//confirmed
/engine/asset/