Enums & Hằng số

Tất cả enum được export từ package chính:

import { OrderSide, OrderType, OrderStatus, Board, Timeframe, AccountType, DataType, FCOType, FCOOperator, FCOStatus } from '@ssi.developer/ssi-sdk';

Ngoài ra package chính còn export ALLOWED_TIMEFRAMES, StreamingMethod, StreamingChannel, StreamingType, DataTopic, HTTPStatus, ServerErrorCode, các kiểu FCOStatusLike/FCOTypeLike/FCOOperatorLike và các helper topic (buildTopic, buildTopics, TOPIC_TYPES, STREAM_INTERVALS, STREAM_INTERVAL_ALL, StreamInterval). Các phần tương ứng nằm bên dưới.

OrderSide

OrderType

OrderStatus

Board

Timeframe

WEEK_1 và MONTH_1 chỉ còn để tương thích ngược: server từ chối chúng với lỗi 400210. Hằng ALLOWED_TIMEFRAMES (một ReadonlySet<Timeframe>) liệt kê các khung mà endpoint OHLC chấp nhận: 1d, 1m, 3m, 5m, 15m, 1h.

import { ALLOWED_TIMEFRAMES, Timeframe } from '@ssi.developer/ssi-sdk';

ALLOWED_TIMEFRAMES.has(Timeframe.MINUTE_5); // true
ALLOWED_TIMEFRAMES.has(Timeframe.WEEK_1);   // false

FCOType

Loại lệnh điều kiện (Flexible Conditional Order).

FCOOperator

Toán tử so sánh dùng để kích hoạt lệnh Stop / Stop Limit.

FCOStatus

Trạng thái xử lý của lệnh điều kiện.

Kiểu *Like

Tham số FCO nhận cả member của enum lẫn chuỗi giá trị tương ứng. Các kiểu FCOTypeLike, FCOOperatorLike, FCOStatusLike được export (chỉ là type) để bạn khai báo biến:

import type { FCOStatusLike } from '@ssi.developer/ssi-sdk';

const status: FCOStatusLike = 'WAIT'; // tương đương FCOStatus.WAIT

AccountType

DataType

Streaming Enums

StreamingMethod

Method của message gửi lên kênh streaming.

DataTopic

Tiền tố topic của kênh dữ liệu thị trường (kèm dấu chấm).

StreamingChannel

StreamingType

Topic helpers

Dùng để dựng chuỗi topic đúng cú pháp thay vì tự nối chuỗi. Chi tiết cách subscribe ở API Services, mục 6.3 và mục 6.7.

Quy tắc chính (theo mã nguồn): một topic chỉ có một filter (*, một mã, hoặc khoảng A-B), danh sách ngăn cách bằng dấu phẩy bị từ chối. Mã được viết hoa, trừ số tài khoản của order/portfolio. UPCOMINDEX được đổi thành HNXUPCOMINDEX. @* chỉ hợp lệ với trade, quote, room, put, oddlot và một mã chỉ số hoặc sàn cụ thể. Ý nghĩa của @* phía server chưa được xác nhận, xem lưu ý ở mục 6.7. asset.* và margin.* chưa có nên không nằm trong TOPIC_TYPES.

import { buildTopic, buildTopics } from '@ssi.developer/ssi-sdk';

buildTopic('trade', 'vnm', '1m');          // "trade.VNM@1m"
buildTopic('trade.index', 'VN30');         // "trade.index.VN30"
buildTopics('quote', ['SSI', 'HPG']);      // ["quote.SSI", "quote.HPG"]

ServerErrorCode

Mã lỗi nghiệp vụ mà server trả trong { code, msg }. Dùng để so sánh với thuộc tính code của lỗi (SSIError.code, trong đó có APIError). Một số con số được dùng lại ở nhiều nơi nên có alias (ví dụ 400104 vừa là "không gửi được OTP" vừa là "thiếu symbol"). SDK ghi chú rằng nhóm mã chữ ký 4010xx không khớp với file error-code-mapping của server: hãy tin vào con số.

import { SSIError, ServerErrorCode } from '@ssi.developer/ssi-sdk';

try {
  await auth.authenticate('YOUR_OTP');
} catch (error) {
  if (error instanceof SSIError && error.code === ServerErrorCode.OTP_VERIFICATION_FAILED) {
    console.log('Xác thực OTP thất bại');
  }
}

Về cách xử lý lỗi xem Xử lý lỗi.

Hằng số Trading WebSocket

Phần này thuộc Trading WebSocket, được export từ package chính @ssi.developer/ssi-sdk. Xem API Services, mục 7.

MUTATING_METHODS (một ReadonlySet<string>, export từ @ssi.developer/ssi-sdk) liệt kê các command mà server yêu cầu chữ ký. Các command này cần Config.privateKey, nếu thiếu client ném WebSocketError. Tên method được so khớp không phân biệt hoa thường.

Kiểu dữ liệu TradingWSResponse xem ở Models, các option ở Cấu hình.

HTTPStatus

Mã HTTP status thường gặp, dùng nội bộ để phân loại lỗi API.