Enums & Constants

All enums are exported from the main package:

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

The main package also exports ALLOWED_TIMEFRAMES, StreamingMethod, StreamingChannel, StreamingType, DataTopic, HTTPStatus, ServerErrorCode, the types FCOStatusLike/FCOTypeLike/FCOOperatorLike, and the topic helpers (buildTopic, buildTopics, TOPIC_TYPES, STREAM_INTERVALS, STREAM_INTERVAL_ALL, StreamInterval). They are covered below.

OrderSide

OrderType

OrderStatus

Board

Timeframe

WEEK_1 and MONTH_1 only remain for backward compatibility: the server rejects them with error 400210. The constant ALLOWED_TIMEFRAMES (a ReadonlySet<Timeframe>) lists the timeframes the OHLC endpoint accepts: 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

Conditional order type (Flexible Conditional Order).

FCOOperator

Comparison operator used to trigger Stop / Stop Limit orders.

FCOStatus

Processing status of a conditional order.

*Like types

FCO parameters accept either the enum member or its string value. The types FCOTypeLike, FCOOperatorLike and FCOStatusLike are exported (type only) so you can annotate variables:

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

const status: FCOStatusLike = 'WAIT'; // same as FCOStatus.WAIT

AccountType

DataType

Streaming Enums

StreamingMethod

Method of a message sent on the streaming channel.

DataTopic

Topic prefixes of the market data channel (with the trailing dot).

StreamingChannel

StreamingType

Topic helpers

Use these to build correctly formed topic strings instead of concatenating text. For subscribing see API Services, section 6.3 and section 6.7.

Main rules (from the source): a topic carries a single filter (*, one code, or a range A-B), and a comma-separated list is rejected. Codes are upper-cased, except for the account numbers of order/portfolio. UPCOMINDEX is rewritten to HNXUPCOMINDEX. @* is only valid for trade, quote, room, put, oddlot with one concrete index or exchange code. What the server does with @* has not been confirmed, see the caveat in section 6.7. asset.* and margin.* are not live yet, so they are not in 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

Application error codes the server returns in { code, msg }. Compare them with the code property of an error (SSIError.code, which includes APIError). A few numbers are reused in different places, so some members are aliases (for example 400104 is both "OTP could not be sent" and "symbol is required"). The SDK notes that the 4010xx signature codes do not line up with the server's own error-code mapping file: trust the number.

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('OTP verification failed');
  }
}

For how to handle errors see Error Handling.

Trading WebSocket constants

This part belongs to the Trading WebSocket, which is exported from the main package @ssi.developer/ssi-sdk. See API Services, section 7.

MUTATING_METHODS (a ReadonlySet<string>, exported from @ssi.developer/ssi-sdk) lists the commands the server requires a signature for. These commands need Config.privateKey; without it the client throws WebSocketError. Method names are matched case-insensitively.

For the TradingWSResponse type see Models, and for the options see Configuration.

HTTPStatus

Common HTTP status codes, used internally to classify API errors.