githubEdit

getblockfilter - Bitcoin {disallowed}

Example code for the getblockfilter JSON-RPC method. Complete guide on how to use getblockfilter JSON-RPC in GetBlock Web3 documentation.

This method retrieves a BIP 157 content filter for a particular block.

Parameters

Parameter
Type
Required
Description

blockhash

string

Yes

The hash of the block.

filtertype

string

No

The type name of the filter (default: "basic").

Request

curl --location --request POST 'https://go.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "getblockfilter",
    "params": ["000000000000000000046b9302e08c16ea186950f42a5498320ddd1bd7ab3428", "basic"],
    "id": "getblock.io"
}'

Response

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": {
        "filter": "0193b2a0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6...",
        "header": "a1b2c3d4e5f6789abcdef0123456789abcdef01234567890abcdef1234567890"
    }
}

Response Parameters

Field
Type
Description

filter

string

The hex-encoded filter data.

header

string

The hex-encoded filter header.

Use Case

The getblockfilter method is essential for:

  • Light client implementations (BIP 157/158)

  • Efficient address balance scanning

  • Privacy-preserving blockchain queries

  • Mobile wallet synchronization

  • Reducing bandwidth for SPV clients

  • Building neutrino-compatible applications

Error Handling

Status Code
Error Message
Cause

403

Forbidden

Missing or invalid ACCESS-TOKEN.

-5

Block not found

The specified block hash does not exist.

-1

Index not enabled

Block filter index is not enabled on the node.

Integration With Web3

The getblockfilter method helps developers:

  • Build light wallet implementations

  • Reduce bandwidth requirements for clients

  • Implement BIP 157/158 protocols

  • Create privacy-focused wallet scanners

  • Support mobile and resource-constrained devices

Last updated

Was this helpful?