SSI API Overview

Introduction

FastConnect APIs are designed to support the full digital trading integration lifecycle, from secure access and trading operations to market data retrieval and real-time event streaming.

The API Reference is organized into 7 functional groups:

1. Authentication — Authentication and access-session management.
2. Trading — Place/modify/cancel orders, account queries.
3. Market Data — Market data over REST API.
4. WebSocket — Real-time data via WebSocket.
5. Conditional Orders (FCO) — Place/cancel conditional orders, query the FCO order book.
6. WebSocket API — Place/modify/cancel orders, conditional orders, and account queries purely over a persistent WebSocket connection, with low latency.
7. Reference Appendix — Order status flow, FCO reference, error code lookup.

Integration Objectives

The platform focuses on:

• Secure authentication and session management.
• Place/modify/cancel orders (including in bulk) and query trading status.
• Place conditional orders (FCO) with multiple strategies.
• Access market data through REST APIs.
• Consume real-time data via WebSocket.

This page provides a system-level view before diving into endpoint-level specifications.

Recommended Integration Flow

Typical integration flow:

1. Call Authentication APIs to obtain tokens.
2. Use tokens to access Trading, Conditional Orders (FCO), and Market Data over REST.
3. Use tokens to connect to WebSocket and subscribe to real-time topics.
4. See the Reference Appendix for error codes, the order status flow, and FCO parameters.

1) Authentication

This group manages token issuance and renewal, and should be integrated first.

• auth-token: issues accessToken and refreshToken.
• auth-refresh: renews token pairs before expiration.
• auth-requestOtp: requests OTP for business-level verification.

Start here:

• auth-token
• auth-refresh
• auth-requestOtp

2) Trading

This group supports core trading and account-related operations:

• Place/modify/cancel orders.
• Place/cancel orders in bulk (Batch Order, up to 50 orders per call).
• Query account balance, positions, buying power, and account information.
• Query order book and risk-related account metrics.

Key APIs:

• trade-order-place
• trade-order-modify
• trade-order-cancel
• trade-order-batch-place — Place orders in bulk.
• trade-order-batch-cancel — Cancel orders in bulk.
• trade-orderBook
• trade-position
• trade-accountBalance
• trade-maxbuysell
• trade-ppmmrAccount
• account-info

Each order goes through several states during its place/modify/cancel/fill lifecycle (PD → RS → SD → QU → PF/FF, or WC → CL, RJ, EX...). When integrating, consumers should understand the meaning of each status and the transitions between them to correctly handle the responses of the APIs above as well as streaming events (orderEvent, orderMatchEvent).

📄 Read more: Order Status Flow — diagram and detailed description of all 16 order statuses and the place/modify/cancel/fill flows.

3) Market Data

This group provides market data retrieval over REST APIs:

• Index list and index summary.
• Security list and security summary.
• OHLC data.
• Corporate action events (dividends, bonus shares, additional issuance, ...).
• Market data file export/download.

Key APIs:

• data-securitiesByBoard
• data-securitiesSummary
• data-indexList
• data-indexSummary
• data-ohlc
• data-corporateActions — Corporate action events.

4) WebSocket

This group delivers real-time streaming through 2 main channels:

• Trading stream: order lifecycle, matched events, account updates.
• Market stream: trade/quote/room/put/oddlot/market events by topic, plus realtime index values (trade.index, tick/1m/5m candles) and index summary information (indexsummary).

WebSocket documentation is organized into 4 sections:

• Connect WebSocket
• Heartbeat and Subscription
• Sub/Unsub Trading Data
• Sub/Unsub Market Data

5) Conditional Orders (FCO)

The Conditional Orders (FastConnect Conditional Order) group lets you place orders that trigger automatically once a market condition is met. The system supports 7 conditional order types:

• Trailing Stop (TS) — a stop order that trails the market price.
• Take Profit (PRO) — locks in profit once a target price is reached.
• Stop Loss (ST) — cuts losses once the price crosses a threshold.
• Trailing Take Profit (TPRO) — take profit with a trailing margin.
• Bull/Bear (BB) — combines take profit and stop loss.
• One Cancels Other (OCO) — two mutually-exclusive orders.
• Market Alert (MA) — alerts when a market condition is met.

Key APIs:

• fco-order-place — Place a new conditional order.
• fco-order-cancel — Cancel a conditional order.
• fco-list — List conditional orders.
• fco-orderbook — Conditional order book.
• fco-statusHistory — Order status history.

6) WebSocket API

The WebSocket API lets you place/amend/cancel regular orders, place/cancel orders in bulk (Batch Order), place/cancel conditional orders (FCO), and query positions/balances/order books — all over a single WebSocket connection, with much lower latency than calling REST for every order. On the same connection, you can also subscribe to real-time notifications for order fills and account changes.

Key APIs:

• Connect WebSocket API
• order.place — Place a new order.
• order.amend — Amend an order.
• order.cancel — Cancel an order.
• order.batchNew — Place orders in bulk.
• order.batchCancel — Cancel orders in bulk.
• fco.place — Place a conditional order over WebSocket.
• query.position — Query position.
• subscribe/unsubscribe — Subscribe to order/portfolio notifications.

7) Reference Appendix

Supplementary documentation for understanding business flows and error handling:

• Order Status Flow — Diagram and detailed description of all 16 order statuses across the place/modify/cancel/fill lifecycle.
• Conditional Order Reference — Detailed parameters and JSON samples for each FCO type.
• Error Code Reference — Full error-code table grouped by HTTP status code (400, 401, 403, 404, 405, 408, 409, 429, 500, 502, 503, 504).

Integration Notes

• Always manage token lifecycle properly (issue, refresh, expiry handling).
• Standardize error handling using ErrCode — see Error Code Reference to map codes to concrete actions.
• Keep REST query flows and real-time stream handling clearly separated in solution design.
• For WebSocket, implement reconnect and re-subscription after connection loss.
• For conditional orders (FCO), see the detailed parameter reference to ensure correct parameters per order type.

Scope of This Overview

This page is a business and architecture overview. Field-level schemas, request/response samples, and detailed constraints are documented in each API page in the sidebar.