Blockchain API is a RESTful API for accessing Bitcoin blockchain data. It provides endpoints to retrieve information about blocks, transactions, addresses, and more. The API supports both mainnet and testnet environments.
👉 View Swagger UI
| Route | Summary |
|---|---|
GET /v1/indexer/blockchain/info |
Get chain tip, header height, and best block metadata |
GET /v1/indexer/fees/recommended |
Get recommended Bitcoin fee rates by confirmation target |
GET /v1/indexer/height/(height)/block |
Get block metadata by height |
GET /v1/indexer/block/id/(blockid) |
Get block metadata by block hash |
GET /v1/indexer/block/(height)/txs |
List indexed transactions in a block by height |
GET /v1/indexer/tx/(txid) |
Get indexed transaction summary by txid |
GET /v1/indexer/tx/(txid)/ins |
List inputs spent by a transaction |
GET /v1/indexer/tx/(txid)/outs |
List outputs created by a transaction |
GET /v1/indexer/rawtx/(txid) |
Get raw transaction hex by txid |
GET /v1/indexer/utxo/(txid)/(index) |
Get one transaction output by txid and vout |
POST /v1/indexer/local_pushtx |
Broadcast one raw transaction to the selected network |
POST /v1/indexer/local_pushtxs |
Broadcast multiple raw transactions to the selected network |
GET /v1/indexer/address/(address)/balance |
Get address balance split by BTC and inscription UTXOs |
GET /v1/indexer/address/(address)/history |
List indexed transaction history for an address |
GET /v1/indexer/address/(address)/utxo-data |
List UTXOs for an address |
GET /v1/indexer/address/(address)/all-utxo-data |
List all indexed UTXOs for an address |
GET /v1/indexer/address/(address)/available-balance |
Get address balance grouped by available and unavailable UTXOs |
GET /v1/indexer/address/(address)/available-utxo-data |
List available UTXOs for an address |
POST /v1/indexer/unavailable-utxo/unlock/prepare |
Prepare a message for unlocking unavailable UTXOs |
POST /v1/indexer/unavailable-utxo/unlock |
Unlock unavailable UTXOs after wallet authorization |
POST /v1/indexer/unavailable-utxo/lock/prepare |
Prepare a message for locking UTXOs |
POST /v1/indexer/unavailable-utxo/lock |
Lock UTXOs after wallet authorization |
POST /v1/indexer/check/utxo/unlock |
Check whether UTXOs were manually unlocked |
Method: GET
Path: /v1/indexer/blockchain/info
Swagger Link: View in Swagger UI
Returns the indexed blockchain state, including chain name, block and header heights, best and previous block hashes, median time, and accumulated chainwork.
Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
chain (string):blocks (integer):headers (integer):bestBlockHash (string):prevBlockHash (string):medianTime (integer):chainwork (string):Invalid API Key
Method: GET
Path: /v1/indexer/fees/recommended
Swagger Link: View in Swagger UI
Returns fee-rate estimates for fastest, half-hour, hour, economy, and minimum confirmation targets, together with the update timestamp for freshness checks.
Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
fastestFee (integer):halfHourFee (integer):hourFee (integer):economyFee (integer):minimumFee (integer):updateTime (integer):Invalid API Key
Method: GET
Path: /v1/indexer/height/{height}/block
Swagger Link: View in Swagger UI
Returns indexed block details such as hash links, transaction count, satoshi totals, coinbase output, timestamp, bits, and serialized size for the requested height.
height (path, integer) (required): Block heightSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
height (integer):version (string):auxpow (boolean):id (string):prev (string):next (string):merkle (string):ntx (integer):inSatoshi (integer):outSatoshi (integer):coinbaseOut (number):timestamp (integer):bits (number):size (integer):Invalid API Key
Method: GET
Path: /v1/indexer/block/id/{blockid}
Swagger Link: View in Swagger UI
Returns the same indexed block model as height lookup, including chain links, transaction count, value totals, timestamp, difficulty bits, and block size.
blockid (path, string) (required): Block idSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
height (integer):version (string):auxpow (boolean):id (string):prev (string):next (string):merkle (string):ntx (integer):inSatoshi (integer):outSatoshi (integer):coinbaseOut (number):timestamp (integer):bits (number):size (integer):Invalid API Key
Method: GET
Path: /v1/indexer/block/{height}/txs
Swagger Link: View in Swagger UI
Returns paginated transaction summaries for a block, including each transaction’s input/output counts, satoshi totals, locktime, size, block position, confirmations, and timestamp.
height (path, integer) (required): Block heightcursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
txid (string):nIn (integer):nOut (integer):inSatoshi (integer):outSatoshi (integer):locktime (integer):size (integer):witOffset (integer):height (integer):idx (integer):blkid (string):confirmations (integer):timestamp (integer):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/tx/{txid}
Swagger Link: View in Swagger UI
Returns transaction-level metadata such as input/output counts, satoshi totals, locktime, size, witness offset, block hash, confirmations, and timestamp.
txid (path, string) (required): Tx idSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
txid (string):nIn (integer):nOut (integer):inSatoshi (integer):outSatoshi (integer):locktime (integer):size (integer):witOffset (integer):height (integer):idx (integer):blkid (string):confirmations (integer):timestamp (integer):Invalid API Key
Method: GET
Path: /v1/indexer/tx/{txid}/ins
Swagger Link: View in Swagger UI
Returns paginated previous-output records consumed by a transaction, including address, script data, satoshi value, inscription metadata, source txid, vout, and indexed height fields.
txid (path, string) (required): Tx idcursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
address (string):codeType (integer): 0~3: Reserved , 4: CodeType_P2PK, 5: CodeType_P2PKH, 6: CodeType_P2SH, 7: CodeType_P2WPKH, 8: CodeType_P2WSH, 9: CodeType_P2TR; enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9inscriptions (array):
inscriptionId (string):inscriptionNumber (integer):isBRC20 (boolean):moved (boolean):offset (integer):satoshi (integer):scriptPk (string):scriptSig (string):scriptType (string):scriptWits (string):sequence (integer):height (integer):txid (string):idx (integer):heightTxo (integer):utxid (string):vout (integer):Invalid API Key
Method: GET
Path: /v1/indexer/tx/{txid}/outs
Swagger Link: View in Swagger UI
Returns paginated transaction outputs with address, script type and scriptPubKey, satoshi value, inscription metadata, output index, and spend status fields when indexed.
txid (path, string) (required): Tx idcursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
address (string):codeType (integer):inscriptions (array):
inscriptionId (string):inscriptionNumber (integer):isBRC20 (boolean):moved (boolean):offset (integer):satoshi (integer):scriptPk (string):scriptType (string):height (integer):txid (string):idx (integer):heightSpent (integer):txidSpent (string):vout (integer):Invalid API Key
Method: GET
Path: /v1/indexer/rawtx/{txid}
Swagger Link: View in Swagger UI
Returns the serialized raw transaction hex for decoding, verification, rebroadcast analysis, or offline transaction inspection.
txid (path, string) (required): Tx idSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (string):Invalid API Key
Method: GET
Path: /v1/indexer/utxo/{txid}/{index}
Swagger Link: View in Swagger UI
Returns indexed output details including satoshi value, script type, scriptPubKey, address, inscription metadata, RBF marker, and whether the output is spent.
txid (path, string) (required): Tx idindex (path, string) (required): Transaction output index (vout) of the UTXO.Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
txid (string):vout (integer): example: 0satoshi (integer): example: 10000scriptType (string):scriptPk (string):codeType (integer):address (string):height (integer):idx (integer):inscriptions (array):
inscriptionId (string):inscriptionNumber (integer):isBRC20 (boolean):moved (boolean):offset (integer):isOpInRBF (boolean): example: falseisSpent (boolean): example: falseInvalid API Key
The return result of this UTXO interface will have three scenarios:
When UTXO has not been spent, it will return the information of this UTXO, and isSpent will be set to false.

When UTXO has been spent, but the transaction that spent it has not yet been confirmed, it will return the information of this UTXO, and isSpent will be set to true.

When UTXO has been spent and the transacted spend has been confirmed, it will return null.

BRC20 inscriptions of type TRANSFER (those that have undergone transfers) and MINT inscriptions, which no longer hold value, will no longer be available for query after this update. Before Upgrade:
{
"code": 0,
"msg": "ok",
"data": {
"txid": "...",
"vout": 0,
"satoshi": 546,
"scriptType": "5120",
"scriptPk": "...",
"codeType": 9,
"address": "...",
"height": 815539,
"idx": 2516,
"isOpInRBF": false,
"isSpent": false,
"inscriptionsCount": 2,
"inscriptions": [
{
"inscriptionNumber": 38012882,
"inscriptionId": "...",
"offset": 0,
"moved": false,
"sequence": 0,
"isCursed": false,
"isVindicate": false,
"isBRC20Ext": false,
"isBRC20": true
},
{
"inscriptionNumber": 38012883,
"inscriptionId": "....",
"offset": 0,
"moved": false,
"sequence": 0,
"isCursed": false,
"isVindicate": false,
"isBRC20Ext": false,
"isBRC20": false
}
]
}
}
After Upgrade:
{
"code": 0,
"msg": "ok",
"data": {
"txid": "...",
"vout": 0,
"satoshi": 546,
"scriptType": "5120",
"scriptPk": "...",
"codeType": 9,
"address": "...",
"height": 815539,
"idx": 2516,
"isOpInRBF": false,
"isSpent": false,
"inscriptionsCount": 2,
"inscriptions": [
{
"inscriptionNumber": 38012883,
"inscriptionId": "....",
"offset": 0,
"moved": false,
"sequence": 0,
"isCursed": false,
"isVindicate": false,
"isBRC20Ext": false,
"isBRC20": false
}
]
}
}
Migration Guidance:
Method: POST
Path: /v1/indexer/local_pushtx
Swagger Link: View in Swagger UI
Submits a signed transaction hex and optional maximum fee rate for local validation and propagation. This can move funds or assets and requires explicit confirmation before execution.
Content-Type: application/json (required)
txHex (string): rawtx; example: ""maxFeeRate (number): maxfeerate btc/kvB(optional and must less than 1 btc/kvB)Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (string):Invalid API Key
Method: POST
Path: /v1/indexer/local_pushtxs
Swagger Link: View in Swagger UI
Submits a batch of signed transaction hex strings with optional maximum fee rate. Use only after validating order, dependencies, fees, and target network because each transaction may move funds or assets.
Content-Type: application/json (required)
txsHex (array):maxFeeRate (number): maxfeerate btc/kvB(optional and must less than 1 btc/kvB)Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (array):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/balance
Swagger Link: View in Swagger UI
Returns confirmed and pending satoshi totals plus UTXO counts for the address, separated into overall, plain BTC, and inscription-related balances.
address (path, string) (required): AddressSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
address (string):satoshi (integer):pendingSatoshi (integer):utxoCount (integer):btcSatoshi (integer):btcPendingSatoshi (integer):btcUtxoCount (integer):inscriptionSatoshi (integer):inscriptionPendingSatoshi (integer):inscriptionUtxoCount (integer):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/history
Swagger Link: View in Swagger UI
Returns paginated transaction summaries involving the address, including transaction size, satoshi totals, block position, confirmations, and timestamp for wallet activity views.
address (path, string) (required): Addresscursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
txid (string):nIn (integer):nOut (integer):inSatoshi (integer):outSatoshi (integer):locktime (integer):size (integer):witOffset (integer):height (integer):idx (integer):blkid (string):confirmations (integer):timestamp (integer):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/utxo-data
Swagger Link: View in Swagger UI
Returns paginated UTXO records with confirmed, unconfirmed, and unconfirmed-spend totals. Each UTXO includes address, satoshi value, script data, inscriptions, RBF marker, and output coordinates.
address (path, string) (required): Addresscursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
cursor (integer):total (integer):totalConfirmed (integer):totalUnconfirmed (integer):totalUnconfirmedSpend (integer):utxo (array):
address (string):codeType (integer):height (integer):idx (integer):inscriptions (array):
inscriptionId (string):inscriptionNumber (integer):isBRC20 (boolean):moved (boolean):offset (integer):isOpInRBF (boolean): example: falsesatoshi (integer): example: 10000scriptPk (string):scriptType (string):txid (string):vout (integer): example: 0isLowFee (boolean): Whether the UTXO has a low fee rate (less than 1 sat/vB)Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/all-utxo-data
Swagger Link: View in Swagger UI
Returns paginated UTXO records and aggregate totals across confirmed, unconfirmed, and unconfirmed-spend states, including inscription and low-fee metadata when indexed.
address (path, string) (required): Addresscursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
cursor (integer):total (integer):totalConfirmed (integer):totalUnconfirmed (integer):totalUnconfirmedSpend (integer):utxo (array):
address (string):codeType (integer):height (integer):idx (integer):inscriptions (array):
inscriptionId (string):inscriptionNumber (integer):isBRC20 (boolean):moved (boolean):offset (integer):isOpInRBF (boolean): example: falsesatoshi (integer): example: 10000scriptPk (string):scriptType (string):txid (string):vout (integer): example: 0isLowFee (boolean): Whether the UTXO has a low fee rate (less than 1 sat/vB)Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/available-balance
Swagger Link: View in Swagger UI
Returns total, available, and unavailable satoshi balances with matching UTXO counts. The optional low-fee flag controls whether UTXOs below 1 sat/vB are included in availability calculations.
address (path, string) (required): AddresswithLowFee (query, boolean): Whether to include UTXOs balance with low fee rate (less than 1 sat/vB)Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
totalBalance (integer):totalUtxoCount (integer):availableBalance (integer):availableUtxoCount (integer):unavailableBalance (integer):unavailableUtxoCount (integer):Invalid API Key
Method: GET
Path: /v1/indexer/address/{address}/available-utxo-data
Swagger Link: View in Swagger UI
Returns paginated UTXOs considered available for spending, along with aggregate confirmed, unconfirmed, and unconfirmed-spend totals. The low-fee option controls inclusion of UTXOs below 1 sat/vB.
address (path, string) (required): Addresscursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedwithLowFee (query, boolean): Whether to include UTXOs with low fee rate (less than 1 sat/vB)Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
cursor (integer):total (integer):totalConfirmed (integer):totalUnconfirmed (integer):totalUnconfirmedSpend (integer):utxo (array):
address (string):codeType (integer):height (integer):idx (integer):inscriptions (array):
inscriptionId (string):inscriptionNumber (integer):isBRC20 (boolean):moved (boolean):offset (integer):isOpInRBF (boolean): example: falsesatoshi (integer): example: 10000scriptPk (string):scriptType (string):txid (string):vout (integer): example: 0isLowFee (boolean): Whether the UTXO has a low fee rate (less than 1 sat/vB)Invalid API Key
Method: POST
Path: /v1/indexer/unavailable-utxo/unlock/prepare
Swagger Link: View in Swagger UI
Available only on Bitcoin Mainnet and Fractal Bitcoin Mainnet. Validates the requested UTXOs against the address’s current lock state and returns the exact message and nonce that the wallet must sign. This step does not change UTXO availability. Unlocking is a high-risk action because protocol-asset UTXOs may subsequently be selected and spent as BTC.
Content-Type: application/json (required)
address (string): required; Address that owns the requested UTXOs.outpointList (array): Ordered UTXO list. Preserve this exact order when submitting the signed execution request.
txid (string): required; Transaction id of the UTXO as a 64-character hexadecimal string.index (integer): required; Transaction output index (vout).Message prepared, or a validation error returned in the response envelope
code (integer (int32)): 0 on success, -1 for a validation or processing error, or -1001 when the manual lock or unlock limit is exceeded.; enum: 0, -1, -1001msg (string): example: "ok"data (object):
message (string): Exact human-readable message that the wallet must sign without modification.nonce (integer): example: 123456Invalid API Key
Method: POST
Path: /v1/indexer/unavailable-utxo/unlock
Swagger Link: View in Swagger UI
Available only on Bitcoin Mainnet and Fractal Bitcoin Mainnet. Verifies the signed prepare message and marks eligible UTXOs as manually unlocked. Unlocked UTXOs may appear in available balance and available UTXO results even when they carry inscriptions or other protocol assets. Spending such UTXOs can transfer or destroy those assets; obtain explicit user confirmation before submitting this request.
Content-Type: application/json (required)
address (string): required; Address that owns the requested UTXOs.outpointList (array): Ordered UTXO list. Preserve this exact order when submitting the signed execution request.
txid (string): required; Transaction id of the UTXO as a 64-character hexadecimal string.index (integer): required; Transaction output index (vout).pubkey (string): required; Hex-encoded secp256k1 public key used to verify the wallet signature.signature (string): required; Base64-encoded 65-byte compact ECDSA signature over the exact prepare message using the Bitcoin Signed Message prefix.nonce (integer): required; Nonce returned by the matching prepare request.Unlock applied, or an error returned in the response envelope
code (integer (int32)): 0 on success, -1 for a validation, signature, or processing error, or -1001 when the manual lock or unlock limit is exceeded.; enum: 0, -1, -1001msg (string): example: "ok"Invalid API Key
Method: POST
Path: /v1/indexer/unavailable-utxo/lock/prepare
Swagger Link: View in Swagger UI
Available only on Bitcoin Mainnet and Fractal Bitcoin Mainnet. Validates the requested UTXOs against the address’s current unlock state and returns the exact message and nonce that the wallet must sign. This step does not change UTXO availability. Use the returned values with the lock execution endpoint.
Content-Type: application/json (required)
address (string): required; Address that owns the requested UTXOs.outpointList (array): Ordered UTXO list. Preserve this exact order when submitting the signed execution request.
txid (string): required; Transaction id of the UTXO as a 64-character hexadecimal string.index (integer): required; Transaction output index (vout).Message prepared, or a validation error returned in the response envelope
code (integer (int32)): 0 on success, -1 for a validation or processing error, or -1001 when the manual lock or unlock limit is exceeded.; enum: 0, -1, -1001msg (string): example: "ok"data (object):
message (string): Exact human-readable message that the wallet must sign without modification.nonce (integer): example: 123456Invalid API Key
Method: POST
Path: /v1/indexer/unavailable-utxo/lock
Swagger Link: View in Swagger UI
Available only on Bitcoin Mainnet and Fractal Bitcoin Mainnet. Verifies the signed prepare message and restores eligible UTXOs to the protected or unavailable set. Locked UTXOs are excluded from normal available balance and coin-selection results, helping prevent accidental spending of inscriptions and other protocol assets.
Content-Type: application/json (required)
address (string): required; Address that owns the requested UTXOs.outpointList (array): Ordered UTXO list. Preserve this exact order when submitting the signed execution request.
txid (string): required; Transaction id of the UTXO as a 64-character hexadecimal string.index (integer): required; Transaction output index (vout).pubkey (string): required; Hex-encoded secp256k1 public key used to verify the wallet signature.signature (string): required; Base64-encoded 65-byte compact ECDSA signature over the exact prepare message using the Bitcoin Signed Message prefix.nonce (integer): required; Nonce returned by the matching prepare request.Lock applied, or an error returned in the response envelope
code (integer (int32)): 0 on success, -1 for a validation, signature, or processing error, or -1001 when the manual lock or unlock limit is exceeded.; enum: 0, -1, -1001msg (string): example: "ok"Invalid API Key
Method: POST
Path: /v1/indexer/check/utxo/unlock
Swagger Link: View in Swagger UI
Available only on Bitcoin Mainnet and Fractal Bitcoin Mainnet. Returns one boolean for each submitted outpoint, in the same order. true means the UTXO is present in the manual unlock history; false means it is not. This endpoint checks manual unlock state only and does not independently prove that a UTXO is unspent or currently spendable.
Content-Type: application/json (required)
txid (string): required; Transaction id of the UTXO as a 64-character hexadecimal string.index (integer): required; Transaction output index (vout).Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "ok"data (array): Manual unlock flags aligned by index with the submitted outpoint array.; example: [true,false]Invalid API Key