Messages
No examples foundNo examples found{
"e": "<string>",
"E": 123,
"T": 123,
"o": {
"s": "<string>",
"c": "<string>",
"S": "<string>",
"o": "<string>",
"f": "<string>",
"q": "<string>",
"p": "<string>",
"ap": "<string>",
"sp": "<string>",
"x": "<string>",
"X": "<string>",
"i": 123,
"l": "<string>",
"z": "<string>",
"L": "<string>",
"N": "<string>",
"n": "<string>",
"T": 123,
"t": 123,
"b": "<string>",
"a": "<string>",
"m": true,
"R": true,
"wt": "<string>",
"ot": "<string>",
"ps": "<string>",
"cp": true,
"AP": "<string>",
"cr": "<string>",
"pP": true,
"si": 123,
"ss": 123,
"V": "<string>",
"pm": "<string>",
"gtd": 123
}
}{
"e": "<string>",
"E": 123,
"T": 123,
"ac": {
"s": "<string>",
"l": 123
},
"ai": {
"j": true
}
}{
"e": "<string>",
"E": 123
}Websockets
User data
User data stream for authenticated account information. Requires listenKey from REST API.
WSS
wss://api.hypereth.io
Messages
No examples foundNo examples found{
"e": "<string>",
"E": 123,
"T": 123,
"o": {
"s": "<string>",
"c": "<string>",
"S": "<string>",
"o": "<string>",
"f": "<string>",
"q": "<string>",
"p": "<string>",
"ap": "<string>",
"sp": "<string>",
"x": "<string>",
"X": "<string>",
"i": 123,
"l": "<string>",
"z": "<string>",
"L": "<string>",
"N": "<string>",
"n": "<string>",
"T": 123,
"t": 123,
"b": "<string>",
"a": "<string>",
"m": true,
"R": true,
"wt": "<string>",
"ot": "<string>",
"ps": "<string>",
"cp": true,
"AP": "<string>",
"cr": "<string>",
"pP": true,
"si": 123,
"ss": 123,
"V": "<string>",
"pm": "<string>",
"gtd": 123
}
}{
"e": "<string>",
"E": 123,
"T": 123,
"ac": {
"s": "<string>",
"l": 123
},
"ai": {
"j": true
}
}{
"e": "<string>",
"E": 123
}Margin Call Event Message
type:object
Margin call warning received from user data stream
Balance and Position Update Event Message
type:object
Account balance and position update received from user data stream
Order Update Event Message
type:object
Order execution update received from user data stream
Account Configuration Update Event Message
type:object
Account configuration change received from user data stream
Listen Key Expired Event Message
type:object
Listen key expiration event received from user data stream
⌘I