Skip to content
QuantLabTickDirect

DocsProtocol

Result codes

The meaning of the enumerated values in replies, and what to do when you receive them.

Authentication results

The result in AuthenticateAck.

ValueNameMeaning and action
0AcceptedAuthentication succeeded. Send Subscribe with the subscriber token.
1InvalidCookieThe cookie has expired or belongs to another source. Start over from Hello.
2MalformedTokenThe JWT cannot be read, alg is not EdDSA, or one of iss, iat, and exp is missing.
3InvalidSignatureThe signature does not match the public key of the API key. Check that the key ID and the private key belong together.
4TokenExpiredexp has passed, iat is in the future, or exp − iat exceeds 5 minutes. Correct your clock.
5AudienceMismatchaud is not freqrelay.
6UnknownKeyThe key ID has not reached the Tick server yet. If you just issued the key, wait about a minute and retry.
7KeyRevokedThe API key was revoked by a reissue or a cancellation. Use the new key.
8KeyExpiredThe contract period has ended.
9PlanNotAcceptedThis plan cannot be used on this Tick server.
10IpLimitReachedThe plan's IP address limit has been reached.
11EndpointLimitReachedThis key has reached the number of connections allowed from this IP address (4).
12ServerFullThe Tick server has reached its subscriber limit. Retry after a while.
13RateLimitedToo many requests. Wait a few seconds and retry.
14NotReadyThe 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.

ValueNameMeaning and action
0AcceptedThe subscription was replaced with the requested set of symbols.
1UnknownSubscriberThe 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.

ValueNameMeaning
0NoneThe subscription is alive.
1UnknownThe Tick server does not know the token (the Tick server restarted, or time has passed since the subscription ended).
2HeartbeatTimeoutHeartbeat stopped for 5 seconds.
3UnsubscribedThe Tick server received an empty Subscribe.
4KeyRevokedThe API key was revoked.
5KeyExpiredThe contract period ended.
6ReplacedThe 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.

ValueNameMeaning
0DisconnectedThe connection to the LP is down.
1ConnectingThe Tick server is trying to connect to the LP.
2ConnectedThe Tick server is connected to the LP.