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.
/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.
/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
Alias: /a
/asset
/asset//balance/
/asset//fee-balance/
/asset//subbalances/
/asset//transaction-details/
/asset//transaction-details//
/asset//transaction-details///
/asset//transaction-details////
/asset//transaction-details/////
/asset//block
/asset//block/
/asset//confirm/
/asset//confirmed
/asset//confirmed/
/asset//contract
/asset//details
/asset//factor
/asset//features
/asset//features/
/asset//fee
/asset//fee/
/asset//fee-factor
/asset//fee-symbol
/asset//keygen-base
/asset//mode
/asset//height
/asset//history/
/asset//history//
/asset//history///
Root only.
/asset//history////
/asset//info
/asset//icon
/asset//notes
/asset//sample
/asset//report
/asset//test
Root only.
/asset//test-hosts
Root only.
/asset//test-cli
/asset//transaction/
/asset//transaction//
/asset//description/
/asset//message/
/asset//status/
/asset//push/
/asset//unified-symbols
/asset//unspent/
/asset//unspent//
/asset//unspent///
/asset//unspent////
/asset//unspent/////
/asset//validate/
Alias: /c
Root only.
Execute a direct command to hybrixd.
/command/events
/command/apiqueue/pause
/command/apiqueue/resume
/command/apiqueue/status
/command/apiqueue/test/start
/command/apiqueue/test/force
/command/apiqueue/test/stop
/command/apiqueue/test/status
/command/cache/clear
/command/conf
/command/conf/get/
/command/conf/list
/command/conf/list/
/command/conf/set//
/command/conf/conf.js
/command/exec/
/command/update
/command/update/check
/command/reload
/command/reload/conf
/command/reload/modules
/command/reload/recipes
/command/scheduler/pause
/command/scheduler/resume
/command/scheduler/status
/command/endpoint
/command/endpoint///close
/command/endpoint///open
/command/endpoint///status
/command/start
/command/restart
/command/stop
/command/stop/debug
Alias: /e
/engine
/engine/allocation/pair/list
/engine/allocation/pair/find//
/engine/allocation/pair/rebalance//
/engine/allocation/pair/rebalance///
/engine/allocation/pair/rebalance////
/engine/allocation/pair/select//
/engine/allocation/pair/select///
/engine/allocation/pair/stats
/engine/allocation/pair/stats/
/engine/allocation/pair/stats//
/engine/allocation/pair/history
/engine/allocation/pair/history/
/engine/allocation/pair/history//
/engine/allocation/pair/get///
/engine/allocation/pair/get////
/engine/allocation/pair/set////
/engine/allocation/pair/set/////
/engine/allocation/pair/set//////
/engine/allocation/pair/set///////
/engine/allocation/pair/delete///
/engine/allocation/pair/delete////
Root only.
/engine/allocation/account/list
/engine/allocation/account/init//
/engine/allocation/account/exists/
/engine/allocation/account/details/
/engine/allocation/account/details//
/engine/allocation/account/contact//
/engine/allocation/account/setContact//
/engine/allocation/account/setContact///
/engine/allocation/account/address//
/engine/allocation/account/address///
/engine/allocation/account/setAddress//
/engine/allocation/account/setAddress///
/engine/allocation/account/setAddress////
/engine/allocation/account/balance//
/engine/allocation/account/balance///
/engine/allocation/account/mint///
/engine/allocation/account/mint////
/engine/allocation/account/burn//
/engine/allocation/account/burn///
/engine/allocation/account/burn////
/engine/allocation/account/securityReserve//
/engine/allocation/account/securityReserve///
/engine/allocation/account/securityReserve////
/engine/allocation/security-symbol
/engine/allocation/test
/engine/asset
/engine/asset//balance/
/engine/asset//fee-balance/
/engine/asset//subbalances/
/engine/asset//transaction-details/
/engine/asset//transaction-details//
/engine/asset//transaction-details///
/engine/asset//transaction-details////
/engine/asset//transaction-details/////
/engine/asset//block
/engine/asset//block/
/engine/asset//confirm/
/engine/asset//confirmed
/engine/asset/