FastConnect API

https://guide.ssi.com.vn/ssi-products/
Admin
FastConnect API is a comprehensive suite of APIs from SSI Securities Corporation providing real-time...
Tokens:120,986
Snippets:558
Trust Score:9.1
Update:1 day ago
Show doc for...
Tokens:
Raw
### Run the client

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/sample-client-guide.md

Run this command to start the client. If successful, a message 'Example app listinging on port <port number>!' is displayed; note the port for the next step.

```bash
node main.js
```

--------------------------------

### Install ssi-fctrading npm package

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/sample-client-guide.md

Run this command in the command line after downloading and unzipping the client to install the ssi-fctrading package. If behind a proxy, configure proxy as guided in the documentation.

```bash
npm install ssi-fctrading
```

--------------------------------

### Install ssi-fctrading package

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/sample-client-guide.md

Run this command in the command line after unzipping the downloaded client and configuring fc_config.py. Installs the ssi-fctrading package. If behind a proxy, configure proxy as guided in the documentation.

```bash
pip install ssi-fctrading
```

--------------------------------

### Install ssi-fcdata npm package

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/sample-client-guide.md

Run this command in the command line after extracting the downloaded client to install the sample client.

```bash
npm install ssi-fcdata
```

--------------------------------

### Install sample client with java -jar

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/sample-client-guide.md

Run this command in the command line after extracting the downloaded file to install the sample client. Replace <tensamplejava>.jar with the actual jar file name.

```bash
java -jar <tensamplejava>.jar
```

--------------------------------

### Install Python client with pip

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/sample-client-guide.md

Run this command in the extracted folder to install the Python client. Requires Python 3.x and network proxy configuration if needed.

```bash
pip install dist/<foldername>
```

--------------------------------

### GET stockPosition sample request and response

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

Sample JSON input and output for the GET stockPosition endpoint. The input specifies the account number, and the output includes the stock positions with details such as onHand, block, bonus, and marketPrice.

```json
Input: 
{
account: "0901351",
}
}
Output: 
{
  "message": "Success",
  "status": 200,
  "data": {
    "account": "0001011",
    "totalMarketValue": 0,
    "stockPositions": [
      {
        "marketID": "VN",
        "instrumentID": "AMC",
        "onHand": 300,
        "block": 0,
        "bonus": 3819,
        "buyT0": 0,
        "buyT1": 0,
        "buyT2": 0,
        "sellT0": 0,
        "sellT1": 0,
        "sellT2": 0,
        "avgPrice": 1529,
        "mortgage": 0,
        "sellableQty": 300,
        "holdForTrade": 0,
        "marketPrice": 0
      }
    ]
  }
}
```

--------------------------------

### Run the client

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/sample-client-guide

Command to run the main client file index.js after configuration.

```bash
node index.js
```

--------------------------------

### GET stockPosition endpoint URL

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

The URL for the GET stockPosition API endpoint.

```http
https://fc-tradeapi.ssi.com.vn/api/v2/Trading/stockPosition
```

--------------------------------

### Get purchasing power

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/sample-client-guide

URL to open in a web browser to get the purchasing power of the account.

```text
localhost:3011/maxBuyQty
```

--------------------------------

### GET derivativePosition

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs

Retrieves derivatives account positions. After getting the snapshot, you can subscribe to streaming for real-time updates.

```APIDOC
## GET derivativePosition

### Description
To get derivatives account's position. After getting the snapshot, you can subscribe to streaming to get realtime update.

### Method
GET

### Endpoint
derivativePosition

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **account** (string) - Required - Account number
- **querySummary** (boolean) - Required - True: Netoff position; False: don't netoff position

### Request Example
No request body required.

### Response
#### Success Response (200)
- **message** (string) - Status message
- **status** (number) - Status code
- **data** (list) - List of derivative position data
  - **account** (string) - Account number
  - **openPositions** (list) - List of open positions
  - **closePositions** (list) - List of close positions
    - **marketID** (string) - Market identifier
    - **instrumentID** (string) - Instrument identifier
    - **longQty** (number) - Long quantity
    - **shortQty** (number) - Short quantity
    - **net** (number) - Net quantity
    - **bidAvgPrice** (number) - Average bid price
    - **askAvgPrice** (number) - Average ask price
    - **tradePrice** (number) - Trade price
    - **marketPrice** (number) - Market price
    - **floatingPL** (number) - Floating profit/loss
    - **tradingPL** (number) - Trading profit/loss

#### Response Example
{
  "message": "string",
  "status": 0,
  "data": [
    {
      "account": "string",
      "openPositions": [
        {
          "marketID": "string",
          "instrumentID": "string",
          "longQty": 0,
          "shortQty": 0,
          "net": 0,
          "bidAvgPrice": 0,
          "askAvgPrice": 0,
          "tradePrice": 0,
          "marketPrice": 0,
          "floatingPL": 0,
          "tradingPL": 0
        }
      ],
      "closePositions": [
        {
          "marketID": "string",
          "instrumentID": "string",
          "longQty": 0,
          "shortQty": 0,
          "net": 0,
          "bidAvgPrice": 0,
          "askAvgPrice": 0,
          "tradePrice": 0,
          "marketPrice": 0,
          "floatingPL": 0,
          "tradingPL": 0
        }
      ]
    }
  ]
}
```

--------------------------------

### GET transferable

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs

Get stock transferable. This endpoint retrieves the list of stocks that are available for transfer for a given account.

```APIDOC
## GET transferable

### Description
Get stock transferable. This endpoint retrieves the list of stocks that are available for transfer for a given account.

### Method
GET

### Endpoint
transferable

### Parameters
#### Query Parameters
- **account** (string) - Required - The account number to check transferable stocks.

### Response
#### Success Response
- **message** (string) - Description
- **status** (number) - Description
- **data** (list) - List data
  - **account** (string) - Description
  - **transferableStocks** (list) - Description
    - **instrumentID** (string) - Description
    - **quantity** (number) - Description
    - **instrumentType** (string) - Description

#### Response Example
```json
{
  "message": "string",
  "status": 0,
  "data": {
    "account": "string",
    "transferableStocks": [
      {
        "instrumentID": "string",
        "quantity": 0,
        "instrumentType": "string"
      }
    ]
  }
}
```
```

--------------------------------

### ALL Data Type - Input and Output Example

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/streaming-data.md

Shows the input and output for the ALL data type. The input is 'X: ALL' and the output is a JSON object with DataType 'X' containing market data fields.

```json
Input:
X: ALL 
Output:
{"DataType":"X",
"Content":"{
\"RType\":\"X\",
\"TradingDate\":\"15/08/2023\",
\"Time\":\"10:28:41\",
\"Isin\":\"TAR\",
\"Symbol\":\"TAR\",
\"Ceiling\":23400.0,
\"Floor\":19200.0,
\"RefPrice\":21300.0,
\"Open\":21300.0,
\"High\":22300.0,
\"Low\":21300.0,
\"Close\":21800.0,
\"AvgPrice\":21784.0,
\"PriorVal\":21300.0,
\"LastPrice\":21800.0,
\"LastVol\":100.0,
\"TotalVal\":27946100000.0,
\"TotalVol\":1282900.0,
\"BidPrice1\":21800.0,
\"BidPrice2\":21700.0,
\"BidPrice3\":21600.0,
\"BidPrice4\":21500.0,
\"BidPrice5\":21400.0,
\"BidPrice6\":21300.0,
\"BidPrice7\":21200.0,
\"BidPrice8\":21100.0,
\"BidPrice9\":21000.0,
\"BidPrice10\":20900.0,
\"BidVol1\":18800.0,
\"BidVol2\":35300.0,
\"BidVol3\":93600.0,
\"BidVol4\":60000.0,
\"BidVol5\":45800.0,
\"BidVol6\":94500.0,
\"BidVol7\":42900.0,
\"BidVol8\":48400.0,
\"BidVol9\":165900.0,
\"BidVol10\":26100.0,
\"AskPrice1\":21900.0,
\"AskPrice2\":22000.0,
\"AskPrice3\":22100.0,
\"AskPrice4\":22200.0,
\"AskPrice5\":22300.0,
\"AskPrice6\":22400.0,
\"AskPrice7\":22500.0,
\"AskPrice8\":22600.0,
\"AskPrice9\":22700.0,
\"AskPrice10\":22800.0,
\"AskVol1\":50300.0,
\"AskVol2\":109800.0,
\"AskVol3\":58500.0,
\"AskVol4\":152600.0,
\"AskVol5\":92200.0,
\"AskVol6\":129800.0,
\"AskVol7\":178700.0,
\"AskVol8\":60100.0,
\"AskVol9\":29400.0,
\"AskVol10\":17000.0,
\"MarketId\":\"HNX\",
\"Exchange\":\"HNX\",
\"TradingSession\":\"LO\",
\"TradingStatus\":\"N\",
\"Change\":500.0,
\"RatioChange\":2.35,
\"EstMatchedPrice\":0.0}"}
```

--------------------------------

### GET unsettleSoldTransaction endpoint URL

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

The endpoint URL for querying unsettle sold transactions. Use this URL with the GET method.

```http
https://fc-tradeapi.ssi.com.vn/api/v2/cash/unsettleSoldTransaction
```

--------------------------------

### MI Input and Output Sample

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/streaming-data.md

Sample JSON showing the input 'MI:VN30' and the corresponding output object with index data fields like IndexValue, TotalTrade, and Advances.

```json
Input: 
MI:VN30
Output:
{'DataType': 'MI',
'Content': {
"IndexId":"VN30",
“IndexValEst”:1200.03,
"IndexValue":1238.76,
"PriorIndexValue":1226.16,
"TradingDate":"02/04/2021",
"Time":"11:28:13",
"TotalTrade":0.0,
"TotalQtty":191838100.0,
"TotalValue":7289093000000.0,
"IndexName":"VN30",
"Advances":25,
"NoChanges":2,
"Declines":3,"Ceilings":0,
"Floors":0,"Change":12.6,
"RatioChange":1.03,
"TotalQttyPt":2064000.0,
"TotalValuePt":244251000000.0,
"Exchange":"HOSE",
"AllQty":193902100.0,
"AllValue":7533344000000.0,
"IndexType":"Main",
"TradingSession":null,
"MarketId":null,
"RType":"MI",
"TotalQttyOd":0.0,
"TotalValueOd":0.0}'
}
```

--------------------------------

### Get OTP code

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/sample-client-guide

URL to open in a web browser to get the OTP code when using SMS/Email OTP authentication.

```text
localhost:3011/getOTP
```

--------------------------------

### GET maxBuyQty sample request and response

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

Sample JSON input and output for the maxBuyQty endpoint. The input includes account, instrumentID, and price. The output shows maxBuyQty, marginRatio, purchasingPower, and origMarginRatio.

```json
Input: 
{
account: "0041691",
instrumentD: “SSI”,
price:17
}
Output: 
{
    message: "Success",
    status: 200,
    data: {
        account: "0041691",
        maxBuyQty: 8241440,
        marginRatio: "50%",
        purchasingPower: 99292902171
    }
}
```

--------------------------------

### GET cashInAdvanceAmount endpoint URL

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

The endpoint URL for querying cash in advance available amount. Use this URL with the GET method.

```http
https://fc-tradeapi.ssi.com.vn/api/v2/cash/cashInAdvanceAmount
```

--------------------------------

### OHLCV (B) Input and Output Sample

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/streaming-data.md

Sample JSON showing the input 'B:X26' and the corresponding output object with OHLCV fields like Open, High, Low, Close, and Volume.

```json
Input: 
B:X26
Output:
{‘Datatype’: 'B',
 ‘Content’: '{
 "RType":"B",
 "Symbol":"X26",
 "TradingTime":"14:28:33",
 "Open":16000,
 "High":16000,
 "Low":16000,
 "Close":16000,
 "Volume":5000,
 "Value":0}' 
 }
```

--------------------------------

### Sample JSON input and output for derivativeAccountBalance

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

Sample request and response for the derivativeAccountBalance endpoint. The input includes the account field, and the output contains account balance details such as accountBalance, fee, commission, interest, loan, deliveryAmount, floatingPL, totalPL, marginable, depositable, rcCall, withdrawable, nonCashDrawableRCCall, internalAssets, exchangeAssets, internalMargin, exchangeMargin, nav, and origMarginRatio.

```json
Input: 
{
    account: "0901358",
}
Output: 
{
message: "Success",
status: 200,
data: {
account: "0901358",
accountBalance: 11166309263,
fee: 0,
commission: 0,
interest: 1514965,
loan: 0,
deliveryAmount: 0,
floatingPL: 0,
totalPL: 0,
marginable: 0,
depositable: 1148597520,
rcCall: 0,
withdrawable: 10912447363,
nonCashDrawableRCCall: 0,
internalAssets: {
cash: 1165730020,
validNonCash: 0,
totalValue: 11166309263,
maxValidNonCash: 0,
cashWithdrawable: 1148597520,
ee: 8197059272
        },
exchangeAssets: {
cash: 10000579243,
validNonCash: 0,
totalValue: 10000579243,
maxValidNonCash: 0,
cashWithdrawable: 9763849843,
ee: 7322887382
         },
        internalMargin: {
initialMargin: 172660800,
deliveryMargin: 0,
marginReq: 172660800,
accountRatio: 1.5462656096416592,
usedLimitWarningLevel1: 75,
usedLimitWarningLevel2: 85,
usedLimitWarningLevel3: 90,
marginCall: 0
        },
      exchangeMargin: {
marginReq: 172660800,
accountRatio: 1.7265079932330476,
usedLimitWarningLevel1: 75,
usedLimitWarningLevel2: 85,
usedLimitWarningLevel3: 90,
marginCall: 0
        }
     }
}
```

--------------------------------

### GET maxBuyQty endpoint URL

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

Base URL for the maxBuyQty endpoint. Used to get the maximum buy quantity for both cash and derivatives accounts.

```http
https://fc-tradeapi.ssi.com.vn/api/v2/Trading/maxBuyQty
```

--------------------------------

### GET transferHistories

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs

Get stock transfer history. This endpoint retrieves the transfer history for a given account within a specified date range.

```APIDOC
## GET transferHistories

### Description
Get stock transfer history. This endpoint retrieves the transfer history for a given account within a specified date range.

### Method
GET

### Endpoint
transferHistories

### Parameters
#### Query Parameters
- **account** (string) - Required - The account number.
- **startDate** (string) - Required - format: dd/mm/yyyy
- **endDate** (string) - Required - format: dd/mm/yyyy

### Response
#### Success Response
- **message** (string) - Description
- **status** (number) - Description
- **data** (list) - List data
  - **account** (string) - Description
  - **stockTransferHistories** (list) - Description
    - **transactionID** (string) - Description
    - **beneficiaryAccount** (string) - Description
    - **instrumentID** (string) - Description
    - **quantity** (number) - Description
    - **dateTime** (string) - Description
    - **status** (string) - Description
    - **remark** (string) - Description
    - **auditRemark** (string) - Description

#### Response Example
```json
{
  "message": "string",
  "status": 0,
  "data": {
    "account": "string",
    "stockTransferHistories": [
      {
        "transactionID": "string",
        "beneficiaryAccount": "string",
        "instrumentID": "string",
        "quantity": 0,
        "dateTime": "string",
        "status": "string",
        "remark": "string",
        "auditRemark": "string"
      }
    ]
  }
}
```

### Notes
- fromDate - toDate not more than 1 month
- The time for searching the past should not exceed 6 months
```

--------------------------------

### Check Node.js version

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/sample-client-guide.md

Run this command to verify Node.js is installed and check the version. Requires Node.js v10.15.3 or higher.

```bash
cmd node –version
```

--------------------------------

### GET SecuritiesDetails endpoint URL

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-data/api-specs.md

The base URL for the SecuritiesDetails API endpoint. Use this URL to make GET requests to retrieve securities details.

```http
https://fc-data.ssi.com.vn/api/v2/Market/SecuritiesDetails

```

--------------------------------

### auditOrderBook sample request and response

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

Sample JSON input and output for the auditOrderBook endpoint. The input requires an account string. The output includes order details such as orderID, buySell, price, quantity, and orderStatus.

```json
Input: 
{
account: "1184418"
}
Output: 
{
  "message": "Success",
  "status": 200,
  "data": {
    "account": "1184418",
    "orders": [
      {
        "uniqueID": "73885549",
        "orderID": "T202306146w273885549",
        "buySell": "B",
        "price": 1000,
        "quantity": 100,
        "filledQty": 0,
        "orderStatus": "RJ",
        "marketID": "VNFE",
        "inputTime": "1686730747945",
        "modifiedTime": "1686730747945",
        "instrumentID": "VN30F2306",
        "orderType": "LO",
        "cancelQty": 0,
        "avgPrice": 0,
        "isForcesell": "F",
        "isShortsell": "F",
        "rejectReason": "Invalid market status",
        "lastErrorEvent": null
      }     
    ]
  }
}
```

--------------------------------

### Sample request and response for cashInAdvanceAmount

Source: https://guide.ssi.com.vn/ssi-products/fastconnect-trading/api-specs.md

Sample JSON input and output for the cashInAdvanceAmount endpoint. The input requires an account string. The output includes a message, status, and data with account and ciaAmounts list.

```json
Input: 
{
  account: "8888881"
}
Output: 
{
    "message": "Success",
    "status": 200,
    "data": {
        "account": "8888881",
        "ciaAmounts": [
            {
                "dueDate": "08/03/2023",
                "sellValue": 3000000.0,
                "netSellValue": 0.0,
                "advance": 0.0,
                "cashAdvance": 0.0
            }
        ]
    }
}
```
Tokens:
Raw