Login Request
The Bitnomial trading system requires a Connection to be provisioned
in order to login. To provision a connection, visit the
customer portal. ConnectionID
s are provided in a hex-encoded
byte string that must be converted into a single uint64. AuthToken
s are provided as hex-encoded
byte strings.
A connection can simultaneously connect to a single order entry gateway and pricefeed instance but
cannot connect to another order entry gateway or pricefeed at the same time.
Byte Offset |
Byte Length |
Type |
Name |
Description |
0 |
1 |
char |
messageType |
Always L |
1 |
8 |
uint64 |
connectionId |
Connection ID |
9 |
32 |
byte[] |
authToken |
Shared secret |
41 |
1 |
uint8 |
heartbeatInterval |
Heartbeat interval in seconds |
42 |
|
|
|
|
Login Heartbeat Interval
If the heartbeat interval is less than or equal to 5 seconds, a default value of 30 seconds will be used instead.
Logout Request
Byte Offset |
Byte Length |
Type |
Name |
Description |
0 |
1 |
char |
messageType |
Always K |
1 |
1 |
char |
persistOrders |
Cancel-on-disconnect is default (unused, reserved) |
2 |
|
|
|
|
Login/out Reply
Login/out Ack
Byte Offset |
Byte Length |
Type |
Name |
Description |
0 |
1 |
char |
messageType |
Always A |
1 |
|
|
|
|
Login/out Reject
Byte Offset |
Byte Length |
Type |
Name |
Description |
0 |
1 |
char |
messageType |
Always R |
1 |
1 |
uint8 |
rejectReason |
See Login/out Reject Reason |
2 |
|
|
|
|
Login/out Reject Reason
Value |
Reason |
0x01 |
No request received, didn’t receive a login within 1 s |
0x02 |
Unauthorized |
0x03 |
Already logged in |
0x04 |
Bad protocol version |