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/ltc/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 Litecoin, 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/ltc/status"

Sample response

{
  "best_hash": "df13b4b788598d792a01f98d1d83b4e524331970b290fd0bf3fa5fd8d172af2c",
  "chain": "ltc",
  "decimals": 8,
  "difficulty": 94799393.9425668,
  "height": 3182578,
  "in_sync": true,
  "mempool_count": 398,
  "name": "Litecoin",
  "node_version": "/LitecoinCore:0.21.3/",
  "symbol": "LTC"
}

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/ltc/blocks?limit=2"

Sample response

[
  {
    "hash": "df13b4b788598d792a01f98d1d83b4e524331970b290fd0bf3fa5fd8d172af2c",
    "height": 3182578,
    "size": 73519,
    "time": 1790103336,
    "tx_count": 234
  },
  {
    "hash": "ffdd1b6b6b57bca716f5d45c000b7153ce0d1171e88df7420b9d3c7b4f8a1b43",
    "height": 3182577,
    "size": 266788,
    "time": 1790103232,
    "tx_count": 598
  }
]

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/ltc/block/3182568"

Sample response

{
  "bits": "192d4e1f",
  "confirmations": 11,
  "difficulty": 94799393.9425668,
  "hash": "ba99e2ba20372ea8a3a06b8afea04c19a8a8065e79b5e8b6f9ae7d5bfcb7fa65",
  "height": 3182568,
  "merkle_root": "ecd1483ffc1001782c9975a53647f77a6ad18cfd50a0af71db9d8452cc60f803",
  "next_hash": "51e0d6073bee7561111c283f27ceddef7026d7a28727fddd7c6c684c6c17faf5",
  "nonce": "1291976738",
  "previous_hash": "609e8213e8a3a62dc7415a80a36b3a34f5ff339f2225595b0feb131ce522ad2f",
  "size": 331116,
  "time": 1790102407,
  "tx_count": 590,
  "version": 536870932
}

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/ltc/block/3182568/txs?page_size=1"

Sample response

{
  "page": 1,
  "total_pages": 590,
  "tx_count": 590,
  "txs": [
    {
      "block_hash": "ba99e2ba20372ea8a3a06b8afea04c19a8a8065e79b5e8b6f9ae7d5bfcb7fa65",
      "block_height": 3182568,
      "coinbase": true,
      "confirmations": 11,
      "time": 1790102407,
      "txid": "cc5c68d3bd15f7c34622a17f38125bbdd8e0340a40821c94bc91107e8dcea0cc",
      "value_out": "627570487",
      "vin": [
        {
          "n": 0,
          "vout": 0
        }
      ],
      "vout": [
        {
          "addresses": [
            "LfdYLbP9F9CpmCX6atZnHZb8KkS8T6x4DK"
          ],
          "n": 0,
          "value": "627570487"
        },
        {
          "n": 1,
          "type": "nulldata",
          "value": "0"
        }
      ],
      "vsize": 241
    }
  ]
}

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/ltc/tx/298a2e831e490699a8fe323b48b4276505ce067b2109c04e01fa62d8558fe5b9"

Sample response

{
  "block_hash": "ba99e2ba20372ea8a3a06b8afea04c19a8a8065e79b5e8b6f9ae7d5bfcb7fa65",
  "block_height": 3182568,
  "confirmations": 11,
  "fee": "321291",
  "size": 222,
  "time": 1790102407,
  "txid": "298a2e831e490699a8fe323b48b4276505ce067b2109c04e01fa62d8558fe5b9",
  "value_in": "1198316466",
  "value_out": "1197995175",
  "version": 1,
  "vin": [
    {
      "addresses": [
        "LKWtpLC1tqsaJibWr27S1tHt3AosvjKYFW"
      ],
      "n": 0,
      "sequence": 4294967295,
      "txid": "c96641b1e3aabbb4113516f3c82ebbc7f66dbe4d2a93850e1687609fd4141131",
      "value": "1198316466",
      "vout": 1
    }
  ],
  "vout": [
    {
      "addresses": [
        "ltc1q7gqa6w0zc7nl0k3r2fs8ulu8eenx3tkrfugpsl"
      ],
      "n": 0,
      "script_hex": "0014f201dd39e2c7a7f7da2352607e7f87ce6668aec3",
      "value": "57907605"
    },
    {
      "addresses": [
        "LKWtpLC1tqsaJibWr27S1tHt3AosvjKYFW"
      ],
      "n": 1,
      "script_hex": "76a914033431d0296d3950e5bca7644965a91709cd497088ac",
      "value": "1140087570"
    }
  ],
  "vsize": 222
}

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/ltc/address/ltc1q7gqa6w0zc7nl0k3r2fs8ulu8eenx3tkrfugpsl"

Sample response

{
  "address": "ltc1q7gqa6w0zc7nl0k3r2fs8ulu8eenx3tkrfugpsl",
  "balance": "57907605",
  "received": "57907605",
  "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/ltc/address/ltc1q7gqa6w0zc7nl0k3r2fs8ulu8eenx3tkrfugpsl/txs?page_size=1"

Sample response

{
  "page": 1,
  "total_pages": 1,
  "tx_count": 1,
  "txs": [
    {
      "block_hash": "ba99e2ba20372ea8a3a06b8afea04c19a8a8065e79b5e8b6f9ae7d5bfcb7fa65",
      "block_height": 3182568,
      "confirmations": 11,
      "fee": "321291",
      "size": 222,
      "time": 1790102407,
      "txid": "298a2e831e490699a8fe323b48b4276505ce067b2109c04e01fa62d8558fe5b9",
      "value_in": "1198316466",
      "value_out": "1197995175",
      "version": 1,
      "vin": [
        {
          "addresses": [
            "LKWtpLC1tqsaJibWr27S1tHt3AosvjKYFW"
          ],
          "n": 0,
          "sequence": 4294967295,
          "txid": "c96641b1e3aabbb4113516f3c82ebbc7f66dbe4d2a93850e1687609fd4141131",
          "value": "1198316466",
          "vout": 1
        }
      ],
      "vout": [
        {
          "addresses": [
            "ltc1q7gqa6w0zc7nl0k3r2fs8ulu8eenx3tkrfugpsl"
          ],
          "n": 0,
          "script_hex": "0014f201dd39e2c7a7f7da2352607e7f87ce6668aec3",
          "value": "57907605"
        },
        {
          "addresses": [
            "LKWtpLC1tqsaJibWr27S1tHt3AosvjKYFW"
          ],
          "n": 1,
          "script_hex": "76a914033431d0296d3950e5bca7644965a91709cd497088ac",
          "value": "1140087570"
        }
      ],
      "vsize": 222
    }
  ]
}

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/ltc/address/ltc1q7gqa6w0zc7nl0k3r2fs8ulu8eenx3tkrfugpsl/utxo"

Sample response

{
  "count": 1,
  "truncated": false,
  "utxos": [
    {
      "confirmations": 11,
      "height": 3182568,
      "txid": "298a2e831e490699a8fe323b48b4276505ce067b2109c04e01fa62d8558fe5b9",
      "value": "57907605",
      "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/ltc/mempool"

Sample response

{
  "count": 398
}

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/ltc/search/3182568"

Sample response

{
  "hash": "ba99e2ba20372ea8a3a06b8afea04c19a8a8065e79b5e8b6f9ae7d5bfcb7fa65",
  "height": 3182568,
  "kind": "block"
}