API Reference

You can manage your subscription status using these APIs. See below for details.

Event types

bvPendingTransactions

You can subscribe to multiple events at once through our eth_subscribe service. Among them, bvPendingTransactions also supports filtering feature. For more details, please see below.
Supported on Ethereum, BNB Chain and Polygon.

Parameters

Params - a string array containing (required):

  • topic(string, required) - 'bvPendingTransactions'.
  • fromAddress(array of string, optional) - sending addresses of the transactions.
  • toAddress(array of string, optional) - receiving addresses of the transactions.
  • methodIds(array of string, optional) - method ids of transactions that needed to be subscribed to.

Returns

  • id(integer number) - json-rpc id.
  • jsonrpc(string) - json-rpc version.
  • params(object) - an object with the following fields:
    • result(object) - an object with the following fields:
      • blockHash(hex string) - 32 Bytes - the hash of the block where the given transaction was included.
      • blockNumber(hex string) - the number of the block where the given transaction was included.
      • from(hex string) - 20 Bytes - address of the sender.
      • gas(hex string) - gas provided by the sender.
      • gasPrice(hex string) - gas price provided by the sender in wei.
      • hash(hex string) - 32 Bytes - hash of the transaction.
      • input(hex string) - the data send along with the transaction.
      • nonce(hex string) - the number of transactions made by the sender prior to this one.
      • to(hex string) - 20 Bytes - address of the receiver.
      • transactionIndex(hex string) - the index of the transaction within the block.
      • value(hex string) - value transferred in Wei.
      • type(hex string) - type of the transaction.
      • chainId(hex string) - Chain ID where the transaction was made.
      • v(hex string) - ECDSA recovery ID.
      • r(hex string) - ECDSA signature r.
      • s(hex string) - ECDSA signature s.
    • subscription(hex string) - subscription ID. Unique for each record.

Request

wss://eth-mainnet.blockvision.org/v1/<api-key>

> {"jsonrpc":"2.0","id": 2, "method": "eth_subscribe", "params": ["bvPendingTransactions", {"toAddress": ["0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "0xdAC17F958D2ee523a2206206994597C13D831ec7"]}]}
import { BlockVisionWebSocketProvider, BvNetwork } from 'blockvision.js'

// Optional parameters, but default to eth-mainnet and default api-key.
const bvWs = new BlockVisionWebSocketProvider(BvNetwork.ETH_MAINNET)


const callback = {
	message: (data: any) => {
		console.log(data)
	}
}
const params = {
	toAddress: ['0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', '0xdAC17F958D2ee523a2206206994597C13D831ec7']
}
// Establish a websocket connection through _bvSubscribe and subscribe to events
const ws = bvWs._bvSubscribe('bvPendingTransactions', callback, params)

Result

< {"msgType":1,"id":2,"jsonrpc":"2.0","result":"0xb0fa4e43851f6d5fc4050190f664ea28","params":{"subscription":"0xb0fa4e43851f6d5fc4050190f664ea28"}}
< {
    "msgType": 1,
    "jsonrpc": "2.0",
    "method": "eth_subscription",
    "params": {
        "result": {
            "blockHash": "",
            "blockNumber": "",
            "from": "0xf22bb1c67cefce284ef9a9b86d9376feb987f72a",
            "gas": "0x3339f",
            "maxPriorityFeePerGas": "0x3b9aca00",
            "maxFeePerGas": "0x14d2a3610",
            "hash": "0x213010fcc6b225ca9a68c3829ad174ba86c5706e90703d269395af684af04919",
            "input": "0x5f029ebe584d4e0000000000000000000000000000000000000000000000000000000000",
            "nonce": "0x34e",
            "to": "0x2cc8342d7c8bff5a213eb2cde39de9a59b3461a7",
            "transactionIndex": "0x79",
            "value": "0x0",
            "type": "0x2",
            "chainId": "0x1",
            "v": "0x0",
            "r": "0x18fbb6868c96439259c428ca23d39c1e50c330b49195437f57ac26b6e520f32d",
            "s": "0x3f036bb3408f1712a6f87d4a5fe0e41b078ec72b81d61b68e885775661bc44d2"
        },
        "subscription": "0xb0fa4e43851f6d5fc4050190f664ea28"
    }
}

bvMinedTransactions

You can subscribe to multiple events at once through our eth_subscribe service. Among them, bvMinedTransactions also supports filtering feature. For more details, please see below.
Supported on Ethereum, BNB Chain and Polygon.

Parameters

Params - a string array containing (required):

  • topic(string, required) - 'bvPendingTransactions'.
  • fromAddress(array of string, optional) - transactions that sent from these addresses.
  • toAddress(array of string, optional) - transactions that sent to these addresses.
  • methodIds(array of string, optional) - method ids that needed to be subscribe to.

Returns

  • id(integer number) - json-rpc id.
  • jsonrpc(string) - json-rpc version.
  • params(object) - An object with the following fields:
    • result(object) - An object with the following fields:
      • blockHash(hex string) - The hash of the block where the given transaction was included.
      • blockNumber(hex string) - The number of the block where the given transaction was included.
      • from(hex string) - 20 Bytes - Address of the sender.
      • gas(hex string) - Gas provided by the sender.
      • gasPrice(hex string) - Gas price provided by the sender in Wei.
      • hash(hex string) - 32 Bytes - Hash of the transaction.
      • input(hex string) - The data send along with the transaction.
      • nonce(hex string) - The number of transactions made by the sender prior to this one.
      • to(hex string) - 20 Bytes - Address of the receiver.
      • transactionIndex(hex string) - The index of the transaction within the block.
      • value(hex string) - Value transferred in Wei.
      • type(hex string) - Type of the transaction.
      • chainId(hex string) - chain ID where the transaction was made.
      • v(hex string) - ECDSA recovery ID.
      • r(hex string) - ECDSA signature r.
      • s(hex string) - ECDSA signature s.
    • subscription(hex string) - Subscription ID. Unique for each record.

Request

wss://eth-mainnet.blockvision.org/v1/<api-key>

> {"jsonrpc":"2.0","id": 2, "method": "eth_subscribe", "params": ["bvPendingTransactions", {"toAddress": ["0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "0xdAC17F958D2ee523a2206206994597C13D831ec7"]}]}
import { BlockVisionWebSocketProvider, BvNetwork } from 'blockvision.js'

// Optional parameters, but default to eth-mainnet and default api-key.
const bvWs = new BlockVisionWebSocketProvider(BvNetwork.ETH_MAINNET)


const callback = {
	message: (data: any) => {
		console.log(data)
	}
}
const params = {
	toAddress: ['0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', '0xdAC17F958D2ee523a2206206994597C13D831ec7']
}
// Establish a websocket connection through _bvSubscribe and subscribe to events
const ws = bvWs._bvSubscribe('bvMinedTransactions', callback, params)

Result

< {"msgType":1,"id":2,"jsonrpc":"2.0","result":"0xb0fa4e43851f6d5fc4050190f664ea28","params":{"subscription":"0xb0fa4e43851f6d5fc4050190f664ea28"}}
< {
    "msgType": 1,
    "jsonrpc": "2.0",
    "method": "eth_subscription",
    "params": {
        "result": {
            "blockHash": "",
            "blockNumber": "",
            "from": "0xf22bb1c67cefce284ef9a9b86d9376feb987f72a",
            "gas": "0x3339f",
            "maxPriorityFeePerGas": "0x3b9aca00",
            "maxFeePerGas": "0x14d2a3610",
            "hash": "0x213010fcc6b225ca9a68c3829ad174ba86c5706e90703d269395af684af04919",
            "input": "0x5f029ebe584d4e0000000000000000000000000000000000000000000000000000000000",
            "nonce": "0x34e",
            "to": "0x2cc8342d7c8bff5a213eb2cde39de9a59b3461a7",
            "transactionIndex": "0x79",
            "value": "0x0",
            "type": "0x2",
            "chainId": "0x1",
            "v": "0x0",
            "r": "0x18fbb6868c96439259c428ca23d39c1e50c330b49195437f57ac26b6e520f32d",
            "s": "0x3f036bb3408f1712a6f87d4a5fe0e41b078ec72b81d61b68e885775661bc44d2"
        },
        "subscription": "0xb0fa4e43851f6d5fc4050190f664ea28"
    }
}

newPendingTransactions

Returns the transaction information for all pending transactions.

Supported on Ethereum, BNB Chain and Polygon.

Parameters

Params - A string array containing (required):

  • topic(string, required) - 'newPendingTransactions'.

Returns

  • id(integer number) - json-rpc id.
  • jsonrpc(string) - json-rpc version.
  • params(object) - An object with the following fields:
    • result(hex string) - Pending transaction hash.
    • subscription(hex string) - Subscription ID. Unique for each record.

Request

wss://eth-mainnet.blockvision.org/v1/<api-key>

> {"jsonrpc":"2.0","id": 2, "method": "eth_subscribe", "params": ["bvMinedTransactions", {"toAddress": ["0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "0xdAC17F958D2ee523a2206206994597C13D831ec7"]}]}
import { BlockVisionWebSocketProvider, BvNetwork } from 'blockvision.js'

// Optional parameters, but default to eth-mainnet and default api-key.
const bvWs = new BlockVisionWebSocketProvider(BvNetwork.ETH_MAINNET)


const callback = {
	message: (data: any) => {
		console.log(data)
	}
}
const params = {
	toAddress: ['0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', '0xdAC17F958D2ee523a2206206994597C13D831ec7']
}
// Establish a websocket connection through _bvSubscribe and subscribe to events
const ws = bvWs._bvSubscribe('bvMinedTransactions', callback, params)

Response

< {"msgType":1,"id":2,"jsonrpc":"2.0","result":"0xb0fa4e43851f6d5fc4050190f664ea28","params":{"subscription":"0xb0fa4e43851f6d5fc4050190f664ea28"}}
< {
    "msgType": 1,
    "jsonrpc": "2.0",
    "method": "eth_subscription",
    "params": {
        "result": {
            "blockHash": "0xd8cb390d1633f5adebff02bdac7c46d5690386bb4ca6c4a88c04d5a9d5c91379",
            "blockNumber": "0xef7d14",
            "from": "0xf22bb1c67cefce284ef9a9b86d9376feb987f72a",
            "gas": "0x3339f",
            "maxPriorityFeePerGas": "0x3b9aca00",
            "maxFeePerGas": "0x14d2a3610",
            "hash": "0x213010fcc6b225ca9a68c3829ad174ba86c5706e90703d269395af684af04919",
            "input": "0x5f029ebe584d4e0000000000000000000000000000000000000000000000000000000000",
            "nonce": "0x34e",
            "to": "0x2cc8342d7c8bff5a213eb2cde39de9a59b3461a7",
            "transactionIndex": "0x79",
            "value": "0x0",
            "type": "0x2",
            "chainId": "0x1",
            "v": "0x0",
            "r": "0x18fbb6868c96439259c428ca23d39c1e50c330b49195437f57ac26b6e520f32d",
            "s": "0x3f036bb3408f1712a6f87d4a5fe0e41b078ec72b81d61b68e885775661bc44d2"
        },
        "subscription": "0xb0fa4e43851f6d5fc4050190f664ea28"
    }
}

newHeads

Returns the header information for all headers of block.

Supported on Ethereum, BNB Chain and Polygon.

Parameters

Params - A string array containing (required):

  • topic(string, required) - 'bvPendingTransactions'.

Returns

  • id(integer number) - json-rpc id.
  • jsonrpc(string) - json-rpc version.
  • params(object) - An object with the following fields:
    • result(object) - An object with the following fields:
      • baseFeePerGas(hex string) - Base fee per gas.
      • difficulty(hex string) - Mining difficulty index of this block.
      • extraData(hex string) - Data included by miner in this block.
      • gasLimit(hex string) - Gas limit provided by all transactions in this block.
      • gasUsed(hex string) - Total gas used in this block.
      • hash(hex string) - Hash of the transaction.
      • logsBloom(hex string) - The data send along with the transaction.
      • miner(hex string) - The number of transactions made by the sender.
      • mixHash(hex string) - Address of the receiver.
      • nonce(hex string) - The number of transactions made by the sender.
      • number(hex string) - Block height.
      • parentHash(hex string) - The hash of the block from which this block was generated.
      • receiptsRoot(hex string) - The root of the receipts merkle tree.
      • sha3Uncles(hex string) - The RLPHASH value of uncles blocks.
      • size(hex string) - The size of the block.
      • stateRoot(hex string) - The root of the state merkle tree.
      • timestamp(hex string) - The date and time when the block was minted.
      • transactionsRoot(hex string) - The root of the transactions merkle tree.
    • subscription(hex string) - Subscription ID. Unique for each record.

Request

wss://eth-mainnet.blockvision.org/v1/<api-key>

> {"jsonrpc":"2.0","id": 2, "method": "eth_subscribe", "params": ["bvMinedTransactions", {"toAddress": ["0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "0xdAC17F958D2ee523a2206206994597C13D831ec7"]}]}
import { BlockVisionWebSocketProvider, BvNetwork } from 'blockvision.js'

// Optional parameters, but default to eth-mainnet and default api-key.
const bvWs = new BlockVisionWebSocketProvider(BvNetwork.ETH_MAINNET)


const callback = {
	message: (data: any) => {
		console.log(data)
	}
}
const params = {
	toAddress: ['0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', '0xdAC17F958D2ee523a2206206994597C13D831ec7']
}
// Establish a websocket connection through _bvSubscribe and subscribe to events
const ws = bvWs._bvSubscribe('bvMinedTransactions', callback, params)

Result

< {"msgType":1,"id":2,"jsonrpc":"2.0","result":"0xb0fa4e43851f6d5fc4050190f664ea28","params":{"subscription":"0xb0fa4e43851f6d5fc4050190f664ea28"}}
< {
    "msgType": 1,
    "jsonrpc": "2.0",
    "method": "eth_subscription",
    "params": {
        "result": {
            "blockHash": "0xd8cb390d1633f5adebff02bdac7c46d5690386bb4ca6c4a88c04d5a9d5c91379",
            "blockNumber": "0xef7d14",
            "from": "0xf22bb1c67cefce284ef9a9b86d9376feb987f72a",
            "gas": "0x3339f",
            "maxPriorityFeePerGas": "0x3b9aca00",
            "maxFeePerGas": "0x14d2a3610",
            "hash": "0x213010fcc6b225ca9a68c3829ad174ba86c5706e90703d269395af684af04919",
            "input": "0x5f029ebe584d4e0000000000000000000000000000000000000000000000000000000000",
            "nonce": "0x34e",
            "to": "0x2cc8342d7c8bff5a213eb2cde39de9a59b3461a7",
            "transactionIndex": "0x79",
            "value": "0x0",
            "type": "0x2",
            "chainId": "0x1",
            "v": "0x0",
            "r": "0x18fbb6868c96439259c428ca23d39c1e50c330b49195437f57ac26b6e520f32d",
            "s": "0x3f036bb3408f1712a6f87d4a5fe0e41b078ec72b81d61b68e885775661bc44d2"
        },
        "subscription": "0xb0fa4e43851f6d5fc4050190f664ea28"
    }
}

logs

Returns the logs informations that match a given filter.

Supported on Ethereum, BNB Chain and Polygon

Parameters

Params - A string array containing (required):

  • topic(string, required) - 'bvPendingTransactions'.
  • address(array of string, optional) - contract addresses from which the log should originate.
  • topics(array of string, optional) - list of topics that should be included in the event.

Returns

  • id(integer number) - json-rpc id.
  • jsonrpc(string) - json-rpc version.
  • params(object) - An object with the following fields:
    • result(object) - An object with the following fields:
      • address(hex string) - Address from which this log was originated.
      • topics(array of hex string) - Array consisting of 0-4 indexed log arguments, each of which is 32 Bytes in size.
      • data(hex string) - Contains one or more 32 Bytes non-indexed arguments of the log.
      • blockNumber(hex string) - The number of block where this log was in.
      • gasPrice(hex string) - Gas price of the transaction.
      • transactionHash(hex string) - Hash of the transactions this log was created from.
      • transactionIndex(hex string) - Integer of the transactions index position where this log was created from.
      • blockHash(hex string) - Hash of the block where this log was in.
      • removed(boolean) - TRUE when the log was removed, due to a chain reorganization. FALSE if it's a valid log.
    • subscription(hex string) - Subscription ID. Unique for each record.

Request

wss://eth-mainnet.blockvision.org/v1/<api-key>

> {"jsonrpc":"2.0","id": 2, "method": "eth_subscribe", "params": ["bvMinedTransactions", {"toAddress": ["0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "0xdAC17F958D2ee523a2206206994597C13D831ec7"]}]}
import { BlockVisionWebSocketProvider, BvNetwork } from 'blockvision.js'

// Optional parameters, but default to eth-mainnet and default api-key.
const bvWs = new BlockVisionWebSocketProvider(BvNetwork.ETH_MAINNET)

const callback = {
	message: (data: any) => {
		console.log(data)
	}
}
const params = {
	address: ['0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', '0xdAC17F958D2ee523a2206206994597C13D831ec7'],
	topics: []
}
// Establish a websocket connection through _bvSubscribe and subscribe to events
const ws = bvWs._bvSubscribe('logs', callback, params)

Result

< {"id":2,"jsonrpc":"2.0","result":"0x35ac61789427b440480f8fe598b75dcf","params":{"subscription":"0x35ac61789427b440480f8fe598b75dcf"}}
< {
    "jsonrpc": "2.0",
    "method": "eth_subscription",
    "params": {
        "subscription": "0x33b23c4fad4bee0fb936af26a295a234",
        "result": {
            "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "topics": [
                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                "0x0000000000000000000000005dd2da87325f9a554e978ddf496f084f6346e551",
                "0x0000000000000000000000009ca3b90e201ff68c8cc12f165928c14c1f2d65a6"
            ],
            "data": "0x0000000000000000000000000000000000000000000000000000000002024a0b",
            "blockNumber": "0xf2afa6",
            "transactionHash": "0xd12f0ec0777ffba83b88734b19248dc2cae2b03205357283038ab48c67d56e6b",
            "transactionIndex": "0xa9",
            "blockHash": "0x84fec3003637d7c2e7428fedb883555e837723ff8442de1434255398b44c4353",
            "logIndex": "0x174",
            "removed": false
        }
    }
}