JSON APIDocumentation
module tree
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
json api
general response schema
note: `id` param may be used with any endpoint. if it's used, `context.id` will yield the request id similar to the json-rpc 2.0 standard. |
data endpoints
endpoint | params | `data` output | ||
---|---|---|---|---|
/ stats for ecosystems, blockchains, or modules examples: |
|
|
||
/{:blockchain}/blocks paginated block list examples: |
|
|
||
/{:blockchain}/block/{:block} block data, {:block} can be set to `-1` to display mempool information examples: |
|
|
||
/{:blockchain}/transaction/{:transaction} transaction data examples: |
|
|
||
/{:blockchain}/address/{:address} address data examples:
|
|
|
||
/{:blockchain}/addresses/{:address0},...,{:addressn} multiple address last seen data (max. 100 addresses) examples:
|
|
tip: the heights array yields the lastest block number in which the address is present, while for the mempool array it's the latest transaction unix time |
||
/search search in all blockchains (blocks, transactions, addresses) examples:
|
|
|
||
special endpoints | ||||
/dumps database dump list examples: |
|
for `all` and `latest` modes:
for `stats` mode:
|
mixins
mixin | can be used in | `mixins` output |
---|---|---|
stats yields stats on blockchains which are present in `data` (useful for getting the number of confirmations) examples:
|
all endpoints except for `/` and `/dumps` |
|
blocks yields block data for blocks which are present in `data` (useful for figuring out whether transaction has been processed by all modules); `processed` yields `null` and `true` for mempool, `false` and `true` for blockchain transactions; `false` means that transaction is yet to be processed by the corresponding module examples: |
`/{:blockchain}/transaction/{:transaction}` only |
|
libraries
library | can be used in | `library` output |
---|---|---|
blockchains yields info on blockchains which are present in `data` examples: |
all endpoints except for `/dumps` |
tip: first modules[] element is the default module |
modules yields info on modules which are present in `data` examples: |
all endpoints except for `/search` |
|
currencies yields info on currencies which are present in `data` examples:
|
`/{:blockchain}/block/{:block}`, `/{:blockchain}/transaction/{:transaction}`, `/{:blockchain}/address/{:address}` |
|
extras yields additioan info for `extra` fields which are present in `data` examples: |
`/{:blockchain}/block/{:block}`, `/{:blockchain}/transaction/{:transaction}`, `/{:blockchain}/address/{:address}` |
|
rates({:list}) exchange rates for all currencies in `data` on all met timestamps (plus `now` for balances) for comma-separated list of (`usd`) traditional currencies examples:
|
`/{:blockchain}/block/{:block}`, `/{:blockchain}/transaction/{:transaction}`, `/{:blockchain}/address/{:address}` tip: `?data=block` is imperative for `block` and `?data=transaction` is imperative for `transaction` as they yield needed timestamps |
|
enums
enum | variants |
---|---|
module.block_hash_format |
|
module.transaction_hash_format |
|
module.address_format |
|
module.currency_format |
|
module.transaction_render_model |
|
module.fee_render_model |
|
module.extra_data_model |
|
module.currency_type, currency.type |
|