stream.ws

WebSocket subscriptions (JSON-RPC) for the same topics and filters as /v1/stream.

Details

Endpoint: GET /ws
Credits: Free
Rate class: Light. Counts against your light requests per second.

Connect to wss://api.tide.ad/ (or /ws) with your key as api-key or x-api-key, then send transactionSubscribe, eventSubscribe, checkpointSubscribe, balanceSubscribe or objectSubscribe with params [filter, options] (options: view, fromCheckpoint, cursor, pending). The result is a subscription id; notifications arrive as <topic>Notification with subscription, cursor and result. subscriptionProgress tells you the last checkpoint fully delivered. Unsubscribe with the matching *Unsubscribe method. Close code 1012 means the server is restarting: reconnect and subscribe again with cursor set to the last cursor you got. A plain GET of this path describes the methods. Costs 1 credit per 10 delivered events.

Parameters

This method takes no parameters.

Request

Send your key in the x-api-key header, or leave it out to use the keyless tier.

curl

curl "https://api.tide.ad/ws" \
  -H "x-api-key: YOUR_API_KEY"

TypeScript

const res = await fetch("https://api.tide.ad/ws", {
  headers: {
    "x-api-key": process.env.TIDE_API_KEY!,
  },
});
const data = await res.json();

Response

No example response is available for this method yet.