Skip to main content

Address transfer monitoring — Introduction

Product overview

Introduction

Address transfer monitoring is designed for business systems that need to track on-chain transfer activity for wallet addresses. The service continuously receives and parses multi-chain transaction data, persists normalized transfer records, and exposes the results through HTTP queries and WebSocket pushes.

The goal is to let integrators monitor selected addresses without operating their own nodes or building a full transaction parsing pipeline. Integrators only need to maintain their monitored address list and keep their delivery connection available.


Core capabilities

CapabilityDescription
Multi-chain transaction monitoringUnified ingestion for EVM-compatible chains, Solana, Tron, Bitcoin, and other supported networks.
Real-time pushPushes on-chain transactions to subscribed clients through WebSocket.
Historical queryQueries historical transactions for addresses through HTTP APIs.
Address subscription managementAdds and removes monitored addresses dynamically, with business isolation based on the public API key.
Webhook notificationDelivers transaction data to an HTTP callback configured by the service side.

Supported chains

EVM-compatible chains

Chainchain_typeMainnet chain_id
Ethereumethereum1
BNB Smart Chainbsc56
Polygonpolygon137
Arbitrum Onearbitrum42161
Optimismoptimism10
Basebase8453

Non-EVM chains

Chainchain_typeMainnet chain_id
Solanasolana1
Trontron1
Bitcoinbitcoin1

chain_type is case-insensitive in requests. The service normalizes it to lowercase.


Core concepts

Chain identity: chain_type and chain_id

Each chain is identified by two fields:

  • chain_type: the chain type name, such as ethereum, solana, or tron.
  • chain_id: the chain ID used to distinguish mainnets and testnets, such as 1 for Ethereum Mainnet and 11155111 for Sepolia.

These two fields are used by every API that involves chain-specific data.

Public authentication: X-API-Key

The public APIs currently exposed by the service use the X-API-Key request header for API authentication and billing identification. Address management, transaction query, and WebSocket connections should all carry this header.

X-API-Key: your-api-key

Standard response format

Most APIs follow this JSON response structure:

{
"code": 0,
"message": "ok",
"data": {}
}
FieldTypeDescription
codeintegerBusiness status code. 0 means success.
messagestringResponse message. Successful responses usually use ok.
dataanyBusiness data. Failed responses usually return null.

Some legacy APIs use msg instead of message. Follow the specific API documentation for each endpoint.

Error response format

Failed requests return a structure similar to:

{
"code": 400,
"msg": "Invalid request",
"data": null
}

Common HTTP status codes:

StatusMeaning
400Request parameter validation failed.
401Authentication failed for the stream secret.
403No permission because the API key is invalid.
504Request timed out after 15 seconds.
500Internal service error.

Authentication

All public APIs use the X-API-Key request header. The key is used for API authentication, caller identification, and billing statistics.

Public API key (X-API-Key)

All public API requests should carry:

X-API-Key: your-api-key