Skip to navigation

Access and keys

View as Markdown

Before writing a client, obtain a WSS endpoint, API key, allowed owners or market scopes, operating limits and replay policy through your agreed operator channel. A Polygon RPC key is not a Whalehunt API key.

Permissions

The key authenticates an account. Scopes determine its available data; filters narrow that scope.

ModeRequirement
Owner allowlistEvery requested owners address is allowed for the account
Market filteredmarket_data scope and at least one entity selector
Full streamExplicit firehose scope; market access does not imply it
Replay and stagesThese permissions are checked independently

Multiple keys share account quotas. See filters for selector semantics.

Sending the key

After hello, send authenticate with the key in the JSON ticket field over WSS. Keep it out of URLs, Git, screenshots and logs. Store checkpoint tokens securely too. A token is a resume boundary, not authorization: reconnect requires fresh authentication.

Revoking a key or reducing scopes is not overridden by an old cursor. Do not replace a rejected narrow subscription with the full stream. Confirm the allowed scope and explicitly update the client configuration.

Key issuance, replacement and support use the operator procedure agreed for your integration. This documentation does not assume a registration portal or rotation API.

Continue with your first session.