get_stream_connection
Get WSS setup for continuous live trades instead of polling get_recent_trades.
Requires a Bearer key with an active eligible data grant/budget; 402 means
access is unavailable. Returns url, an Authorization header template,
first_message JSON and cursor-resume instructions. This lookup consumes no
data credits and opens no background connection. Your runtime must connect
and insert its own key; all keys share one concurrent WSS connection per account.
Delivered events consume data credits/budget under the plan. Persist the last
cursor to resume; an expired cursor requires a fresh snapshot and gap handling.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | WSS endpoint to open in the caller runtime. | |
| resume | Yes | How to resume with the last received cursor. An expired cursor requires a fresh snapshot. | |
| first_message | Yes | Initial JSON subscription message. Customize filters.mints/wallets and filters.after as documented. | |
| authentication | Yes | Handshake header template. Supply your own API key; the response never echoes the secret. |