API Docs

Current Version:v1.1.0(changelog)

About the API

The API documented below is made available by grs-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

json

Returns the details of a transaction.

blockchain

/api/blockchain/coins

number

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

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).

mempool

/api/mempool/count

integer

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

/api/mempool/fees

json

Returns recommended fee rates in gros/vB for next block, 2 min, 3 min, and 4 min.

util

/api/util/xyzpub/:extendedPubkey

json

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

Optional params:limitoffset

price

json

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

/api/price/:currency

number

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

/api/price/:currency/marketcap

number

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

/api/price/:currency/sats

number

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

fun

/api/quotes/all

json

Returns the full curated list of Groestlcoin quotes.

/api/quotes/:index

json

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

/api/quotes/random

json

Returns a random Groestlcoin quote from the curated list.

admin

string

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