WS
Kraky websocket module
KrakyWsClient
Kraken Websocket client implementation
Source code in kraky/ws.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
|
__init__(connection_env='production', logging_level='INFO')
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection_env |
str
|
Predefined environment strings (production[-auth] and beta[-auth]) will be mapped to the corresponding URLs, otherwise the string is taken as it is as target URL. https://docs.kraken.com/websockets/#connectionDetails |
'production'
|
logging_level |
str
|
Change the log level |
'INFO'
|
Source code in kraky/ws.py
16 17 18 19 20 21 22 23 24 25 26 27 28 |
|
add_order(token, pair, type, ordertype, volume, price=None, price2=None, leverage=None, reduce_only=None, oflags=None, starttm=None, expiretm=None, userref=None, validate=None, close_ordertype=None, close_price=None, close_price2=None, timeinforce=None, reqid=None, event='addOrder', connection_name='main')
async
https://docs.kraken.com/websockets/#message-addOrder
Parameters:
Name | Type | Description | Default |
---|---|---|---|
token |
str
|
Authentication token |
required |
pair |
str
|
Asset pair |
required |
type |
str
|
Type of order (buy/sell) |
required |
ordertype |
str
|
Order type: market limit (price = limit price) stop-loss (price = stop loss price) take-profit (price = take profit price) stop-loss-profit (price = stop loss price, price2 = take profit price) stop-loss-profit-limit (price = stop loss price, price2 = take profit price) stop-loss-limit (price = stop loss trigger price, price2 = triggered limit price) take-profit-limit (price = take profit trigger price, price2 = triggered limit price) trailing-stop (price = trailing stop offset) trailing-stop-limit (price = trailing stop offset, price2 = triggered limit offset) stop-loss-and-limit (price = stop loss price, price2 = limit price) settle-position |
required |
volume |
float
|
Order volume in lots |
required |
price |
Optional[float]
|
Price (optional. dependent upon ordertype) |
None
|
price2 |
Optional[float]
|
Secondary price (optional. dependent upon ordertype) |
None
|
leverage |
Optional[float]
|
Amount of leverage desired (optional. default = none) |
None
|
reduce_only |
Optional[bool]
|
Indicates that the order should only reduce an existing position (optional. default = false) |
None
|
oflags |
Optional[str]
|
Comma delimited list of order flags (optional): viqc = volume in quote currency (not available for leveraged orders) fcib = prefer fee in base currency fciq = prefer fee in quote currency nompp = no market price protection post = post only order (available when ordertype = limit) |
None
|
starttm |
Optional[str]
|
Scheduled start time (optional):
0 = now (default)
+ |
None
|
expiretm |
Optional[str]
|
Expiration time (optional):
0 = no expiration (default)
+ |
None
|
userref |
Optional[str]
|
User reference id. 32-bit signed number. (optional) |
None
|
validate |
Optional[str]
|
Validate inputs only. do not submit order (optional) |
None
|
close_ordertype |
Optional[str]
|
Order type: limit (price = limit price) stop-loss (price = stop loss price) take-profit (price = take profit price) stop-loss-profit (price = stop loss price, price2 = take profit price) stop-loss-profit-limit (price = stop loss price, price2 = take profit price) stop-loss-limit (price = stop loss trigger price, price2 = triggered limit price) take-profit-limit (price = take profit trigger price, price2 = triggered limit price) trailing-stop (price = trailing stop offset) trailing-stop-limit (price = trailing stop offset, price2 = triggered limit offset) stop-loss-and-limit (price = stop loss price, price2 = limit price) settle-position |
None
|
close_price |
Optional[float]
|
Secondary price (optional. dependent upon ordertype) |
None
|
close_price2 |
Optional[float]
|
Secondary price (optional. dependent upon ordertype) |
None
|
timeinforce |
Optional[str]
|
Time in force. (optional) GTC = Good till cancelled (default) IOC = Immediate or cancel FOK = Fill or kill |
None
|
reqid |
Optional[int]
|
Optional - client originated ID reflected in response message |
None
|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
|
cancel_all(token, reqid=None, event='cancelAll', connection_name='main')
async
https://docs.kraken.com/websockets/#message-cancelAll
Parameters:
Name | Type | Description | Default |
---|---|---|---|
token |
str
|
Authentication token |
required |
reqid |
Optional[int]
|
Optional - client originated ID reflected in response message |
None
|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 |
|
cancel_all_orders_after(token, timeout, reqid=None, event='cancelAllOrdersAfter', connection_name='main')
async
https://docs.kraken.com/websockets/#message-cancelAllOrdersAfter
Parameters:
Name | Type | Description | Default |
---|---|---|---|
token |
str
|
Authentication token |
required |
timeout |
int
|
Timeout in seconds. 0 = cancel timer (optional) |
required |
reqid |
Optional[int]
|
Optional - client originated ID reflected in response message |
None
|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
|
cancel_order(token, txid, reqid=None, event='cancelOrder', connection_name='main')
async
https://docs.kraken.com/websockets/#message-cancelOrder
Parameters:
Name | Type | Description | Default |
---|---|---|---|
token |
str
|
Authentication token |
required |
txid |
list
|
Transaction id |
required |
reqid |
Optional[int]
|
Optional - client originated ID reflected in response message |
None
|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
|
connect(handler, connection_name='main', sleep_time=5)
async
Connect to the websocket and start the handler coroutine.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
handler |
Callable
|
coroutine that will handle the incoming messages |
required |
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
sleep_time |
int
|
time to wait before retrying to connect |
5
|
Source code in kraky/ws.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
|
disconnect(connection_name='main')
async
Close the websocket connection.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
|
edit_order(token, orderid, pair, volume, price=None, price2=None, oflags=None, newuserref=None, validate=None, reqid=None, event='editOrder', connection_name='main')
async
https://docs.kraken.com/websockets/#message-editOrder
Parameters:
Name | Type | Description | Default |
---|---|---|---|
token |
str
|
Authentication token |
required |
orderid |
list
|
Order id |
required |
pair |
str
|
Asset pair |
required |
volume |
float
|
Order volume in lots |
required |
price |
Optional[float]
|
Price (optional. dependent upon ordertype) |
None
|
price2 |
Optional[float]
|
Secondary price (optional. dependent upon ordertype) |
None
|
oflags |
Optional[str]
|
Comma delimited list of order flags (optional): viqc = volume in quote currency (not available for leveraged orders) fcib = prefer fee in base currency fciq = prefer fee in quote currency nompp = no market price protection post = post only order (available when ordertype = limit) |
None
|
newuserref |
Optional[str]
|
Updated user reference id. 32-bit signed number. (optional) |
None
|
validate |
Optional[str]
|
Validate inputs only. do not submit order (optional) |
None
|
reqid |
Optional[int]
|
Optional - client originated ID reflected in response message |
None
|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
|
ping(reqid=None, connection_name='main')
async
https://docs.kraken.com/websockets/#message-ping https://docs.kraken.com/websockets/#message-pong
Parameters:
Name | Type | Description | Default |
---|---|---|---|
reqid |
Optional[int]
|
Optional - client originated ID reflected in response message |
None
|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
|
subscribe(subscription, pair=None, reqid=None, connection_name='main')
async
https://docs.kraken.com/websockets/#message-subscribe
Parameters:
Name | Type | Description | Default |
---|---|---|---|
subscription |
dict
|
Subscribe to a topic on a single or multiple currency pairs. |
required |
pair |
Optional[list]
|
Optional - Array of currency pairs. Format of each pair is "A/B", where A and B are ISO 4217-A3 for standardized assets and popular unique symbol if not standardized. |
None
|
reqid |
Optional[int]
|
Optional - client originated ID reflected in response message |
None
|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
|
unsubscribe(subscription, pair=None, reqid=None, connection_name='main')
async
https://docs.kraken.com/websockets/#message-subscribe
Parameters:
Name | Type | Description | Default |
---|---|---|---|
subscription |
dict
|
Unsubscribe from a topic on a single or multiple currency pairs. |
required |
pair |
Optional[list]
|
Optional - Array of currency pairs. Format of each pair is "A/B", where A and B are ISO 4217-A3 for standardized assets and popular unique symbol if not standardized. |
None
|
reqid |
Optional[int]
|
Optional - client originated ID reflected in response message |
None
|
connection_name |
str
|
name of the connection you want to subscribe to |
'main'
|
Source code in kraky/ws.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
|