API Docs

About the API

The API documented below is made available by btc-rpc-explorer. The actions are organized by category. From this documentation you can directly click on an action's link to see the output format in your browser.

blocks

/api/block/:hash

json

Returns the details of a block by hash.

/api/block/:height

json

Returns the details of a block by height.

/api/blocks/tip/height

integer

Returns the height of the chain tip.

/api/blocks/tip/hash

string

Returns the block hash of the chain tip.

transactions

/api/tx/:txid

json

Returns the details of a transaction.

blockchain

/api/blockchain/coins

number

Returns the current supply of Qogecoin. An estimate using a checkpoint can be returned in 2 cases: on 'slow' devices, and before the UTXO Set snapshot is loaded.

/api/blockchain/utxo-set

json

Returns the latest UTXO Set snapshot. Warning: This call can be very slow, depending on node hardware and index configurations.

address

/api/address/:address

json

Returns a summary of data pertaining to the given address. The output of this call will depend heavily on the configured 'Address API' (see .env-sample file).

Optional parameters

limitNumber of transactions to return

offsetOffset into transactions

sortSorting direction for transactions ('desc'=new first, 'asc'=old first)

mining

/api/mining/hashrate

json

Returns the network hash rate, estimated over the last 1, 7, 30, 90, and 365 days.

/api/mining/diff-adj-estimate

number

Returns the current estimate for the next difficulty adjustment as a percentage.

/api/mining/next-block

json

Returns a summary for the estimated next block to be mined (produced via getblocktemplate).

/api/mining/next-block/txids

json

Returns a list of the transaction IDs included in the estimated next block to be mined (produced via getblocktemplate).

/api/mining/next-block/includes/:txid

boolean

Returns whether the specified transaction ID is included in the estimated next block to be mined (produced via getblocktemplate).

/api/mining/miner-summary

json

Returns whether the specified transaction ID is included in the estimated next block to be mined (produced via getblocktemplate).

Optional parameters

sinceUse the form 'Nd' to specify the number of day to look back (e.g. 'since=7d' will analyze the last 7 days)

startHeight+endHeightUse these 2 parameters to specify a custom start/end height (e.g. 'startHeight=0&endHeight=24' to analyze the first 25 blocks)

mempool

/api/mempool/count

integer

Returns the number of transactions in Qogecoin Core's mempool.

/api/mempool/fees

json

Returns recommended fee rates in sats/vB for next block, ~30 min, 1 hr, and 1 day.

util

/api/util/xyzpub/:extendedPubkey

json

Returns details for the specified extended public key, including related keys and addresses.

Optional parameters

limitThe number of addresses to return

offsetOffset into the list of addresses

price

/api/price

json

Returns the price of 1 BTC, in USD, EUR, GBP, and XAU

/api/price/:currency

number

Returns the price of 1 BTC, in one of USD, EUR, GBP, XAU

/api/price/:currency/marketcap

number

Returns the market cap of Qogecoin, in one of USD, EUR, GBP, XAU

/api/price/:currency/sats

number

Returns the price of 1 unit in 'currency' (e.g. $1) in satoshis

fun

/api/quotes/all

json

Returns the full curated list of Qogecoin quotes.

/api/quotes/:index

json

Returns the Qogecoin quote with the given index from the curated list.

/api/quotes/random

json

Returns a random Qogecoin quote from the curated list.

admin

/api/version

string

Returns the semantic version of the public API, which is maintained separate from the app version.