Authentication
Last updated
Last updated
You must authenticate yourself when subscribing to any of the sFOX WebSocket feeds.
All WebSocket feeds require authentication.
Authentication commands should be JSON with the following properties:
Property | Type | Command |
---|---|---|
To authenticate yourself to the WebSocket API, you must send an authenticate
message to the server with an API key for your account. This message is mandatory as all WebSocket feeds require authentication.
Once a authenticate
message is received the server responds with an authenticate
message that specifies whether authentication succeeded or failed.
type
string
"authenticate"
apiKey
string
"<YOUR-API-KEY>"