Bidirectional stream for managing transfer subscriptions and receiving matching transfer notifications. Authentication uses the `API-Key` header during the WebSocket handshake.
Create a new filter to receive matching transfers in real time. Filters must include at least one of `from`, `to`, `tokens`, `base`, or `usdGte >= 10,000,000`.
Content-Type:
unsubscribe
Remove an existing filter by its server-assigned filter ID.
Content-Type:
reconnect
Restore a previous WebSocket session within five minutes of disconnection using its session ID.
Content-Type:
transfer
A matching blockchain transfer for an active filter.
Content-Type:
ack
Acknowledgment for a successful client operation (subscribe, unsubscribe, reconnect).
Content-Type:
error
Error notification, including rate-limit and authentication errors.
Content-Type:
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.