forked from leelilyfutunn/futuquant
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquote_query.py
More file actions
executable file
·1335 lines (1075 loc) · 48.4 KB
/
Copy pathquote_query.py
File metadata and controls
executable file
·1335 lines (1075 loc) · 48.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""
Quote query
"""
import sys
import json
from datetime import datetime
from datetime import timedelta
from .utils import is_str
from .constant import *
def check_date_str_format(s):
"""Check the format of date string"""
try:
_ = datetime.strptime(s, "%Y-%m-%d")
return RET_OK, None
except ValueError:
err = sys.exc_info()[1]
error_str = ERROR_STR_PREFIX + str(err)
return RET_ERROR, error_str
def extract_pls_rsp(rsp_str):
"""extract the response of PLS"""
try:
rsp = json.loads(rsp_str)
except ValueError:
err = sys.exc_info()[1]
err_str = ERROR_STR_PREFIX + str(err)
return RET_ERROR, err_str, None
error_code = int(rsp['ErrCode'])
if error_code != 0:
error_str = ERROR_STR_PREFIX + str(error_code) + ' ' + rsp['ErrDesc']
return RET_ERROR, error_str, None
if 'RetData' not in rsp:
error_str = ERROR_STR_PREFIX + 'No ret data found in client rsp. Response: %s' % rsp
return RET_ERROR, error_str, None
return RET_OK, "", rsp
def normalize_date_format(date_str):
"""normalize the format of data"""
date_obj = datetime.strptime(date_str, "%Y-%m-%d")
ret = date_obj.strftime("%Y-%m-%d")
return ret
def split_stock_str(stock_str):
"""split the stock string"""
if is_str(stock_str) is False:
error_str = ERROR_STR_PREFIX + "value of stock_str is %s of type %s, and type %s is expected" \
% (stock_str, type(stock_str), str(str))
return RET_ERROR, error_str
split_loc = stock_str.find(".")
'''do not use the built-in split function in python.
The built-in function cannot handle some stock strings correctly.
for instance, US..DJI, where the dot . itself is a part of original code'''
if 0 <= split_loc < len(stock_str) - 1 and stock_str[0:split_loc] in MKT_MAP:
market_str = stock_str[0:split_loc]
market_code = MKT_MAP[market_str]
partial_stock_str = stock_str[split_loc + 1:]
return RET_OK, (market_code, partial_stock_str)
else:
error_str = ERROR_STR_PREFIX + "format of %s is wrong. (US.AAPL, HK.00700, SZ.000001)" % stock_str
return RET_ERROR, error_str
def merge_stock_str(market, partial_stock_str):
"""
Merge the string of stocks
:param market: market code
:param partial_stock_str: original stock code string. i.e. "AAPL","00700", "000001"
:return: unified representation of a stock code. i.e. "US.AAPL", "HK.00700", "SZ.000001"
"""
if (market not in MKT_MAP) and (market not in QUOTE.REV_MKT_MAP):
return ""
market_str = QUOTE.REV_MKT_MAP[market]
stock_str = '.'.join([market_str, partial_stock_str])
return stock_str
def str2binary(s):
"""
Transfer string to binary
:param s: string content to be transformed to binary
:return: binary
"""
return s.encode('utf-8')
def binary2str(b):
"""
Transfer binary to string
:param b: binary content to be transformed to string
:return: string
"""
return b.decode('utf-8')
class TradeDayQuery:
"""
Query Conversion for getting trading days.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, market, start_date=None, end_date=None):
"""
Convert from user request for trading days to PLS request
:param market:
:param start_date:
:param end_date:
:return: json string for request
Example:
ret,msg,content = TradeDayQuery.pack_req("US", "2017-01-01", "2017-01-18")
ret: 0
msg: ""
content:
'{"Protocol": "1013", "Version": "1", "ReqParam": {"end_date": "2017-01-18",
"Market": "2", "start_date": "2017-01-01"}}\r\n'
"""
# '''Parameter check'''
if market not in MKT_MAP:
error_str = ERROR_STR_PREFIX + " market is %s, which is not valid. (%s)" \
% (market, ",".join([x for x in MKT_MAP]))
return RET_ERROR, error_str, None
if start_date is None:
today = datetime.today()
start = today - timedelta(days=365)
start_date = start.strftime("%Y-%m-%d")
else:
ret, msg = check_date_str_format(start_date)
if ret != RET_OK:
return ret, msg, None
start_date = normalize_date_format(start_date)
if end_date is None:
today = datetime.today()
end_date = today.strftime("%Y-%m-%d")
else:
ret, msg = check_date_str_format(end_date)
if ret != RET_OK:
return ret, msg, None
end_date = normalize_date_format(end_date)
# pack to json
mkt_str = str(MKT_MAP[market])
req = {"Protocol": "1013",
"Version": "1",
"ReqParam": {"Market": mkt_str,
"start_date": start_date,
"end_date": end_date
}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""
Convert from PLS response to user response
:return: trading day list
Example:
rsp_str : '{"ErrCode":"0","ErrDesc":"","Protocol":"1013","RetData":{"Market":"2",
"TradeDateArr":["2017-01-17","2017-01-13","2017-01-12","2017-01-11",
"2017-01-10","2017-01-09","2017-01-06","2017-01-05","2017-01-04",
"2017-01-03"],"end_date":"2017-01-18","start_date":"2017-01-01"},"Version":"1"}\n\r\n\r\n'
ret,msg,content = TradeDayQuery.unpack_rsp(rsp_str)
ret : 0
msg : ""
content : ['2017-01-17',
'2017-01-13',
'2017-01-12',
'2017-01-11',
'2017-01-10',
'2017-01-09',
'2017-01-06',
'2017-01-05',
'2017-01-04',
'2017-01-03']
"""
# response check and unpack response json to objects
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if 'TradeDateArr' not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find TradeDateArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
raw_trading_day_list = rsp_data['TradeDateArr']
if raw_trading_day_list is None or len(raw_trading_day_list) == 0:
return RET_OK, "", []
# convert to list format that we use
trading_day_list = [normalize_date_format(x) for x in raw_trading_day_list]
return RET_OK, "", trading_day_list
class StockBasicInfoQuery:
"""
Query Conversion for getting stock basic information.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, market, stock_type='STOCK'):
"""
Convert from user request for trading days to PLS request
:param market:
:param stock_type:
:return: json string for request
Example:
ret,msg,content = StockBasicInfoQuery.pack_req("HK_FUTURE","IDX")
ret : 0
msg : ""
content : '{"Protocol": "1014", "Version": "1", "ReqParam": {"Market": "6", "StockType": "6"}}\r\n'
"""
if market not in MKT_MAP:
error_str = ERROR_STR_PREFIX + " market is %s, which is not valid. (%s)" \
% (market, ",".join([x for x in MKT_MAP]))
return RET_ERROR, error_str, None
if stock_type not in SEC_TYPE_MAP:
error_str = ERROR_STR_PREFIX + " stock_type is %s, which is not valid. (%s)" \
% (stock_type, ",".join([x for x in SEC_TYPE_MAP]))
return RET_ERROR, error_str, None
req = {"Protocol": "1014",
"Version": "1",
"ReqParam": {"Market": str(MKT_MAP[market]),
"StockType": str(SEC_TYPE_MAP[stock_type]),
}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""
Convert from PLS response to user response
:return: json string for request
Example:
rsp_str : '{"ErrCode":"0","ErrDesc":"","Protocol":"1014",
"RetData":{"BasicInfoArr":
[{"LotSize":"0","Name":"恒指当月期货","StockCode":"999010","StockID":"999010","StockType":"6"},
{"LotSize":"0","Name":"恒指下月期货","StockCode":"999011","StockID":"999011","StockType":"6"}],
"Market":"6"},"Version":"1"}\n\r\n\r\n'
ret,msg,content = StockBasicInfoQuery.unpack_rsp(rsp_str)
ret : 0
msg : ""
content : [{'code': 'HK_FUTURE.999010',
'lot_size': 0,
'name': '恒指当月期货',
'stock_type': 'IDX'},
{'code': 'HK_FUTURE.999011',
'lot_size': 0,
'name': '恒指下月期货',
'stock_type': 'IDX'}]
"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if 'BasicInfoArr' not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find BasicInfoArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
raw_basic_info_list = rsp_data["BasicInfoArr"]
market = rsp_data["Market"]
if raw_basic_info_list is None or len(raw_basic_info_list) == 0:
return RET_OK, "", []
basic_info_list = [{"code": merge_stock_str(int(market), record['StockCode']),
"stockid": record['StockID'],
"name": record["StockName"],
"lot_size": int(record["LotSize"]),
"stock_type": QUOTE.REV_SEC_TYPE_MAP[int(record["StockType"])],
"stock_child_type": (QUOTE.REV_WRT_TYPE_MAP[int(record["StockChildType"])] if
int(record["StockType"]) == 5 else 0),
"owner_stock_code": (merge_stock_str(int(record["OwnerMarketType"]),
record["OwnerStockCode"])
if int(record["StockType"]) == 5 else 0),
"listing_date": record["ListTime"]
}
for record in raw_basic_info_list]
return RET_OK, "", basic_info_list
class MarketSnapshotQuery:
"""
Query Conversion for getting market snapshot.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, stock_list):
"""Convert from user request for trading days to PLS request"""
stock_tuple_list = []
failure_tuple_list = []
for stock_str in stock_list:
ret_code, content = split_stock_str(stock_str)
if ret_code != RET_OK:
msg = content
error_str = ERROR_STR_PREFIX + msg
failure_tuple_list.append((ret_code, error_str))
continue
market_code, stock_code = content
stock_tuple_list.append((str(market_code), stock_code))
if len(failure_tuple_list) > 0:
error_str = '\n'.join([x[1] for x in failure_tuple_list])
return RET_ERROR, error_str, None
req = {"Protocol": "1015",
"Version": "1",
"ReqParam": {"StockArr": [{'Market': stock[0], 'StockCode': stock[1]} for stock in stock_tuple_list]}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""Convert from PLS response to user response"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if "SnapshotArr" not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find SnapshotArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
raw_snapshot_list = rsp_data["SnapshotArr"]
if raw_snapshot_list is None or len(raw_snapshot_list) == 0:
return RET_OK, "", []
def futu_timestamp_to_str(int_value):
if int_value == 0:
return '1970-01-01'
else: # for py3.6, fromtimestamp(value), value >= 86400
return datetime.fromtimestamp(int_value).strftime("%Y-%m-%d")
snapshot_list = [{'code': merge_stock_str(int(record['MarketType']), record['StockCode']),
'update_time': str(record['UpdateTimeStr']),
'last_price': float(record['NominalPrice']) / 1000,
'open_price': float(record['OpenPrice']) / 1000,
'high_price': float(record['HighestPrice']) / 1000,
'low_price': float(record['LowestPrice']) / 1000,
'prev_close_price': float(record['LastClose']) / 1000,
'volume': record['Volume'],
'turnover': float(record['Turnover']) / 1000,
'turnover_rate': float(record['TurnoverRate']) / 1000,
'suspension': True if int(record['SuspendFlag']) == 1 else False,
'listing_date': futu_timestamp_to_str(int(record['ListingDate'])),
'circular_market_val': float(record['CircularMarketVal']) / 1000,
'total_market_val': float(record['TotalMarketVal']) / 1000,
'wrt_valid': True if int(record['Wrt_Valid']) == 1 else False,
'wrt_conversion_ratio': float(record['Wrt_ConversionRatio']) / 1000,
'wrt_type': QUOTE.REV_WRT_TYPE_MAP[int(record['Wrt_Type'])]
if int(record['Wrt_Valid']) == 1 else 0,
'wrt_strike_price': float(record['Wrt_StrikePrice']) / 1000,
'wrt_maturity_date': str(record['Wrt_MaturityDateStr']),
'wrt_end_trade': str(record['Wrt_EndTradeDateStr']),
'wrt_code': merge_stock_str(int(record['Wrt_OwnerMarketType']), record['Wrt_OwnerStockCode']),
'wrt_recovery_price': float(record['Wrt_RecoveryPrice']) / 1000,
'wrt_street_vol': float(record['Wrt_StreetVol']) / 1000,
'wrt_issue_vol': float(record['Wrt_IssueVol']) / 1000,
'wrt_street_ratio': float(record['Wrt_StreetRatio']) / 100000,
'wrt_delta': float(record['Wrt_Delta']) / 1000,
'wrt_implied_volatility': float(record['Wrt_ImpliedVolatility']) / 1000,
'wrt_premium': float(record['Wrt_Premium']) / 1000,
'lot_size': int(record['LotSize'])
} for record in raw_snapshot_list]
return RET_OK, "", snapshot_list
class RtDataQuery:
"""
Query Conversion for getting stock real-time data.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, stock_str):
"""Convert from user request for trading days to PLS request"""
ret, content = split_stock_str(stock_str)
if ret == RET_ERROR:
error_str = content
return RET_ERROR, error_str, None
market_code, stock_code = content
req = {"Protocol": "1010",
"Version": "1",
"ReqParam": {'Market': str(market_code), 'StockCode': stock_code}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""Convert from PLS response to user response"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if "RTDataArr" not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find RTDataArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
rt_data_list = rsp_data["RTDataArr"]
if rt_data_list is None or len(rt_data_list) == 0:
return RET_OK, "", []
stock_code = merge_stock_str(int(rsp_data['Market']), rsp_data['StockCode'])
rt_list = [{"time": record['Time'],
"code": stock_code,
"data_status": True if int(record['DataStatus']) == 1 else False,
"opened_mins": record['OpenedMins'],
"cur_price": float(record['CurPrice']) / 1000,
"last_close": float(record['LastClose']) / 1000,
"avg_price": float(record['AvgPrice']) / 1000,
"turnover": float(record['Turnover']) / 1000,
"volume": record['Volume']
} for record in rt_data_list]
return RET_OK, "", rt_list
class SubplateQuery:
"""
Query Conversion for getting sub-plate stock list.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, market, plate_class):
"""Convert from user request for trading days to PLS request"""
if market not in MKT_MAP:
error_str = ERROR_STR_PREFIX + "market is %s, which is not valid. (%s)" \
% (market, ",".join([x for x in MKT_MAP]))
return RET_ERROR, error_str, None
if plate_class not in PLATE_CLASS_MAP:
error_str = ERROR_STR_PREFIX + "the class of plate is %s, which is not valid. (%s)" \
% (plate_class, ",".join([x for x in MKT_MAP]))
return RET_ERROR, error_str, None
req = {"Protocol": "1026",
"Version": "1",
"ReqParam": {"Market": str(MKT_MAP[market]),
"PlateClass": str(PLATE_CLASS_MAP[plate_class])}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""Convert from PLS response to user response"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if "PlatesetIDsArr" not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find PlatesetIDsArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
raw_plate_list = rsp_data["PlatesetIDsArr"]
if raw_plate_list is None or len(raw_plate_list) == 0:
return RET_OK, "", []
plate_list = [{"code": merge_stock_str(int(record['Market']), record['StockCode']),
"plate_name": record['StockName'],
"plate_id": record['StockID']
} for record in raw_plate_list]
return RET_OK, "", plate_list
class PlateStockQuery:
"""
Query Conversion for getting all the stock list of a given plate.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, plate_code):
"""Convert from user request for trading days to PLS request"""
ret_code, content = split_stock_str(plate_code)
if ret_code != RET_OK:
msg = content
error_str = ERROR_STR_PREFIX + msg
return RET_ERROR, error_str, None
market, stock_code = content
if market not in QUOTE.REV_MKT_MAP:
error_str = ERROR_STR_PREFIX + "market is %s, which is not valid. (%s)" \
% (market, ",".join([x for x in MKT_MAP]))
return RET_ERROR, error_str, None
req = {"Protocol": "1027",
"Version": "1",
"ReqParam": {"Market": str(market),
"StockCode": str(stock_code)}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""Convert from PLS response to user response"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if "PlateSubIDsArr" not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find PlateSubIDsArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
if rsp_data["PlateSubIDsArr"] is None or len(rsp_data["PlateSubIDsArr"]) == 0:
return RET_OK, "", []
raw_stock_list = rsp_data["PlateSubIDsArr"]
stock_list = [{"lot_size": int(record['LotSize']),
"code": merge_stock_str(int(record['Market']), record['StockCode']),
"stock_name": record['StockName'],
"owner_market": merge_stock_str(int(record['OwnerMarketType']), record['OwnerStockCode']),
"stock_child_type": (str(QUOTE.REV_WRT_TYPE_MAP['StockChildType'])
if int(record['StockType']) == 5 else 0),
"stock_type": QUOTE.REV_SEC_TYPE_MAP[int(record['StockType'])]
} for record in raw_stock_list]
return RET_OK, "", stock_list
class BrokerQueueQuery:
"""
Query Conversion for getting broker queue information.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, stock_str):
"""Convert from user request for trading days to PLS request"""
ret_code, content = split_stock_str(stock_str)
if ret_code == RET_ERROR:
error_str = content
return RET_ERROR, error_str, None
market_code, stock_code = content
req = {"Protocol": "1028",
"Version": "1",
"ReqParam": {"Market": str(market_code),
"StockCode": stock_code}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""Convert from PLS response to user response"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if "BrokerBidArr" not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find BrokerBidArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
if "BrokerAskArr" not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find BrokerAskArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
raw_broker_bid = rsp_data["BrokerBidArr"]
bid_list = [{"bid_broker_id": record['BrokerID'],
"bid_broker_name": record['BrokerName'],
"bid_broker_pos": record['BrokerPos'],
"code": merge_stock_str(int(rsp_data['Market']), rsp_data['StockCode'])
} for record in raw_broker_bid]
raw_broker_ask = rsp_data["BrokerAskArr"]
ask_list = [{"ask_broker_id": record['BrokerID'],
"ask_broker_name": record['BrokerName'],
"ask_broker_pos": record['BrokerPos'],
"code": merge_stock_str(int(rsp_data['Market']), rsp_data['StockCode'])
} for record in raw_broker_ask]
return RET_OK, bid_list, ask_list
class HistoryKlineQuery:
"""
Query Conversion for getting historic Kline data.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, stock_str, start_date=None, end_date=None, ktype='K_DAY', autype='qfq'):
"""Convert from user request for trading days to PLS request"""
ret, content = split_stock_str(stock_str)
if ret == RET_ERROR:
error_str = content
return RET_ERROR, error_str, None
market_code, stock_code = content
# check date format
if start_date is None:
start_date = datetime.now().strftime('%Y-%m-%d')
else:
ret, msg = check_date_str_format(start_date)
if ret != RET_OK:
return ret, msg, None
start_date = normalize_date_format(start_date)
if end_date is None:
end_date = datetime.now().strftime('%Y-%m-%d')
else:
ret, msg = check_date_str_format(end_date)
if ret != RET_OK:
return ret, msg, None
end_date = normalize_date_format(end_date)
# check k line type
if ktype not in KTYPE_MAP:
error_str = ERROR_STR_PREFIX + "ktype is %s, which is not valid. (%s)" \
% (ktype, ", ".join([x for x in KTYPE_MAP]))
return RET_ERROR, error_str, None
if autype not in AUTYPE_MAP:
error_str = ERROR_STR_PREFIX + "autype is %s, which is not valid. (%s)" \
% (autype, ", ".join([str(x) for x in AUTYPE_MAP]))
return RET_ERROR, error_str, None
req = {"Protocol": "1024",
"Version": "1",
"ReqParam": {'Market': str(market_code),
'StockCode': stock_code,
'start_date': start_date,
'end_date': end_date,
'KLType': str(KTYPE_MAP[ktype]),
'RehabType': str(AUTYPE_MAP[autype])
}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""Convert from PLS response to user response"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if "HistoryKLArr" not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find HistoryKLArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
if rsp_data["HistoryKLArr"] is None or len(rsp_data["HistoryKLArr"]) == 0:
return RET_OK, "", []
raw_kline_list = rsp_data["HistoryKLArr"]
price_base = 10 ** 9
stock_code = merge_stock_str(int(rsp_data['Market']), rsp_data['StockCode'])
kline_list = [{"code": stock_code,
"time_key": record['Time'],
"open": float(record['Open']) / price_base,
"high": float(record['High']) / price_base,
"low": float(record['Low']) / price_base,
"close": float(record['Close']) / price_base,
"volume": record['Volume'],
"turnover": float(record['Turnover']) / 1000
}
for record in raw_kline_list]
return RET_OK, "", kline_list
class ExrightQuery:
"""
Query Conversion for getting exclude-right information of stock.
"""
def __init__(self):
pass
@classmethod
def pack_req(cls, stock_list):
"""Convert from user request for trading days to PLS request"""
stock_tuple_list = []
failure_tuple_list = []
for stock_str in stock_list:
ret_code, content = split_stock_str(stock_str)
if ret_code != RET_OK:
msg = content
error_str = ERROR_STR_PREFIX + msg
failure_tuple_list.append((ret_code, error_str))
continue
market_code, stock_code = content
stock_tuple_list.append((str(market_code), stock_code))
if len(failure_tuple_list) > 0:
error_str = '\n'.join([x[1] for x in failure_tuple_list])
return RET_ERROR, error_str, None
req = {"Protocol": "1025",
"Version": "1",
"ReqParam": {'StockArr': [{'Market': stock[0], 'StockCode': stock[1]} for stock in stock_tuple_list]}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_rsp(cls, rsp_str):
"""Convert from PLS response to user response"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if "ExRightInfoArr" not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find ExRightInfoArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
if rsp_data["ExRightInfoArr"] is None or len(rsp_data["ExRightInfoArr"]) == 0:
return RET_OK, "", []
get_val = (lambda x, y: float(y[x]) / 100000 if x in y else 0)
raw_exr_list = rsp_data["ExRightInfoArr"]
exr_list = [{'code': merge_stock_str(int(record['Market']), record['StockCode']),
'ex_div_date': record['ExDivDate'],
'split_ratio': get_val('SplitRatio', record),
'per_cash_div': get_val('PerCashDiv', record),
'per_share_div_ratio': get_val('PerShareDivRatio', record),
'per_share_trans_ratio': get_val('PerShareTransRatio', record),
'allotment_ratio': get_val(r'AllotmentRatio', record),
'allotment_price': get_val('AllotmentPrice', record),
'stk_spo_ratio': get_val('StkSpoRatio', record),
'stk_spo_price': get_val('StkSpoPrice', record),
'forward_adj_factorA': get_val('ForwardAdjFactorA', record),
'forward_adj_factorB': get_val('ForwardAdjFactorB', record),
'backward_adj_factorA': get_val('BackwardAdjFactorA', record),
'backward_adj_factorB': get_val('BackwarAdjFactorB', record)
}
for record in raw_exr_list]
return RET_OK, "", exr_list
class SubscriptionQuery:
"""
Query Conversion for getting user's subscription information.
"""
def __init__(self):
pass
@classmethod
def pack_subscribe_req(cls, stock_str, data_type):
"""
Pack subscribe user's request
:param stock_str:
:param data_type:
:return:
"""
ret, content = split_stock_str(stock_str)
if ret == RET_ERROR:
error_str = content
return RET_ERROR, error_str, None
market_code, stock_code = content
if data_type not in SUBTYPE_MAP:
subtype_str = ','.join([x for x in SUBTYPE_MAP])
error_str = ERROR_STR_PREFIX + 'data_type is %s , which is wrong. (%s)' % (data_type, subtype_str)
return RET_ERROR, error_str, None
subtype = SUBTYPE_MAP[data_type]
req = {"Protocol": "1005",
"Version": "1",
"ReqParam": {"Market": str(market_code),
"StockCode": stock_code,
"StockSubType": str(subtype)
}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_subscribe_rsp(cls, rsp_str):
"""Unpack the subscribed response"""
ret, msg, content = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
return RET_OK, "", None
@classmethod
def pack_unsubscribe_req(cls, stock_str, data_type):
"""Pack the un-subscribed request"""
ret, content = split_stock_str(stock_str)
if ret == RET_ERROR:
error_str = content
return RET_ERROR, error_str, None
market_code, stock_code = content
if data_type not in SUBTYPE_MAP:
subtype_str = ','.join([x for x in SUBTYPE_MAP])
error_str = ERROR_STR_PREFIX + 'data_type is %s, which is wrong. (%s)' % (data_type, subtype_str)
return RET_ERROR, error_str, None
subtype = SUBTYPE_MAP[data_type]
req = {"Protocol": "1006",
"Version": "1",
"ReqParam": {"Market": str(market_code),
"StockCode": stock_code,
"StockSubType": str(subtype)
}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_unsubscribe_rsp(cls, rsp_str):
"""Unpack the un-subscribed response"""
ret, msg, content = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
return RET_OK, "", None
@classmethod
def pack_subscription_query_req(cls, query):
"""Pack the subscribed query request"""
req = {"Protocol": "1007",
"Version": "1",
"ReqParam": {"QueryAllSocket": str(query)}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def unpack_subscription_query_rsp(cls, rsp_str):
"""Unpack the subscribed query response"""
ret, msg, rsp = extract_pls_rsp(rsp_str)
if ret != RET_OK:
return RET_ERROR, msg, None
rsp_data = rsp['RetData']
if 'SubInfoArr' not in rsp_data:
error_str = ERROR_STR_PREFIX + "cannot find TradeDateArr in client rsp. Response: %s" % rsp_str
return RET_ERROR, error_str, None
subscription_table = {}
raw_subscription_list = rsp_data['SubInfoArr']
if raw_subscription_list is None or len(raw_subscription_list) == 0:
return RET_OK, "", subscription_table
subscription_list = [(merge_stock_str(int(x['Market']), x['StockCode']),
QUOTE.REV_SUBTYPE_MAP[int(x['StockSubType'])])
for x in raw_subscription_list]
for stock_code_str, sub_type in subscription_list:
if sub_type not in subscription_table:
subscription_table[sub_type] = []
subscription_table[sub_type].append(stock_code_str)
return RET_OK, "", subscription_table
@classmethod
def pack_push_req(cls, stock_str, data_type):
"""Pack the pushed response"""
ret, content = split_stock_str(stock_str)
if ret == RET_ERROR:
error_str = content
return RET_ERROR, error_str, None
market_code, stock_code = content
if data_type not in SUBTYPE_MAP:
subtype_str = ','.join([x for x in SUBTYPE_MAP])
error_str = ERROR_STR_PREFIX + 'data_type is %s , which is wrong. (%s)' % (data_type, subtype_str)
return RET_ERROR, error_str, None
subtype = SUBTYPE_MAP[data_type]
req = {"Protocol": "1008",
"Version": "1",
"ReqParam": {"Market": str(market_code),
"StockCode": stock_code,
"StockPushType": str(subtype)
}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
@classmethod
def pack_unpush_req(cls, stock_str, data_type):
"""Pack the un-pushed request"""
ret, content = split_stock_str(stock_str)
if ret == RET_ERROR:
error_str = content
return RET_ERROR, error_str, None
market_code, stock_code = content
if data_type not in SUBTYPE_MAP:
subtype_str = ','.join([x for x in SUBTYPE_MAP])
error_str = ERROR_STR_PREFIX + 'data_type is %s , which is wrong. (%s)' % (data_type, subtype_str)
return RET_ERROR, error_str, None
subtype = SUBTYPE_MAP[data_type]
req = {"Protocol": "1008",
"Version": "1",
"ReqParam": {"Market": str(market_code),
"StockCode": stock_code,
"StockPushType": str(subtype),
"UnPush": str(int(True))
}
}
req_str = json.dumps(req) + '\r\n'
return RET_OK, "", req_str
class StockQuoteQuery:
"""
Query Conversion for getting stock quote data.
"""
def __init__(self):
pass