End-to-end guide for authenticating GraphQL subscriptions with the GoldRush Streaming API.
Note: The API key must be provided asGOLDRUSH_API_KEY
within theconnectionParams
object.
websocat
for Manual WebSocket TestingStep 1: Initiate the WebSocket Connection
Step 2: Send the Connection Initialization Payload
<YOUR_API_KEY>
with your actual API key:connection_ack
response from the server before proceeding.Step 3: Submit a Subscription Query
MISSING_TOKEN
: No API key was provided in the connection_init
payload.INVALID_TOKEN
: The provided API key is malformed or invalid.AUTH_SYSTEM_ERROR
: An internal server error occurred during authentication.connection_ack
response, even if the API key is invalid. Authentication errors are only reported when a subscription is initiated.payload
of the connection_init
message with the key GOLDRUSH_API_KEY
.cqt_wF[26 base58 chars]
or cqt_rQ[26 base58 chars]