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/allocationpricingValuation engine for determining pair prices based on allocation balances.
Valuation engine for determining pair prices based on allocation balances.
/engine/allocationpricing/ratesList all current price rates. Retrieve exchange-rates.
List all current price rates.
Retrieve exchange-rates.
/engine/allocationpricing/rates
/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.
Retrieve the confirmation count for a given a transaction ID.
Get the contract unique identifier for a token asset.
Retrieve detailed information of an asset.
Retrieve the factor. The number of decimal digits used for this asset.
Retrieve available features for this asset.
Check whether feature is enables for this asset.
Retrieve the average transaction fee for sending an asset.
You may specify the amount of data bytes you intend to attach to the transaction. This may adjust the fee.
Retrieve the factor belonging to an asset's fee.
Retrieve the symbol in which the transaction fee is calculated.
Retrieve the base symbol used to generated the private and public keys of an asset.
Retrieve the mode for proper initialization of deterministic code blobs on the client-side.
Return the height of the asset ledger, denominated in its own measurable unit (e.g. blocks, parts or consensus decisions).
Retrieve info about the asset.
Retrieve the svg icon for this asset.
Retrieve any notes for this asset.
Retrieve a sample address and transaction id for test purposes.
Retrieve test results.
Retrieve data used for testing.
Retrieve the unified symbols that form a hybrid asset.
Validate an address for this symbol.
/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//confirmed/
/engine/asset/$ASSET/contract Get the contract unique identifier for a token asset.
/engine/asset//contract
/engine/asset/$ASSET/details Retrieve detailed information of an asset.
/engine/asset//details
/engine/asset/$ASSET/factor Retrieve the factor. The number of decimal digits used for this asset.
/engine/asset//factor
/engine/asset/$ASSET/features Retrieve available features for this asset.
/engine/asset//features
/engine/asset//features/
/engine/asset/$ASSET/fee Retrieve the average transaction fee for sending an asset.
/engine/asset//fee
/engine/asset//fee/
/engine/asset/$ASSET/fee-factor Retrieve the factor belonging to an asset's fee.
/engine/asset//fee-factor
/engine/asset/$ASSET/fee-symbol Retrieve the symbol in which the transaction fee is calculated.
/engine/asset//fee-symbol
/engine/asset/$ASSET/keygen-base Retrieve the base symbol used to generated the private and public keys of an asset.
/engine/asset//keygen-base
/engine/asset/$ASSET/mode Retrieve the mode for proper initialization of deterministic code blobs on the client-side.
/engine/asset//mode
/engine/asset/$ASSET/heightReturn the height of the asset ledger, denominated in its own measurable unit (e.g. blocks, parts or consensus decisions).
/engine/asset//height
/engine/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.
/engine/asset//history/
/engine/asset//history//
/engine/asset//history///
Root only.
/engine/asset//history////
(Root only)
Specify whether to use any cached result./engine/asset/$ASSET/infoRetrieve info about the asset.
/engine/asset//info
/engine/asset/$ASSET/iconRetrieve the svg icon for this asset.
/engine/asset//icon
/engine/asset/$ASSET/notesRetrieve any notes for this asset.
/engine/asset//notes
/engine/asset/$ASSET/sample Retrieve a sample address and transaction id for test purposes.
/engine/asset//sample
/engine/asset/$ASSET/reportRetrieve test results.
/engine/asset//report
/engine/asset/$ASSET/testRetrieve data used for testing.
/engine/asset//test
/engine/asset/$ASSET/test-hosts Tests the hosts used for this asset
Root only.
/engine/asset//test-hosts
(Root only)
Tests the hosts used for this asset/engine/asset/$ASSET/test-cli Tests the asset methods.
Root only.
/engine/asset//test-cli
(Root only)
Tests the asset methods./engine/asset/$ASSET/transactionGet transaction information.
Get transaction information.
Retrieve the details belonging to a transaction ID.
Specify a specific target address.
/engine/asset//transaction/
/engine/asset//transaction//
/engine/asset/$ASSET/descriptionGet transaction description data.
Get transaction description data.
The description belonging to a transaction ID is returned.
/engine/asset//description/
/engine/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.
/engine/asset//message/
/engine/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.
/engine/asset//status/
/engine/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.
/engine/asset//push/
/engine/asset/$ASSET/unified-symbols Retrieve the unified symbols that form a hybrid asset.
/engine/asset//unified-symbols
/engine/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.
/engine/asset//unspent/
/engine/asset//unspent//
/engine/asset//unspent///
/engine/asset//unspent////
/engine/asset//unspent/////
/engine/asset/$ASSET/validate
/engine/asset//validate/
/engine/bankingBanking engine for handling banking calls to/from gateways.
Banking engine for handling banking calls to/from gateways.
List all methods with their options and currencies.
/engine/banking/methodsList all methods with their options and currencies.
/engine/banking/methods
/engine/banking/depositDeposit via gateway.
Deposit via gateway.
Specify the gateway type to use for trading.
Specify the desired symbol to transact units in.
Specify the amount of symbol to trade.
The target address at which to receive the incoming amount.
target
/engine/banking/deposit////
/engine/banking/withdrawWithdraw via gateway.
Withdraw via gateway.
Specify the gateway type to use for trading.
Specify the desired symbol to transact units in.
Specify the amount of symbol to trade.
The target address at which to send the outgoing amount. (Caret '^' separated fields necessary, underscores instead of spaces.)
target
/engine/banking/withdraw////
/engine/banking/transferTransfer via gateway.
Transfer via gateway.
Specify the gateway type to use for trading.
Specify the desired symbol to transact units in.
Specify the amount of symbol to trade.
The target address at which to send the outgoing amount. (Caret '^' separated fields necessary, underscores instead of spaces.)
target
/engine/banking/transfer////
/engine/dealDeal engine for deals between node and clients.
Deal engine for deals between node and clients.
List swappable pairs.
TEST
List the supported digital ledgers for swap deals.
List the supported virtual ledgers for swap deals.
/engine/deal/swap Swap Web UI.
Root only.
/engine/deal/swap
(Root only)
Swap Web UI./engine/deal/pairsList swappable pairs.
/engine/deal/pairs
/engine/deal/estimateEstimate a deal.
Estimate a deal.
Specify the base symbol to offer in trade.
Specify the desired symbol to receive units in.
symbol
/engine/deal/estimate//
Specify the amount of base symbol to trade.
amount
/engine/deal/estimate///
/engine/deal/proposalPropose a deal to trade on.
Propose a deal to trade on.
Specify the base symbol to offer in trade.
Specify the desired symbol to receive units in.
Specify the amount of base symbol to trade.
The target address at which to receive the incoming amount.
target
/engine/deal/proposal////
/engine/deal/remitRemit a payment transaction to a proposal ID.
Remit a payment transaction to a proposal ID.
Specify the proposal ID to call the claim for.
The raw transaction to remit payment.
/engine/deal/remit//
/engine/deal/claimClaim payment proof for proposal ID. Necessary for a swap to complete, and adds security to the swap.
Root only.
Claim payment proof for proposal ID. Necessary for a swap to complete, and adds security to the swap.Specify the proposal ID to call the claim for.
/engine/deal/claim//
(Root only)
The transaction ID which shall contain the proof./engine/deal/statusCheck the status of a proposal or deal.
Check the status of a proposal or deal.
Specify the proposal or deal ID to check the status of.
/engine/deal/status/
/engine/deal/findFind deals containing string.
Root only.
Find deals containing string.
/engine/deal/find/
(Root only)
Specify the string to search for./engine/deal/listReturn deal ID list.
Return deal ID list.
Specify 'complete' or 'pending'.
Specify the amount of deal IDs to return.
The offset to start from the list.
/engine/deal/list///
/engine/deal/disputeDispute a deal.
Dispute a deal.
Specify the deal ID to dispute.
/engine/deal/dispute/
/engine/deal/settleForce settle a deal.
Root only.
Force settle a deal.
/engine/deal/settle/
(Root only)
Specify the deal ID to force settlement of./engine/deal/testTEST
/engine/deal/test
/engine/deal/ledgersList the supported digital ledgers for swap deals.
/engine/deal/ledgers
/engine/deal/bankingList the supported virtual ledgers for swap deals.
/engine/deal/banking
/engine/evm-interpreterAn Ethereum Virtual Machine (EVM) interpreter and decompiler, along with several other utilities for programmatically extracting information from bytecode.
An Ethereum Virtual Machine (EVM) interpreter and decompiler, along with several other utilities for programmatically extracting information from bytecode.
Interpret opcodes by looping over them, returns array of interpreted opcodes.
Decompile bytecode into readable Solidity-like pseudocode.
Decode raw transaction.
/engine/evm-interpreter/getExtract information from bytecode.
Extract information from bytecode.
Returns opcodes including pc and pushData (if included).
Parse functions from their signatures in bytecode.
Parse events from their signatures in bytecode.
Get array of program counters from JUMPDEST (jump destination) opcodes.
Get the swarm hash (if any) for contract metadata.
Calculate the gas in units a bytecode contract will cost to execute.
Calculate the gas in units a bytecode contract will cost to execute.
/engine/evm-interpreter/get/opcodes
/engine/evm-interpreter/get/opcodes/
/engine/evm-interpreter/get/functions
/engine/evm-interpreter/get/functions/
/engine/evm-interpreter/get/events
/engine/evm-interpreter/get/events/
/engine/evm-interpreter/get/destinations
/engine/evm-interpreter/get/destinations/
/engine/evm-interpreter/get/swarmhash
/engine/evm-interpreter/get/swarmhash/
/engine/evm-interpreter/get/gas
/engine/evm-interpreter/get/gas/
/engine/evm-interpreter/get/gastable Calculate the gas in units a bytecode contract will cost to execute.
/engine/evm-interpreter/get/gastable
/engine/evm-interpreter/parse
/engine/evm-interpreter/parse/
/engine/evm-interpreter/decompile
/engine/evm-interpreter/decompile/
/engine/evm-interpreter/decode
/engine/evm-interpreter/decode/
/engine/hystat
/engine/hystat/detailsReturn all numbers.
/engine/hystat/details
/engine/hystat/maximumSupplyGet the maximum supply of HY.
/engine/hystat/maximumSupply
/engine/hystat/reservedSupplyGet the reserved supply of HY.
/engine/hystat/reservedSupply
/engine/hystat/circulatingSupplyGet the circulating supply of HY.
/engine/hystat/circulatingSupply
/engine/hystat/circulatingSupplyAtomGet the atomic circulating supply of HY.
/engine/hystat/circulatingSupplyAtom
/engine/hystat/circulatingSupplyWithoutReserveGet the circulating supply of HY without reserve.
/engine/hystat/circulatingSupplyWithoutReserve
/engine/hystat/circulatingSupplyWithoutReserveAtomGet the circulating supply of HY without reserve.
/engine/hystat/circulatingSupplyWithoutReserveAtom
/engine/hystat/supplyFactorGet the factor (nr of decimals).
/engine/hystat/supplyFactor
/engine/hystat/currentPriceGet the current price of HY in USD.
/engine/hystat/currentPrice
/engine/hystat/currentVolumeGet the current exchange volume for HY.
/engine/hystat/currentVolume
/engine/hystat/ethTokenListProvide a curated hybrix tokenlist for Uniswap.
/engine/hystat/ethTokenList
/engine/hystat/maybeUpdateEthListProvide a curated hybrix tokenlist for Uniswap.
/engine/hystat/maybeUpdateEthList
/engine/portfolio
/engine/portfolio/balances
/engine/portfolio/balances/
/engine/portfolio/balancesLive
/engine/portfolio/balancesLive/
/engine/portfolio/details
/engine/portfolio/details/
/engine/portfolio/valuations
Return all valuations of a list of comma separated symbols.
Target currency to base valuation.
/engine/portfolio/valuations//
/engine/redirect(experimental!) Redirect engine to query hybrix and redirect based on result.
(experimental!) Redirect engine to query hybrix and redirect based on result.
/engine/redirect/httpRedirect to an http(s) page.
Redirect to an http(s) page.
On success or failure redirect to a URI target specified in a JSON object.
Specify a path to query for its result.
/engine/redirect/http//
/engine/storageControl the decentralized storage engine.
Control the decentralized storage engine.
/engine/storage/seekCheck if a storage key exists.
Check if a storage key exists.
Specify the ID key to check if it exists.
/engine/storage/seek/
/engine/storage/loadLoad data from storage.
Load data from storage.
Specify the ID key to get storage from.
/engine/storage/load/
/engine/storage/saveSave data to storage.
Save data to storage.
Specify the ID key to save storage to.
/engine/storage/save/
/engine/storage/burnDelete data from storage.
Root only.
Delete data from storage.
/engine/storage/burn/
(Root only)
Specify the ID key to delete the storage object./engine/storage/metaGet metadata about a storage object.
Get metadata about a storage object.
Specify the ID key to get metadata for.
/engine/storage/meta/
/engine/storage/listList keys by identifiable string.
List keys by identifiable string.
Specify part or all of the ID key to include on the list. Wildcards (*,?) are allowed.
/engine/storage/list/
/engine/synchronizeControl the storage synchronization engine.
Control the storage synchronization engine.
Shows list of synchronization node peers. (Optionally share own endpoint.)
/engine/synchronize/queueAdd storage key to local synchronization queue.
Add storage key to local synchronization queue.
Specify the storage key to add to the synchronization queue.
/engine/synchronize/queue/
/engine/synchronize/pullRetrieve the local synchronization queue. The list contains a randomized key list of recently created or updated storage items marked for synchronization.
Retrieve the local synchronization queue.
The list contains a randomized key list of recently created or updated storage items marked for synchronization.
/engine/synchronize/pull
/engine/synchronize/peers Shows list of synchronization node peers. (Optionally share own endpoint.)
/engine/synchronize/peers
/engine/synchronize/listReturn a list of unsynchronized items from remote peer host.
Root only.
Return a list of unsynchronized items from remote peer host.
/engine/synchronize/list/
(Root only)
Specify the protocol and peer host to source a list from. Example format: https/host.net/engine/synchronize/select Select a random peer host for synchronization.
Root only.
/engine/synchronize/select
(Root only)
Select a random peer host for synchronization./engine/synchronize/autosync Automatically synchronize with a randomly chosen peer host.
Root only.
/engine/synchronize/autosync
(Root only)
Automatically synchronize with a randomly chosen peer host./engine/synchronize/syncSynchronize with a specific peer host.
Root only.
Synchronize with a specific peer host.
/engine/synchronize/sync/
(Root only)
Specify the hostname of the peer to synchronize with./engine/synchronize/testTest stub. Testing and development.
Test stub.
Testing and development.
/engine/synchronize/test
/engine/unified-asset
/engine/unified-asset/compress
/engine/unified-asset/compress//
/engine/unified-asset/decompress
/engine/unified-asset/decompress//
/engine/update
Root only.
/engine/update/checkCheck if update available
/engine/update/check
(Root only)
Check if update available/engine/update/get-latest-version Get latest hybrixd version
/engine/update/get-latest-version
(Root only)
Get latest hybrixd version/engine/update/get-latest-version/hybrixdGet latest hybrixd version
/engine/update/get-latest-version/hybrixd
(Root only)
Get latest hybrixd version/engine/update/get-latest-version/cli-walletGet latest hybrixd version
/engine/update/get-latest-version/cli-wallet
(Root only)
Get latest hybrixd version/engine/update/get-latest-version/tui-walletGet latest hybrixd version
/engine/update/get-latest-version/tui-wallet
(Root only)
Get latest hybrixd version/engine/update/get-latest-version/hybrix-jslibGet latest hybrixd version
/engine/update/get-latest-version/hybrix-jslib
(Root only)
Get latest hybrixd version/help Display help as html.
Alias: /h
/help
/listProduce standard property lists of assets, sources or engines.
Alias: /l
/list/asset/iconsRetrieve a list of all basic asset icons.
/list/asset/icons
/list/asset/namesRetrieve a list of all basic asset names.
/list/asset/names
/list/asset/modesRetrieve a list of all basic asset modes.
/list/asset/modes
/list/asset/detailsRetrieve a list of all basic asset details [{symbol,name,mode}].
/list/asset/details
/meta Provides the api routing tree data
Alias: /m
/meta
/proc List all processes.
Alias: /p
/proc
/proc/$PROC Specify a process ID to see its details.
/proc/
/proc/killKill a process and all child processes.
Root only.
Kill a process and all child processes.
/proc/kill/
(Root only)
Specify the process ID to kill./proc/debug Debug Web UI.
Root only.
/proc/debug
(Root only)
Debug Web UI./proc/debug/$PROC Specify the process ID to debug.
/proc/debug/
(Root only)
Specify the process ID to debug./proc/debug/debug.js test
/proc/debug/debug.js
(Root only)
test/proc/code Code Web UI.
Root only.
/proc/code
(Root only)
Code Web UI./proc/code/$ID asset, engine or source
/proc/code/
(Root only)
asset, engine or source
/proc/code//
(Root only)
Retrieve qrtz code for given recipe.
/proc/code///
(Root only)
Retrieve qrtz code for given recipe method./proc/code/code.js test
/proc/code/code.js
(Root only)
test/proc/exec Execute a qrtz statement.
Root only.
/proc/exec
(Root only)
Execute a qrtz statement./proc/pause List all paused processes.
/proc/pause
Root only.
/proc/pause/
(Root only)
Specify the process ID to pause. All its child processes are also paused./proc/resumeResume a paused process and all child processes.
Resume a paused process and all child processes.
Root only.
/proc/resume/
(Root only)
Specify the process ID to resume./proc/peekDisplay the internal data of a process.
Root only.
Display the internal data of a process.
/proc/peek/
(Root only)
Specify the process ID to get its internal data./proc/queue Display queued processes.
Root only.
/proc/queue
/proc/queue/
/proc/busy Display busy processes.
Root only.
/proc/busy
/proc/finished Display finished processes.
Root only.
/proc/finished
/report Report utility UI
Alias: /r
/report
/report/cron Update the weekly public statistics.
Root only.
/report/cron
(Root only)
Update the weekly public statistics./report/report.js test
/report/report.js
/report/report.css test
/report/report.css
/report/assets View the asset test report. Requires test data to be available. Run /report/assets/test to gather data or ensure enable_daily_asset_report is set to true.
/report/assets
/report/assets/cron Run tests and return json report
Root only.
/report/assets/cron
(Root only)
Run tests and return json report /report/assets/test Run tests and return xml report
Root only.
/report/assets/test
(Root only)
Run tests and return xml report /report/assets/cli Return test results in cli format.
Root only.
/report/assets/cli
(Root only)
Return test results in cli format./report/assets/html Return test results in HTML format.
/report/assets/html
/report/assets/xmlReturn test results in xml format.
/report/assets/xml
/report/assets/json Return test results in json format.
/report/assets/json
/report/asset
/report/asset/
/report/asset/$SYMBOL/jsonReturn test results for $SYMBOL for json.
/report/asset//json
/report/asset/$SYMBOL/cli Run and return test results for $SYMBOL.
Root only.
/report/asset//cli
(Root only)
Run and return test results for $SYMBOL./report/log Return log entries for the last hour.
Root only.
/report/log
(Root only)
Return log entries for the last hour.
/report/log/
(Root only)
Return log entries for given categories for last hour. Use * wildcard for all categories.
/report/log//
(Root only)
Return log entries for given categories from $START till now.
/report/log///
(Root only)
Return log entries for given categories from $START till $END.
/report/log////
(Root only)
Return log entries for given categories from $START till $END with message containing $SEARCH./report/sessions View report HTML.
/report/sessions
/report/sessions/$START Return session timestamps from $START till now.
Root only.
/report/sessions/
(Root only)
Return session timestamps from $START till now.
/report/sessions//
(Root only)
Return session timestamps from $START till $END./report/sessions/jsonReturn session statistics for the last week.
/report/sessions/json
/report/api View report HTML.
/report/api
/report/api/$START Return api call timestamps from $START till now.
Root only.
/report/api/
(Root only)
Return api call timestamps from $START till now.
/report/api//
(Root only)
Return api call timestamps $START till $END.
/report/api///
(Root only)
Return api call timestamps containing $SEARCH./report/api/assets View report HTML.
/report/api/assets
/report/api/assets/$START Return asset api call timestamps and symbols from $START till now.
Root only.
/report/api/assets/
(Root only)
Return asset api call timestamps and symbols from $START till now.
/report/api/assets//
(Root only)
Return asset api call timestamps and symbols $START till $END.
/report/api/assets///
(Root only)
Return asset api call timestamps and symbols containing $SEARCH./report/api/assets/jsonReturn asset api statistics for the last week.
/report/api/assets/json
/report/api/jsonReturn api call statistics for the last week.
/report/api/json
/sourceSources are read-only information providers. List available sources.
Alias: /s
/source
/source/deterministic
/source/deterministic/assetsList available assets.
/source/deterministic/assets
/source/deterministic/code
/source/deterministic/code/
$MODE ./source/deterministic/hash
/source/deterministic/hash/
$MODE ./source/deterministic/reload Reload all deterministic blobs
Root only.
/source/deterministic/reload
(Root only)
Reload all deterministic blobs
/source/deterministic/reload/
(Root only)
Reload the deterministic blob (client side code) for $MODE ./source/deterministic/hashesReturns the DJB2 hash of all deterministic blobs (client side code).
/source/deterministic/hashes
/source/deterministic/modesList available modes.
/source/deterministic/modes
/source/recipe-editor Provides the necessary bindings to host the recipe editor.
/source/recipe-editor
/source/recipe-editor/submit Pass form data
/source/recipe-editor/submit
/source/resources
/source/resources/powered-by-hybrix.svgThe powered by hybrix logo.
/source/resources/powered-by-hybrix.svg
/source/resources/hybrix-lib.web.jsThe hybrix javascript library for web applications
/source/resources/hybrix-lib.web.js
/source/resources/hybrix-lib.node.jsThe hybrix javascript library for NodeJS applications
/source/resources/hybrix-lib.node.js
/source/ui Provides the necessary bindings to host the operator user interface.
/source/ui
/source/valuationsValuation source returning calculated price conversion rates.
Valuation source returning calculated price conversion rates.
Cron activation.
List available symbols.
/source/valuations/cronCron activation.
/source/valuations/cron
/source/valuations/listList available symbols.
/source/valuations/list
/source/valuations/rateCalculate a valuation using a multi-currency rate table.
Calculate a valuation using a multi-currency rate table.
Retrieve the median exchange-rate for one coin in another coin.
Retrieve the median exchange-rate.
Retrieve the lowest exchange-rate.
Retrieve the highest exchange-rate.
Retrieve the median exchange-rate.
Retrieve the average exchange-rate.
Retrieve the optimized exchange-rate data as long as it is close to median.
Retrieve the range comprised of the lowest and highest exchange-rate.
Retrieve extended exchange-rate data.
/source/valuations/rate//
/source/valuations/rate///
/source/valuations/rate/$SOURCE_SYMBOL/$TARGET_SYMBOL/$AMOUNT/minRetrieve the lowest exchange-rate.
/source/valuations/rate////min
/source/valuations/rate/$SOURCE_SYMBOL/$TARGET_SYMBOL/$AMOUNT/maxRetrieve the highest exchange-rate.
/source/valuations/rate////max
/source/valuations/rate/$SOURCE_SYMBOL/$TARGET_SYMBOL/$AMOUNT/medianRetrieve the median exchange-rate.
/source/valuations/rate////median
/source/valuations/rate/$SOURCE_SYMBOL/$TARGET_SYMBOL/$AMOUNT/averageRetrieve the average exchange-rate.
/source/valuations/rate////average
/source/valuations/rate/$SOURCE_SYMBOL/$TARGET_SYMBOL/$AMOUNT/optimizedRetrieve the optimized exchange-rate data as long as it is close to median.
/source/valuations/rate////optimized
/source/valuations/rate/$SOURCE_SYMBOL/$TARGET_SYMBOL/$AMOUNT/rangeRetrieve the range comprised of the lowest and highest exchange-rate.
/source/valuations/rate////range
/source/valuations/rate/$SOURCE_SYMBOL/$TARGET_SYMBOL/$AMOUNT/metaRetrieve extended exchange-rate data.
/source/valuations/rate////meta
/source/web-blockexplorer Provides the necessary bindings to host the web block explorer interface.
/source/web-blockexplorer
/source/web-wallet Provides the necessary bindings to host the web wallet interface.
/source/web-wallet
/source/web-wallet/version Get web-wallet version.
/source/web-wallet/version
/versionDisplay version information. Get version.
Alias: /v
/version
/version/details
/xauthCreate an authenticated session channel for a encrypted communications.
Alias: /x
The 64 char session hex key is given as as a public key.
Step 0 consists of requesting
/xauth/$SESSION_HEXKEY/0 Step 0 consists of requesting `$NONCE1` . Note that resending the request will erase the session.
/xauth//0
$NONCE1 . Note that resending the request will erase the session./xauth/$SESSION_HEXKEY/1Step 1 consists of sending the signed `$NONCE1` , if this is verified the session public key is given.
Step 1 consists of sending the signed
Make sure to include the hexadecimal signature.
$NONCE1 , if this is verified the session public key is given.
/xauth//1/
/ychanSend an encrypted request through the session channel and recieve an encrypted response.
Alias: /y
The 64 char session hex key is given as a public key.
Pass $ENCRYPTED_PATH_AND_DATA to request body encrypted using the
/ychan//
$SESSION_PUBLIC_KEY is executed as an API command and the result is encrypted and returned.
/ychan///
$ENCRYPTED_PATH , for example: /asset/btc/details encrypted using the $SESSION_PUBLIC_KEY is executed as an API command and the result is encrypted and returned./zchanSend an encrypted request through the session channel and recieve an encrypted and compressed response.
Alias: /z
The 64 char session hex key is given as a public key.
Pass $ENCRYPTED_PATH_AND_DATA to request body encrypted using the
/zchan//
$SESSION_PUBLIC_KEY is executed as an API command and the result is encrypted and compressed using lmza and returned.
/zchan///
$ENCRYPTED_PATH , for example: /asset/btc/details encrypted using the $SESSION_PUBLIC_KEY is executed as an API command and the result is encrypted and compressed using lmza and returned.