Authentication results
The result in AuthenticateAck.
| Value | Name | Meaning and action |
|---|---|---|
| 0 | Accepted | Authentication succeeded. Send Subscribe with the subscriber token. |
| 1 | InvalidCookie | The cookie has expired or belongs to another source. Start over from Hello. |
| 2 | MalformedToken | The JWT cannot be read, alg is not EdDSA, or one of iss, iat, and exp is missing. |
| 3 | InvalidSignature | The signature does not match the public key of the API key. Check that the key ID and the private key belong together. |
| 4 | TokenExpired | exp has passed, iat is in the future, or exp − iat exceeds 5 minutes. Correct your clock. |
| 5 | AudienceMismatch | aud is not freqrelay. |
| 6 | UnknownKey | The key ID has not reached the Tick server yet. If you just issued the key, wait about a minute and retry. |
| 7 | KeyRevoked | The API key was revoked by a reissue or a cancellation. Use the new key. |
| 8 | KeyExpired | The contract period has ended. |
| 9 | PlanNotAccepted | This plan cannot be used on this Tick server. |
| 10 | IpLimitReached | The plan's IP address limit has been reached. |
| 11 | EndpointLimitReached | This key has reached the number of connections allowed from this IP address (4). |
| 12 | ServerFull | The Tick server has reached its subscriber limit. Retry after a while. |
| 13 | RateLimited | Too many requests. Wait a few seconds and retry. |
| 14 | NotReady | The Tick server is not ready yet. Retry after a while. |
MalformedToken, InvalidSignature, AudienceMismatch, KeyRevoked, KeyExpired, and PlanNotAccepted do not change on retry. Check your settings.
Subscribe results
The result in SubscribeAck.
| Value | Name | Meaning and action |
|---|---|---|
| 0 | Accepted | The subscription was replaced with the requested set of symbols. |
| 1 | UnknownSubscriber | The subscriber token cannot be used from this source. Start over from Hello. |
Why a subscription ends
The endReason in HeartbeatAck. In every case, once the cause is resolved, you can receive ticks again by starting over from Hello.
| Value | Name | Meaning |
|---|---|---|
| 0 | None | The subscription is alive. |
| 1 | Unknown | The Tick server does not know the token (the Tick server restarted, or time has passed since the subscription ended). |
| 2 | HeartbeatTimeout | Heartbeat stopped for 5 seconds. |
| 3 | Unsubscribed | The Tick server received an empty Subscribe. |
| 4 | KeyRevoked | The API key was revoked. |
| 5 | KeyExpired | The contract period ended. |
| 6 | Replaced | The same source authenticated again with another API key. |
LP connection status
The upstreamStatus in HeartbeatAck. It shows the state of the connection between the Tick server and the LP.
| Value | Name | Meaning |
|---|---|---|
| 0 | Disconnected | The connection to the LP is down. |
| 1 | Connecting | The Tick server is trying to connect to the LP. |
| 2 | Connected | The Tick server is connected to the LP. |