Models
Các model dữ liệu và hằng số trong Python SDK 3.3.2
Trang này liệt kê các model dữ liệu của SDK (tên trang utilities là tên cũ; nội dung là Models). Tất cả model import từ ssi_sdk.models:
from ssi_sdk.models import Account, OHLCData, PlaceOrderResponse, TradeMessageMọi model đều là dataclass; trường kiểu X | str | None nghĩa là SDK trả member enum khi nhận ra giá trị, trả chuỗi gốc khi giá trị lạ và None khi server không gửi. Các enum xem Enums.
Authentication
Token
| Trường | Kiểu | Mô tả |
|---|---|---|
access_token | str | Token truy cập (bị ẩn khi repr, không in/log) |
token_type | str | Loại token (mặc định "Bearer") |
expires_at | int | Thời điểm hết hạn, epoch giây (0 = không rõ / coi như đã hết hạn) |
refresh_token | str | Token làm mới (bị ẩn khi repr) |
refresh_token_expires_at | int | Thời điểm refresh token hết hạn |
Thuộc tính: effective_expires_at (thời điểm hết hạn hiệu lực) và can_refresh (có thể refresh hay không).
OTPResponse
Kết quả của auth.request_otp_typed().
| Trường | Kiểu | Mô tả |
|---|---|---|
message | str | Thông báo từ server |
transaction_id | str | None | Chỉ có với Smart OTP; truyền vào ensure_authenticated(transaction_id=...). Xem Smart OTP |
Account
Account
| Trường | Kiểu | Mô tả |
|---|---|---|
account_no | str | Số tài khoản |
account_type | AccountType | str | None | Loại tài khoản; chuỗi gốc nếu loại lạ, None nếu server không gửi (không còn mặc định là Cash) |
Market Data
OHLCData
| Trường | Kiểu | Mô tả |
|---|---|---|
symbol | str | Mã chứng khoán |
trading_date | str | Ngày giao dịch |
open_price | float | int | Giá mở cửa |
high_price | float | int | Giá cao nhất |
low_price | float | int | Giá thấp nhất |
close_price | float | int | Giá đóng cửa |
volume | int | Khối lượng |
value | float | int | Giá trị giao dịch |
MarketIndexes
| Trường | Kiểu | Mô tả |
|---|---|---|
index | str | Mã chỉ số |
index_name | str | Tên chỉ số |
board | Board | str | None | Sàn |
board_raw | str | None | Mã sàn gốc server gửi |
MarketIndexSummary
MarketIndexSummary không có trường index và board; mã chỉ số là tham số bạn truyền vào khi gọi.
| Trường | Kiểu | Mô tả |
|---|---|---|
trading_date | str | Ngày giao dịch |
index_value | float | Giá trị chỉ số |
index_change | float | Thay đổi |
index_change_percent | float | Thay đổi (%) |
total_trade | int | Tổng KL giao dịch |
total_trade_value | float | Tổng giá trị giao dịch |
total_advance_stock | int | Số mã tăng |
total_decline_stock | int | Số mã giảm |
total_steady_stock | int | Số mã đứng |
total_match | int | Tổng khối lượng khớp |
total_match_value | float | Tổng giá trị khớp |
total_deal | int | Tổng khối lượng thoả thuận |
total_deal_value | float | Tổng giá trị thoả thuận |
total_ceiling_stock | int | Số CP trần |
total_floor_stock | int | Số CP sàn |
total_prop_buy | int | Tổng KL mua tự doanh |
total_prop_buy_value | float | Tổng GT mua tự doanh |
total_prop_sell | int | Tổng KL bán tự doanh |
total_prop_sell_value | float | Tổng GT bán tự doanh |
total_buy_foreign / total_buy_foreign_value | tuỳ chọn | KL / GT mua của khối ngoại |
total_sell_foreign / total_sell_foreign_value | tuỳ chọn | KL / GT bán của khối ngoại |
net_purchases_foreign_volume / net_purchases_foreign_value | tuỳ chọn | KL / GT mua ròng của khối ngoại |
Các trường khối ngoại là tuỳ chọn (None nếu server không gửi).
SecuritiesInfo
Trường số mà server bỏ qua là None (không phải 0); ngày rỗng là None.
| Trường | Kiểu | Mô tả |
|---|---|---|
symbol | str | Mã chứng khoán |
board | Board | str | None | Sàn |
index | str | None | Chỉ số |
symbol_name_vi | str | None | Tên tiếng Việt |
symbol_name_en | str | None | Tên tiếng Anh |
lot_size | int | None | Lô giao dịch |
listed_shares | int | None | Số CP niêm yết |
icb_code | str | None | Mã ngành ICB |
icb_name | str | None | Tên ngành ICB |
maturity_date | str | None | Ngày đáo hạn |
first_trading_date | str | None | Ngày GD đầu tiên |
last_trading_date | str | None | Ngày GD cuối cùng |
cw_underlying_symbol | str | None | Mã CK cơ sở CW |
cw_exercise_price | float | None | Giá thực hiện CW |
cw_execution_ratio | float | None | Tỷ lệ thực hiện CW |
i_index | float | None | Chỉ số I |
i_nav | float | None | Giá trị iNAV |
open_interest | int | None | Vị thế mở (phái sinh) |
settlement_price | float | None | Giá thanh toán (phái sinh) |
stock_type | str | None | Loại chứng khoán |
MasterData
Giá trần / sàn / tham chiếu của một mã (từ get_master_data()).
| Trường | Kiểu | Mô tả |
|---|---|---|
board | Board | str | None | Sàn |
symbol | str | Mã chứng khoán |
trading_date | str | Ngày giao dịch |
ceiling | float | None | Giá trần |
floor | float | None | Giá sàn |
ref_price | float | None | Giá tham chiếu |
CorporateAction
Một sự kiện quyền (cổ tức, thưởng, phát hành thêm, ...) của một mã (từ get_corporate_actions() và get_corporate_actions_historical()). Mọi trường đều là str đúng như server trả: ngày giữ nguyên dạng text YYYY/MM/DD, ratio không ép kiểu vì ý nghĩa phụ thuộc loại sự kiện. Trường nào server để trống (sự kiện mới công bố chưa có ngày giao dịch không hưởng quyền hoặc tỷ lệ) sẽ là "".
| Trường | Kiểu | Mô tả |
|---|---|---|
symbol | str | Mã chứng khoán |
event_title | str | Tên sự kiện |
exright_date | str | Ngày giao dịch không hưởng quyền |
record_date | str | Ngày đăng ký cuối cùng |
issue_date | str | Ngày phát hành |
exchange | str | Mã sàn, ví dụ "HOSE" |
ratio | str | Tỷ lệ sự kiện dạng text, ví dụ "0.9388" |
SecuritiesSummary
| Trường | Kiểu | Mô tả |
|---|---|---|
symbol | str | Mã chứng khoán |
trading_date | str | Ngày giao dịch |
price_change | float | Thay đổi giá |
price_change_percent | float | Thay đổi giá (%) |
open_price | float | Giá mở cửa |
high_price | float | Giá cao nhất |
low_price | float | Giá thấp nhất |
close_price | float | Giá đóng cửa |
average_price | float | Giá trung bình |
total_match | int | Tổng KL khớp |
total_match_value | float | Tổng giá trị khớp |
total_buy | int | Tổng KL mua |
total_trade_buy | float | Tổng GT mua |
total_sell | int | Tổng KL bán |
total_trade_sell | float | Tổng GT bán |
total_foreign_buy / total_foreign_buy_value | tuỳ chọn | KL / GT mua của khối ngoại |
total_foreign_sell / total_foreign_sell_value | tuỳ chọn | KL / GT bán của khối ngoại |
remain_foreign_room / total_foreign_room | tuỳ chọn | Room ngoại còn lại / tổng room ngoại |
total_deal / total_deal_value | tuỳ chọn | KL / GT thoả thuận |
open_interest / settlement_price | tuỳ chọn | Vị thế mở / giá thanh toán (phái sinh) |
ceiling / floor / ref_price | None | Endpoint này không gửi; dùng get_master_data() |
DownloadData và DownloadDataRequest đã deprecated, không dùng.
Portfolio
Các số dư (EquityAccountBalance, DerivativeAccountBalance) và vị thế (Position) có thể là None khi tài khoản chưa có dữ liệu, hãy kiểm tra None trước khi dùng.
EquityAccountBalance
| Trường | Kiểu | Mô tả |
|---|---|---|
account_no | str | Số tài khoản |
account_balance | float | Số dư tài khoản |
total_debt | float | Tổng nợ |
interest_loan | float | Lãi vay |
overdue_fee_loan | float | Phí vay quá hạn |
withdrawable | float | Tiền rút được |
on_hold_cash | float | Tiền tạm giữ |
sell_unmatched | float | Tiền bán chờ khớp |
sell_t0 | float | Tiền bán T0 |
sell_t1 | float | Tiền bán T1 |
sell_t2 | float | Tiền bán T2 |
buy_unmatched | float | Tiền mua chờ khớp |
buy_t0 | float | Tiền mua T0 |
buy_t1 | float | Tiền mua T1 |
buy_t2 | float | Tiền mua T2 |
advance_cash_t0 | float | Ứng tiền T0 |
advance_cash_t1 | float | Ứng tiền T1 |
hold_subscription | float | Tiền giữ đăng ký |
dividend | float | Cổ tức |
DerivativeAccountBalance
| Trường | Kiểu | Mô tả |
|---|---|---|
account_no | str | Số tài khoản |
account_balance | float | Số dư tài khoản |
fee | float | Phí |
commission | float | Hoa hồng |
interest | float | Lãi |
ext_interest | float | Lãi ngoài |
loan | float | Vay |
delivery_amount | float | Giá trị giao nhận |
floating_pl | float | Lãi/lỗ chưa thực hiện |
trading_pl | float | Lãi/lỗ giao dịch |
total_pl | float | Tổng lãi/lỗ |
withdrawable | float | Tiền rút được |
cash_ssi | float | Tiền mặt SSI |
valid_non_cash_ssi | float | Tài sản phi tiền mặt hợp lệ SSI |
withdrawable_ssi | float | Tiền rút được SSI |
cash_vsdc | float | Tiền mặt VSDC |
valid_non_cash_vsdc | float | Tài sản phi tiền mặt hợp lệ VSDC |
withdrawable_vsdc | float | Tiền rút được VSDC |
cash_withdrawable_ssi và cash_withdrawable_vsdc là alias cũ của withdrawable_ssi / withdrawable_vsdc; vẫn đọc được nhưng phát DeprecationWarning.
EquityPosition
| Trường | Kiểu | Mô tả |
|---|---|---|
account_no | str | Số tài khoản |
symbol | str | Mã chứng khoán |
quantity | int | Tổng số lượng |
sellable_quantity | int | Số lượng bán được |
cost_price | float | Giá vốn |
buying_quantity | int | SL đang mua |
selling_quantity | int | SL đang bán |
mortgage_quantity | int | SL cầm cố |
block_quantity | int | Khối lượng phong toả |
dividend_quantity | int | Khối lượng cổ tức |
bought_quantity | int | Khối lượng đã mua |
sold_quantity | int | Khối lượng đã bán |
t1_buy_quantity | int | KL mua T1 |
t2_buy_quantity | int | KL mua T2 |
t1_sell_quantity | int | KL bán T1 |
t2_sell_quantity | int | KL bán T2 |
restricted_quantity | int | Khối lượng hạn chế |
DerivativePosition
| Trường | Kiểu | Mô tả |
|---|---|---|
account_no | str | Số tài khoản |
symbol | str | Mã hợp đồng |
long / short / net | int | Vị thế mua / bán / ròng |
bid_avg_price / ask_avg_price | float | Giá TB mua / bán |
floating_pl / trading_pl | float | Lãi/lỗ |
trade_price | float | Giá giao dịch |
AllDerivativePosition
| Trường | Kiểu | Mô tả |
|---|---|---|
open_positions | list[DerivativePosition] | Vị thế đang mở |
closed_positions | list[DerivativePosition] | Vị thế đã đóng |
account_no | str | Số tài khoản |
Order
| Trường | Kiểu | Mô tả |
|---|---|---|
account_no | str | Số tài khoản |
client_request_id | str | ID yêu cầu client |
order_id | str | ID lệnh |
symbol | str | Mã chứng khoán |
side | OrderSide | str | None | Mua/Bán |
order_type | OrderType | str | None | Loại lệnh |
price | int | float | OrderType | str | Giá đặt (có thể là loại lệnh như ATO, ATC) |
avg_price | float | Giá TB khớp |
quantity | int | SL đặt |
os_quantity | int | None | SL chờ |
filled_quantity | int | SL đã khớp |
cancel_quantity | int | SL đã huỷ |
status | OrderStatus | str | None | Trạng thái lệnh |
input_time / modify_time | str | Thời gian đặt / sửa |
message | str | Thông báo |
Trading Responses
PlaceOrderResponse
order_id, client_request_id, status (OrderStatus | str)
ModifyOrderResponse
client_modify_id, order_id, client_request_id, status (OrderStatus | str)
CancelOrderResponse
client_cancel_id, order_id, client_request_id, status (OrderStatus | str)
MaxBuySellResponse
account_no, symbol, max_buy_quantity, max_sell_quantity, margin_ratio (str | None), purchasing_power (int | None)
Conditional Orders (FCO)
FCOPlaceResponse
Kết quả đặt lệnh điều kiện — fco_id
FCOCancelResponse
Kết quả huỷ lệnh điều kiện — fco_id
FCOListResponse
Danh sách lệnh điều kiện (phân trang).
| Trường | Kiểu | Mô tả |
|---|---|---|
page_index | int | Trang hiện tại |
page_size | int | Kích thước trang |
items_count | int | Tổng số bản ghi |
pages_count | int | Tổng số trang |
fco_list | list[FCOInfo] | Danh sách lệnh FCO |
FCOInfo
Thông tin chi tiết một lệnh điều kiện.
| Trường | Kiểu | Mô tả |
|---|---|---|
fco_id | str | Mã lệnh FCO |
client_id | str | Username / Client ID |
account_no | str | Số tài khoản |
quantity | int | Khối lượng đặt |
price | str | Giá đặt |
price_slip | float | None | Độ trượt giá |
order_type | OrderType | str | None | Loại lệnh được đặt khi kích hoạt |
symbol | str | Mã chứng khoán |
type | FCOType | str | None | Loại lệnh điều kiện |
from_date | str | Ngày bắt đầu hiệu lực |
to_date | str | Ngày kết thúc hiệu lực |
matched_quantity | int | Khối lượng đã khớp |
is_place_order | bool | Đã đẩy lệnh vào sổ hay chưa |
status | FCOStatus | str | None | Trạng thái lệnh FCO |
detail | str | Chi tiết trạng thái |
params | FCOParams | None | Tham số kích hoạt lệnh FCO |
FCOParams
Tham số kích hoạt của lệnh điều kiện.
| Trường | Kiểu | Mô tả |
|---|---|---|
stop_price | float | None | Giá dừng / giá kích hoạt |
side | OrderSide | None | Chiều lệnh (Mua/Bán) |
active_price | float | None | Giá kích hoạt (Trailing Stop) |
trailing_amount | float | None | Khoảng bám sát (Trailing Amount) |
tp_active_price | float | None | Giá kích hoạt chốt lời (Take Profit) |
sl_active_price | float | None | Giá kích hoạt cắt lỗ (Stop Loss) |
tp_price | str | None | Giá chốt lời |
sl_price | str | None | Giá cắt lỗ |
tp_slip | float | None | Trượt giá chốt lời |
sl_slip | float | None | Trượt giá cắt lỗ |
operator | FCOOperator | str | None | Toán tử so sánh kích hoạt |
Các lớp tham số khi đặt lệnh (GTDParams, StopParams, TrailingStopParams, OCOParams, BullBearParams) có thêm trường tuỳ chọn code (mã OTP, mặc định None).
FCOStatusHistoryItem
Một dòng trong lịch sử đổi trạng thái của lệnh điều kiện (từ get_fco_status_history).
| Trường | Kiểu | Mô tả |
|---|---|---|
state | str | Trạng thái (xem FCOStatus ở Enums) |
time | str | Thời điểm đổi trạng thái |
code | str | None | Mã đi kèm trạng thái (nếu có) |
detail | str | Chi tiết |
FCOOrderBookResponse
Nhật ký khớp lệnh FCO (phân trang).
| Trường | Kiểu | Mô tả |
|---|---|---|
page_index | int | Trang hiện tại |
page_size | int | Kích thước trang |
items_count | int | Tổng số bản ghi |
pages_count | int | Tổng số trang |
order_book | list[FCOOrder] | Danh sách nhật ký lệnh FCO |
FCOOrder
Nhật ký giao dịch / thực thi của lệnh FCO.
| Trường | Kiểu | Mô tả |
|---|---|---|
fco_id | str | Mã lệnh FCO gốc |
account_no | str | Số tài khoản |
quantity | int | Khối lượng |
price | str | Giá đặt |
symbol | str | Mã chứng khoán |
type | FCOType | str | None | Loại lệnh điều kiện |
side | OrderSide | str | None | Chiều lệnh |
order_type | OrderType | str | None | Loại lệnh con |
is_main_order | bool | Là lệnh chính |
is_attached_order | bool | Là lệnh kèm theo |
created_time / updated_time | str | Thời gian tạo / cập nhật |
unique_id | str | ID duy nhất |
order_id | str | Mã lệnh trên sàn |
matched_quantity | int | Khối lượng đã khớp |
os_quantity | int | Khối lượng chờ khớp |
avg_price | float | Giá khớp trung bình |
status | OrderStatus | str | None | Trạng thái lệnh con |
detail | str | Chi tiết |
Batch Order
Các model của batch order (đặt / huỷ nhiều lệnh trong một request). Cách dùng, ví dụ và giới hạn: Services, mục 5.4.
Hai TypedDict dưới đây mô tả từng phần tử bạn truyền vào place_batch_orders / cancel_batch_orders:
| Kiểu | Trường bắt buộc | Trường tuỳ chọn |
|---|---|---|
BatchPlaceOrderItem | account_no, symbol, side, quantity, price, order_type | client_request_id |
BatchCancelOrderItem | account_no | order_id, client_request_id |
BatchOrderRequest
| Trường | Kiểu | Mô tả |
|---|---|---|
batch_request_id | str | ID của cả batch (dùng lại id đã dùng là HTTP 409) |
batch_request_time | int | Thời điểm gửi batch, epoch mili giây |
orders | list[dict] | Danh sách lệnh |
Có to_dict() (payload camelCase) và to_str() (chuỗi JSON được ký và gửi đi).
BatchOrderResult
Kết quả của từng lệnh trong batch.
| Trường | Kiểu | Mô tả |
|---|---|---|
client_request_id | str | ID yêu cầu client của lệnh |
order_id | str | ID lệnh |
status | OrderStatus | str | Trạng thái |
success | bool | Lệnh này có thành công hay không (mặc định False) |
error_code | str | Mã lỗi server khi lệnh bị từ chối |
error_message | str | Nội dung lỗi server khi lệnh bị từ chối |
client_cancel_id | str | ID của yêu cầu huỷ (do SDK sinh, chỉ khi huỷ batch) |
BatchOrderResponse
| Trường | Kiểu | Mô tả |
|---|---|---|
batch_request_id | str | ID của cả batch |
results | list[BatchOrderResult] | Kết quả từng lệnh |
Lưu ý: số lệnh tối đa mỗi batch trong SDK là MAX_BATCH_ORDERS = 20 (ghi đè được bằng Config.max_batch_orders), trong khi tài liệu API reference ghi 50; chưa xác nhận được giá trị server áp dụng. Xem Configuration và Services, mục 5.4.
Streaming Messages
Các message này nhận qua callback của stream.streaming, xem Services, mục 6.
TradeMessage
type, trading_time, symbol, price, quantity, side, total_volume, cùng các trường tuỳ chọn open, high, low, avg (None nếu server không gửi).
IntervalMessage
| Trường | Kiểu | Mô tả |
|---|---|---|
type | DataType | Loại dữ liệu |
interval_time | str | Thời gian interval |
trading_time | str | Thời gian giao dịch |
symbol | str | Mã chứng khoán |
open | float | int | Giá mở |
high | float | int | Giá cao |
low | float | int | Giá thấp |
close | float | int | Giá đóng |
volume | int | Khối lượng |
IndexTickMessage
Tick thời gian thực của chỉ số (xem Services, mục 6.7).
| Trường | Key server | Mô tả |
|---|---|---|
type | Loại dữ liệu | |
symbol | s | Mã chỉ số |
board | b | Sàn |
status | ss | Trạng thái |
trading_time | t | Thời gian |
value | v | Giá trị chỉ số |
change | c | Thay đổi |
change_percent | cr | Thay đổi (%) |
advances | adv | Số mã tăng |
declines | dec | Số mã giảm |
no_change | nc | Số mã đứng |
ceilings | ce | Số mã trần |
floors | fl | Số mã sàn |
total_match_value | tmv | Tổng giá trị khớp |
total_match_quantity | tmq | Tổng khối lượng khớp |
total_put_value | tvp | Tổng giá trị thoả thuận |
total_put_quantity | tqp | Tổng khối lượng thoả thuận |
total_quantity | tq | Tổng khối lượng |
total_value | tv | Tổng giá trị |
raw | Toàn bộ data server gửi |
Chưa xác nhận: tên thuộc tính được suy ra từ ký hiệu viết tắt của server, chưa đối chiếu với frame thật. Khi cần chắc chắn, đọc msg.raw.
IndexSummaryMessage
| Trường | Kiểu | Mô tả |
|---|---|---|
index | str | Mã chỉ số lấy từ topic, viết hoa (ví dụ "VN30") |
data | dict | Payload gốc server gửi |
Các trường trong data chưa được tài liệu công khai nên SDK không đoán; đọc bằng msg.get("key1", "key2", default=None) (trả giá trị của key đầu tiên có mặt).
MarketFlagMessage
| Trường | Kiểu | Mô tả |
|---|---|---|
board | str | Mã sàn như server gửi: HOSE, HNX, UPCOM hoặc DER (phái sinh, khác DERIVATIVES của enum Board) |
trading_time | str | Thời gian |
flag | str | Cờ phiên (ví dụ "ATO", "LO", "ATC"), giữ nguyên chuỗi |
MarketDataMessage
symbol, board, trading_time, ceiling, floor, ref_price
QuoteMessage
type, trading_time, symbol, bid_prices, bid_volumes, ask_prices, ask_volumes
ForeignRoomMessage
type, trading_time, symbol, total_room, current_room, buy_quantity, buy_value, sell_quantity, sell_value
PutMessage
type, trading_time, symbol, price, quantity, total_quantity, total_value
OddLotMessage
type, trading_time, symbol, price, quantity, bid_prices, bid_volumes, ask_prices, ask_volumes
MarketStatusMessage
market, status, trading_date
OrderStatusMessage
type, account_no, client_request_id, order_id, symbol, side, order_type, price, quantity, os_quantity, filled_quantity, cancel_quantity, status, input_time, modified_time, message, cùng avg_price, reject_reason, system_request_id, error_code, error_message, notify_id, connection_id.
modify_time là alias deprecated của modified_time. os_quantity là None khi lệnh lấy từ REST order book. Lệnh bị server từ chối báo status RJ kèm error_code.
OrderMatchMessage
type, notify_id, connection_id, client_request_id, order_id, symbol, side, account_no, match_price, match_qty, match_time
PortfolioMessage
type, account_no, symbol, long_qty, short_qty, net, bid_avg_price, ask_avg_price, trade_price, market_price, floating_pl, trading_pl, position_type
total_asset, cash_balance và stock_value đã deprecated và luôn là None.
FCOOrderUpdateMessage
Cập nhật trạng thái lệnh điều kiện FCO (streaming, nhận qua on_trading khi event_type == "fcoEvent").
| Trường | Kiểu | Mô tả |
|---|---|---|
fco_id | str | Mã lệnh FCO |
process_status | FCOStatus | None | Trạng thái xử lý lệnh FCO (INIT, WAIT, WC, TER, ...) |
matched_quantity | int | Khối lượng đã khớp |
is_place_order | bool | Đã đẩy lệnh vào sổ hay chưa |
symbol | str | Mã chứng khoán |
quantity | int | Khối lượng đặt |
price | str | Giá đặt |
account_no | str | Số tài khoản |
updated_time | str | Thời gian cập nhật (YYYY/MM/DD HH:MM:SS) |
status | str | Mã trạng thái |
message | str | Thông báo chi tiết / lý do kích hoạt, ngắt kết nối |
username | str | Username đặt lệnh |
event_type | str | Loại sự kiện ("fcoEvent") |
type | FCOType | None | Loại lệnh điều kiện (GTD, STOP, ...) |
HeartbeatMessage
method, channel, status, message
ConnectionEvent
Sự kiện trạng thái kết nối của stream, nhận qua on_connection. Là frozen dataclass, không export ở top level: from ssi_sdk.transport.reconnect import ConnectionEvent.
| Trường | Kiểu | Mô tả |
|---|---|---|
state | str | connected, reconnected, disconnected hoặc failed |
reconnect_count | int | Số lần đã reconnect (mặc định 0) |
error | Exception | None | Lỗi gây ra sự kiện (mặc định None) |
Chi tiết: Services, mục 6.9.
Trading WebSocket
Import từ ssi_sdk (ở 3.3.1 trở về trước nằm trong ssi_sdk.experimental; module đó đã bị xoá ở 3.3.2). Cách dùng đầy đủ: Services, mục 7; cách tạo service: Client Classes.
TradingWSResponse
Kết quả của một lệnh gửi qua Trading WebSocket.
| Trường | Kiểu | Mô tả |
|---|---|---|
id | str | ID request |
method | str | Method đã gọi |
status | int | Mã trạng thái (mặc định 200) |
result | Any | Dữ liệu trả về |
rate_limit | dict | Thông tin rate limit server trả kèm |
received_time | int | None | Thời điểm nhận phản hồi |
TradingWSError
Kế thừa WebSocketError, raise khi server từ chối lệnh hoặc từ chối kết nối. Constructor TradingWSError(status, code, message); thuộc tính .status, .error_code và .server_message. Xem Exceptions.
Wrapper Types
AccountBalance
| Trường | Kiểu | Mô tả |
|---|---|---|
equity | EquityAccountBalance | None | Số dư cơ sở |
derivative | DerivativeAccountBalance | None | Số dư phái sinh |
Position
| Trường | Kiểu | Mô tả |
|---|---|---|
equity | list[EquityPosition] | None | Vị thế cơ sở |
derivative | AllDerivativePosition | None | Vị thế phái sinh |
PPMMR
| Trường | Kiểu | Mô tả |
|---|---|---|
equity | EquityPPMMR | None | PPMMR cơ sở |
derivative | DerivativePPMMR | None | PPMMR phái sinh |
OrderBook
| Trường | Kiểu | Mô tả |
|---|---|---|
orders | list[Order] | Danh sách lệnh |
total_orders | int | Tổng số lệnh |
Hằng số
Các hằng số giới hạn của SDK (module ssi_sdk.constant). Giá trị chỉ là mặc định của SDK; những giá trị liên quan đến server có thể khác thực tế.
| Hằng số | Giá trị | Ý nghĩa |
|---|---|---|
MAX_CLIENT_REQUEST_ID_LENGTH | 20 | Độ dài tối đa của client_request_id |
MAX_BATCH_ORDERS | 20 | Số lệnh tối đa mỗi batch (mặc định SDK; ghi đè bằng Config.max_batch_orders) |
DEFAULT_SIZE / DEFAULT_PAGE | 1000 / 1 | Kích thước / số trang mặc định khi phân trang |
CORPORATE_ACTIONS_MAX_DAYS | 5 | Khoảng ngày tối đa của một request corporate actions (ngày) |
CORPORATE_ACTIONS_LANGUAGES | ("vn", "en") | Giá trị language được phép cho corporate actions |
TOPIC_MARKET_FLAG | "market.flag" | Topic cờ phiên |
TOKEN_EXPIRY_SKEW_MS | 30000 | Token coi như hết hạn sớm 30 giây |
WS_RECONNECT_MAX_DELAY_MS | 60000 | Độ trễ reconnect tối đa của stream |
WS_RATE_LIMIT_BACKOFF_MS | 30000 | Thời gian chờ khi bị rate limit trên WebSocket |
WS_TOKEN_REFRESH_LEAD_MS | 60000 | Refresh token trước khi hết hạn khoảng này |
WS_SERVER_MAX_CONNECTIONS | 10 | Số kết nối WebSocket tối đa phía server |
WS_MAX_FRAME_BYTES | 4000 | Kích thước frame tối đa SDK gửi (giới hạn server là 4096) |
Các hằng số thời gian có hậu tố _ms (mili giây). Các tuỳ chọn cấu hình tương ứng xem Configuration.