HINT: You can improve your privacy by using an encrypted connection to visit Omni Explorer. We recommend switching to a secure connection.×

API Documentation

Warning:  API requests to legacy versions of the API and to omnichest.info URLs will be unavailable from December 2016. Please ensure you are using the current OmniExplorer.info ASK API.×

The OmniExplorer API is called 'ASK' and can be used to interrogate the Omni Layer state via HTTP.

To make a request, specify the API call and any associated parameters in a request to http://omniexplorer.info/ask.asp.

If you are instead looking for the OmniCore API (RPC) documentation, it's here on GitHub.

 quick reference

The following table provides a quick reference for API calls. Click on an API call for further information and examples.

API Parameters Description
getbalance prop, address Requests the available balance for a given property ID and address
getreservedbalance prop, address Requests the reserved balance for a given property ID and address
getpropertybalances prop Requests the balances of all addresses holding tokens of a given property ID
gettx txid Requests the transaction details for a given transaction ID
gettxvalidity txid Requests the validity of a given transaction ID
gettxblock txid Requests the block number for a given transaction ID
gettxconfirmations txid Requests the number of confirmations for a given transaction ID
getblocktx block Requests the transaction details for all Omni Layer transactions in a given block
getlastblockprocessed - Requests the last block processed by OmniExplorer.info
gethistory address Requests the historical transactions for a given address
getsenderhistory address Requests the historical transactions sent from a given address
getrecipienthistory address Requests the historical transactions received by a given address
getpropertyname prop Requests the display name for a given property ID
getpropertydivisibility prop Requests the divisibility for a given property ID
getpropertytotaltokens prop Requests the total number of tokens for a given property ID
getdexlastprice - Requests the last price of the Omni token via the Basic Distributed Exchange
getdexorderbook - Requests the order book for the Omni token via the Basic Distributed Exchange
getdexvolume24hr - Requests the volume of Omni token trading within the last 24 hours via the Basic Distributed Exchange
getdexhistory24hr - Requests the trading history for Omni token trading within the last 24 hours via the Basic Distributed Exchange
getmetadexlastprice prop, desprop Requests the last price for a given trading pair via the Meta Distributed Exchange
getmetadexorderbook prop, desprop Requests the order book for a given trading pair via the Meta Distributed Exchange
getmetadexvolume24hr prop, desprop Requests the volume for a given trading pair within the last 24 hours via the Meta Distributed Exchange
getmetadexhistory24hr prop, desprop Requests the trading history for a given trading pair within the last 24 hours via the Meta Distributed Exchange
gettxcount24hr prop Requests the total number of transactions within the last 24 hours for the Omni Layer or a given property ID

 getbalance

The getbalance API call requests the available balance for a given property ID and address.

Parameters:

propnumeric, requiredthe property identifier
addresstext, requiredthe address to query

Example:   http://omniexplorer.info/ask.aspx?api=getbalance&prop=1&address=1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P

 getreservedbalance

The getreservedbalance API call requests the reserved (eg reserved by open trades) balance for a given property ID and address.

Parameters:

propnumeric, requiredthe property identifier
addresstext, requiredthe address to query

Example:   http://omniexplorer.info/ask.aspx?api=getreservedbalance&prop=1&address=1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P

 getpropertybalances

The getpropertybalances API call requests the balances of all addresses holding tokens of a given property ID.

Parameters:

propnumeric, requiredthe property identifier

Example:   http://omniexplorer.info/ask.aspx?api=getpropertybalances&prop=1

 gettx

The gettx API call requests the transaction details for a given transaction ID.

Parameters:

txidtext, requiredthe transaction hash

Example:   http://omniexplorer.info/ask.aspx?api=gettx&txid=5fa342f704ca6a9ae84134de8f2d987c18980de70a744d1aa8472e847555fcbd

 gettxvalidity

The gettxvalidity API call requests the validity for a given transaction ID.

Parameters:

txidtext, requiredthe transaction hash

Example:   http://omniexplorer.info/ask.aspx?api=gettxvalidity&txid=5fa342f704ca6a9ae84134de8f2d987c18980de70a744d1aa8472e847555fcbd

 gettxblock

The gettxblock API call requests the block number for a given transaction ID.

Parameters:

txidtext, requiredthe transaction hash

Example:   http://omniexplorer.info/ask.aspx?api=gettxblock&txid=5fa342f704ca6a9ae84134de8f2d987c18980de70a744d1aa8472e847555fcbd

 gettxconfirmations

The gettxconfirmations API call requests the number of confirmations for a given transaction ID.

Parameters:

txidtext, requiredthe transaction hash

Example:   http://omniexplorer.info/ask.aspx?api=gettxconfirmations&txid=5fa342f704ca6a9ae84134de8f2d987c18980de70a744d1aa8472e847555fcbd

 getblocktx

The getblocktx API call requests the transaction details for all Omni Layer transactions in a given block.

Parameters:

blocknumber, requiredthe block nummber

Example:   http://omniexplorer.info/ask.aspx?api=getblocktx&block=420000

 getlastblockprocessed

The getlastblockprocessed API call requests the last block processed by OmniExplorer.info.

There are no paramters for this call.

Example:   http://omniexplorer.info/ask.aspx?api=getlastblockprocessed

 gethistory

The gethistory API call requests the historical transactions for a given address.

Please note this call is currently limited to the 50 most recent transactions.

Parameters:

addresstext, requiredthe address

Example:   http://omniexplorer.info/ask.aspx?api=gethistory&address=1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P

 getsenderhistory

The getsenderhistory API call requests the historical transactions sent from a given address.

Please note this call is currently limited to the 50 most recent transactions.

Parameters:

addresstext, requiredthe address

Example:   http://omniexplorer.info/ask.aspx?api=getsenderhistory&address=1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P

 getrecipienthistory

The getrecipienthistory API call requests the historical transactions received by a given address.

Please note this call is currently limited to the 50 most recent transactions.

Parameters:

addresstext, requiredthe address

Example:   http://omniexplorer.info/ask.aspx?api=getrecipienthistory&address=1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P

 getpropertyname

The getpropertyname API call requests the display name for a given property ID.

Parameters:

propnumeric, requiredthe property identifier

Example:   http://omniexplorer.info/ask.aspx?api=getpropertyname&prop=1

 getpropertydivisibility

The getpropertydivisibility API call requests the divisibility for a given property ID.

Parameters:

propnumeric, requiredthe property identifier

Example:   http://omniexplorer.info/ask.aspx?api=getpropertydivisibility&prop=1

 getpropertytotaltokens

The getpropertytotaltokens API call requests the total number of tokens for a given property ID.

Parameters:

propnumeric, requiredthe property identifier

Example:   http://omniexplorer.info/ask.aspx?api=getpropertytotaltokens&prop=1

 getdexlastprice

The getdexlastprice API call requests the last price of the Omni token via the Basic Distributed Exchange.

There are no paramters for this call.

Example:   http://omniexplorer.info/ask.aspx?api=getdexlastprice

 getdexorderbook

The getdexorderbook API call requests the order book for the Omni token via the Basic Distributed Exchange.

There are no paramters for this call.

Example:   http://omniexplorer.info/ask.aspx?api=getdexorderbook

 getdexvolume24hr

The getdexvolume24hr API call requests the volume of Omni token trading within the last 24 hours via the Basic Distributed Exchange.

There are no paramters for this call.

Example:   http://omniexplorer.info/ask.aspx?api=getdexvolume24hr

 getdexhistory24hr

The getdexhistory24hr API call requests the trading history for Omni token trading within the last 24 hours via the Basic Distributed Exchange.

There are no paramters for this call.

Example:   http://omniexplorer.info/ask.aspx?api=getdexhistory24hr

 getmetadexlastprice

The getmetadexlastprice API call requests the last price for a given trading pair via the Meta Distributed Exchange.

Parameters:

propnumeric, requiredthe property identifier for sale
despropnumeric, requiredthe property identifier desired

Example:   http://omniexplorer.info/ask.aspx?api=getmetadexlastprice&prop=1&desprop=31

 getmetadexorderbook

The getmetadexorderbook API call requests the order book for a given trading pair via the Meta Distributed Exchange.

Parameters:

propnumeric, requiredthe property identifier for sale
despropnumeric, requiredthe property identifier desired

Example:   http://omniexplorer.info/ask.aspx?api=getmetadexorderbook&prop=1&desprop=31

 getmetadexvolume24hr

The getmetadexvolume24hr API call requests the volume for a given trading pair within the last 24 hours via the Meta Distributed Exchange.

Parameters:

propnumeric, requiredthe property identifier for sale
despropnumeric, requiredthe property identifier desired

Example:   http://omniexplorer.info/ask.aspx?api=getmetadexvolume24hr&prop=1&desprop=31

 getmetadexhistory24hr

The getmetadexhistory24hr API call requests the trading history for a given trading pair within the last 24 hours via the Meta Distributed Exchange.

Parameters:

propnumeric, requiredthe property identifier for sale
despropnumeric, requiredthe property identifier desired

Example:   http://omniexplorer.info/ask.aspx?api=getmetadexhistory24hr&prop=1&desprop=31

 gettxcount24hr

The gettxcount24hr API call requests the total number of transactions within the last 24 hours for the Omni Layer or a given property ID.

Parameters:

propnumeric, optionalthe property identifier

Example:   http://omniexplorer.info/ask.aspx?api=gettxcount24hr&prop=1