Explorer API

Blocks, transactions and addresses for Zcash and Litecoin as JSON — one format for every chain, from the same indexes as this site.

Quick start

Create an account and an API key at https://account.olenza.io. The same key works for Olenza Node RPC and the Explorer API.
Send the key in the X-API-Key header:

curl -H "X-API-Key: YOUR_KEY" https://explorer.olenza.io/api/v1/zec/status

An Authorization: Bearer YOUR_KEY header also works. Keys are never accepted in the URL: URLs end up in logs.

Basics

Base URL: https://explorer.olenza.io/api/v1/{chain}/… — chain is zec (Zcash) or ltc (Litecoin).
Amounts are strings in the coin's smallest unit (for example zatoshi, litoshi). Divide by 10^decimals — decimals is in /status. Strings, because some chains' totals do not fit a 64-bit integer and JavaScript loses precision above 2⁵³.
A field that does not apply to a chain is left out, never null.
Only GET. Answers are application/json.

Plans and limits

Every call costs units — its weight below — against your plan's daily and monthly allowance, and counts once against the per-second rate limit. The Explorer API has its own plan and allowance, separate from Olenza Node: using up one does not touch the other. See pricing.

Every answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and — when your plan has quotas — X-Quota-Daily-Remaining and X-Quota-Monthly-Remaining in units. Calls the explorer fails to answer (5xx) are not charged; a 404 for something that does not exist is an answer and is charged.

Errors

{"error": {"reason": "NOT_FOUND", "message": "transaction not found"}}

HTTP	reason	Meaning
400	`BAD_REQUEST`	Malformed height, hash, address or parameter.
401	`MISSING_API_KEY`, `INVALID_API_KEY`	No key, or not a valid key.
403	`KEY_REVOKED`, `ACCOUNT_SUSPENDED`, `CHAIN_NOT_IN_PLAN`	The key or account cannot use this.
404	`NOT_FOUND`	No such block, transaction or address.
404	`CHAIN_NOT_FOUND`, `ENDPOINT_NOT_FOUND`	Unknown chain or path.
429	`RATE_LIMITED`, `DAILY_QUOTA_EXCEEDED`, `MONTHLY_QUOTA_EXCEEDED`	Slow down; `Retry-After` says for how long.
502, 503, 504	`UPSTREAM_ERROR`, `SERVICE_UNAVAILABLE`, `UPSTREAM_TIMEOUT`	Our side; not charged. Retry shortly.

Endpoints

Samples below are live answers from Zcash, lists cut to two items. Show samples from: Zcash Litecoin

Endpoint	Units
`GET /{chain}/status`	1
`GET /{chain}/blocks`	5
`GET /{chain}/block/{height\|hash}`	1
`GET /{chain}/block/{height\|hash}/txs`	3
`GET /{chain}/tx/{txid}`	1
`GET /{chain}/address/{address}`	2
`GET /{chain}/address/{address}/txs`	3
`GET /{chain}/address/{address}/utxo`	3
`GET /{chain}/mempool`	2
`GET /{chain}/search/{query}`	1

GET /{chain}/status 1 unit

Chain tip, sync state, the coin's symbol and decimals, mempool size.

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/status"

Sample response

{
  "best_hash": "000000000077c992c7a04aed898121a33434828dbb0593205117ccc05e046c3f",
  "chain": "zec",
  "decimals": 8,
  "difficulty": 265694322.63009727,
  "height": 3492543,
  "in_sync": true,
  "mempool_count": 13,
  "name": "Zcash",
  "node_version": "/Zebra:6.3.0/",
  "pools": [
    {
      "id": "transparent",
      "value": "1196868894972451"
    },
    {
      "id": "sprout",
      "value": "2247894694336"
    }
  ],
  "symbol": "ZEC"
}

GET /{chain}/blocks 5 units

Latest blocks, newest first.

limit — 1 to 25 (default 10)
start — height to start from (default: the tip)

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/blocks?limit=2"

Sample response

[
  {
    "hash": "000000000077c992c7a04aed898121a33434828dbb0593205117ccc05e046c3f",
    "height": 3492543,
    "size": 1630,
    "time": 1790100280,
    "tx_count": 1
  },
  {
    "hash": "00000000001dc076dcb915067bc2240cbc1a142d0cc528cd1f7f514054ba6bdc",
    "height": 3492542,
    "size": 226269,
    "time": 1790100272,
    "tx_count": 28
  }
]

GET /{chain}/block/{height|hash} 1 unit

One block's header and transaction count.

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/block/3492533"

Sample response

{
  "bits": "1c0088b2",
  "confirmations": 11,
  "difficulty": 251359554.35194606,
  "hash": "000000000035bde0fbc316e182b4f733aae074a5fc1cf9d841c42c4ca57fdde1",
  "height": 3492533,
  "merkle_root": "04fca6f85853d9c053b0b3cf0f66e26cbd298832628389df8324ee46de12195f",
  "next_hash": "0000000000622e4d7e9ed3b08ca46d9999e678f695ac35b8e4766271d5c2aaea",
  "nonce": "b88301000000000000000000001000000000000000000000000000005648f7e7",
  "previous_hash": "0000000000223806c4c90b6b478b590a915d3b0e5477bb3f7377e141fbc8079b",
  "size": 261314,
  "time": 1790099742,
  "tx_count": 32,
  "version": 4
}

GET /{chain}/block/{height|hash}/txs 3 units

A block's transactions, in block order.

page — page number, from 1 (default 1)
page_size — 1 to 50 (default 25)

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/block/3492533/txs?page_size=1"

Sample response

{
  "page": 1,
  "total_pages": 32,
  "tx_count": 32,
  "txs": [
    {
      "block_hash": "000000000035bde0fbc316e182b4f733aae074a5fc1cf9d841c42c4ca57fdde1",
      "block_height": 3492533,
      "coinbase": true,
      "confirmations": 11,
      "size": 142,
      "time": 1790099742,
      "txid": "ea77cc3d94163c6e2c421d46e83db48dee8603f665e10b153a5bc5edb56ee45b",
      "value_out": "138037600",
      "version": 6,
      "vin": [
        {
          "coinbase": "03b54a3504f09f8cb8",
          "n": 0,
          "sequence": 4294967295,
          "vout": 0
        }
      ],
      "vout": [
        {
          "addresses": [
            "t1MKn34KBa8Xh4g8qU8psibBXvURafphVn7"
          ],
          "n": 0,
          "script_hex": "76a91425db9091e9786867e536f70089a5102523ab1d6a88ac",
          "type": "pubkeyhash",
          "value": "125537600"
        },
        {
          "addresses": [
            "t3cFfPt1Bcvgez9ZbMBFWeZsskxTkPzGCow"
          ],
          "n": 1,
          "script_hex": "a914c20cd5bdf7964ca61764db66bc2531b1792a084d87",
          "type": "scripthash",
          "value": "12500000"
        }
      ]
    }
  ]
}

GET /{chain}/tx/{txid} 1 unit

One transaction with every input resolved: input values and addresses, total in, fee.

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/tx/bf8e14c3a320ae360dcb3654e8161d2fc0a0d81db7fd62a5f099c9afb8b12821"

Sample response

{
  "block_hash": "000000000035bde0fbc316e182b4f733aae074a5fc1cf9d841c42c4ca57fdde1",
  "block_height": 3492533,
  "confirmations": 11,
  "fee": "0",
  "size": 9200,
  "time": 1790099742,
  "txid": "bf8e14c3a320ae360dcb3654e8161d2fc0a0d81db7fd62a5f099c9afb8b12821",
  "value_in": "0",
  "value_out": "520000",
  "version": 6,
  "vin": [],
  "vout": [
    {
      "addresses": [
        "t1TRSb89CwouTyzzSpQcwNgEG6kFwWmMZdp"
      ],
      "n": 0,
      "script_hex": "76a91468be94e03d3317de5fc3592bd2af13d56cf855a888ac",
      "type": "pubkeyhash",
      "value": "520000"
    }
  ]
}

GET /{chain}/address/{address} 2 units

Balance, total received and sent, transaction count.

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/address/t1TRSb89CwouTyzzSpQcwNgEG6kFwWmMZdp"

Sample response

{
  "address": "t1TRSb89CwouTyzzSpQcwNgEG6kFwWmMZdp",
  "balance": "520000",
  "received": "520000",
  "sent": "0",
  "tx_count": 1
}

GET /{chain}/address/{address}/txs 3 units

An address's transactions, newest first.

page — page number, from 1 (default 1)
page_size — 1 to 50 (default 25)

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/address/t1TRSb89CwouTyzzSpQcwNgEG6kFwWmMZdp/txs?page_size=1"

Sample response

{
  "page": 1,
  "total_pages": 1,
  "tx_count": 1,
  "txs": [
    {
      "block_hash": "000000000035bde0fbc316e182b4f733aae074a5fc1cf9d841c42c4ca57fdde1",
      "block_height": 3492533,
      "confirmations": 11,
      "size": 9200,
      "time": 1790099742,
      "txid": "bf8e14c3a320ae360dcb3654e8161d2fc0a0d81db7fd62a5f099c9afb8b12821",
      "value_out": "520000",
      "version": 6,
      "vin": [],
      "vout": [
        {
          "addresses": [
            "t1TRSb89CwouTyzzSpQcwNgEG6kFwWmMZdp"
          ],
          "n": 0,
          "script_hex": "76a91468be94e03d3317de5fc3592bd2af13d56cf855a888ac",
          "type": "pubkeyhash",
          "value": "520000"
        }
      ]
    }
  ]
}

GET /{chain}/address/{address}/utxo 3 units

Unspent outputs of an address — at most 1000, the largest first when there are more; count says how many there are.

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/address/t1TRSb89CwouTyzzSpQcwNgEG6kFwWmMZdp/utxo"

Sample response

{
  "count": 1,
  "truncated": false,
  "utxos": [
    {
      "confirmations": 11,
      "height": 3492533,
      "txid": "bf8e14c3a320ae360dcb3654e8161d2fc0a0d81db7fd62a5f099c9afb8b12821",
      "value": "520000",
      "vout": 0
    }
  ]
}

GET /{chain}/mempool 2 units

Transactions waiting to be mined.

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/mempool"

Sample response

{
  "bytes": 84118,
  "count": 13
}

GET /{chain}/search/{query} 1 unit

What a height, hash, txid or address is: block, tx, address or none.

curl -H "X-API-Key: YOUR_KEY" "https://explorer.olenza.io/api/v1/zec/search/3492533"

Sample response

{
  "hash": "000000000035bde0fbc316e182b4f733aae074a5fc1cf9d841c42c4ca57fdde1",
  "height": 3492533,
  "kind": "block"
}