Error Handling

You may recieve an error message from us if there is something wrong with your request or if something unexpected happens during streaming such as exceeded limits, buffer overflow, missed ping messages, or if the node is going away.

In some cases, your websocket connection will be closed by us after sending an error message.

Error messages have a general structure and may or may not contain traceId depending on who initiated them:

{
  "traceId":"8y64fs9",
  "type":"error-bad-request",
  "payload": {
    "message": "The number of transferBytes has exceeded. Limit: ${tier.maxTransferBytes}."
  }
}

Errors

Error Type	Description
`error-bad-request`	Subscription request has wrong format. Please correct your request according to docs and examples.
`error-buffer-overflow`	The messages queue is overflowing. Try to increase consumption speed or split subscriptions across multiple websocket connections.
`error-forbidden`	User subscription to the requested resource is denied. You may need to modify your subscription request.
`error-generic`	Internal server error. Please reconnect or try again later.
`error-going-away`	Server node is going away. Please reconnect as soon as possible, you have only one minute to reconnect properly. After this time connections will be terminated.
`error-ping-pong`	Client did not reply to server ping during 3 times. Check the stability of the connection and make sure your client is responding to ping requests according to the websocket protocol.
`error-too-many-requests`	User has run out of allowed subscriptions per one connection or exceeded tier limits.