Events

WebSocket connection for events

Establishes a WebSocket connection to receive real-time events for the specified cryptocurrency. (Check Query Event Stream for the data format)

get/v1/cryptos/connect

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP basic
TypeScript
https://skmtc.dev/btcpayserver/apis/nbxplorer-api/docs/v1/cryptos/connect/get.ts
A function with typed inputs. Its response is checked against the schema.

cryptoCodestring

Filter event for this cryptoCode. If unspecified or *, all events will be published to this websocket.

Jan 6, 20255ff4bcf62192 Revision changes
- info
  endpoint added
Nov 18, 2024b5092f204599 Revision changes
- breaking
  api path removed without deprecation