API Specs

API List

API	Method	Path
AccessToken	POST	Market/AccessToken
Securities	GET	Market/Securities
SecuritiesDetails	GET	Market/SecuritiesDetails
IndexComponents	GET	Market/IndexComponents
IndexList	GET	Market/IndexList
DailyOhlc	GET	Market/DailyOhlc
IntradayOhlc	GET	Market/IntradayOhlc
DailyIndex	GET	Market/DailyIndex
DailyStockPrice	GET	Market/DailyStockPrice

POST AccessToken

https://fc-data.ssi.com.vn/api/v2/Market/AccessToken

To get access token used to run APIs or connect streaming of FastConnect Data.

Details

Input

Field	Type	Required?	Description
consumerID	string	Yes	ConsumerID
consumerSecret	string	Yes	ConsumerSecret

Output

Field	Type	Description
message	string	Message
status	number	Status
accessToken	string	Token to access API and connect streaming

Sample

Input: 
{
"consumerID": "c058f55761814787882b2c8df1336e25",
"consumerSecret": "144cac45770949519d2dfd20edb5b6ab",
}
Output: 
{
  "message": "Success",
  "status": 200,
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiIsI"
	}
}

GET Securities

https://fc-data.ssi.com.vn/api/v2/Market/Securities

To get securities list by exchange.

Details

Input

Field	Type	Required?	Description
market	string	No	HOSE | HNX | UPCOM | DER If not set, returns securities of all markets
pageIndex	integer	Yes	From 1 to 10. Default value is 1.
pageSize	integer	Yes	10; 20; 50; 100; 1000 Default value is 10.

Output

Field	Type	Description
message	string	Message
status	number	Status
totalRecord	number	Total records
data	list	List data
market	string	HOSE | HNX | UPCOM | DER
symbol	string	Securities symbol
StockName	string	Stock Name in Vietnamese
StockEnName	string	Stock Name in English

Sample

Input:
{
pageIndex : "1"
pageSize: "10"
market: "hose"
} 
Output: 
{
    "data": [
        {
            "Market": "HOSE",
            "Symbol": "AAA",
            "StockName": "CTCP NHUA&MT XANH AN PHAT",
            "StockEnName": "An Phat Bioplastics Joint Stock Company"
        },
        {
            "Market": "HOSE",
            "Symbol": "AAM",
            "StockName": "CTCP THUY SAN MEKONG",
            "StockEnName": "Mekong Fisheries Joint Stock Company"
        }
    ],
    "message": "Success",
    "status": "Success",
    "totalRecord":2

GET SecuritiesDetails

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

To get securities details.

Details

Input

Field	Type	Required?	Description
market	string	No	HOSE | HNX | UPCOM | DER If not set, returns securities of all markets
symbol	string	No	If not set, returns all securities of defined markets
pageIndex	integer	Yes	From 1 to 10. Default value is 1
pageSize	integer	Yes	10; 20; 50; 100; 1000 Default value is 10

Output

Data	Type	Description
message	string	Message
status	number	Status
totalRecord	number	Total records
data	list	List data
RType	string	y
ReportDate	number	Date of report Format: dd/mm/yyyy
TotalNoSym	number	Total number of securities
repeatedinfoList	list	Data list
Isin	string	ISIN code
Symbol	string	Securities symbol. Used as key in trading activities.
SymbolName	string	Stock name in Vietnamese
SymbolEngName	string	Stock name in English
SecType	string	Securties Type: ST: Stock CW: Covered Warrant FU: Futures EF: ETF BO: BOND OF: OEF MF: Mutual Fund
Exchange	string	Exchange: HOSE HNX HNXBOND UPCOM DER
Issuer	string
LotSize	string
IssueDate	number
MaturityDate	Date
FirstTradingDate	Date
LastTradingDate	Date
ContractMultiplier	Date
SettlMethod	number
Underlying	string
PutOrCall	string
ExercisePrice	string
ExerciseStyle	number
ExcerciseRatio	string
ListedShare	string
TickPrice1	number
TickIncrement1	number
TickPrice2	number
TickIncrement2	number
TickPrice3	number
TickIncrement3	number
TickPrice4	number
TickIncrement4	number

Sample

Input: 
{
pageIndex : "1"
pageSize: "10"
market: "hose"
symbol: "SSI"
}
Output: 
{
  "data": [
    {
      "RType": "y",
      "ReportDate": "19/01/2023",
      "TotalNoSym": "1",
      "RepeatedInfo": [
        {
          "Isin": null,
          "Symbol": "SSI",
          "SymbolName": "CTCP CHUNG KHOAN SSI",
          "SymbolEngName": "SSI Securities Corporation",
          "SecType": "S",
          "MarketId": "HOSE",
          "Exchange": "HOSE",
          "Issuer": null,
          "LotSize": "100",
          "IssueDate": "",
          "MaturityDate": "",
          "FirstTradingDate": "",
          "LastTradingDate": "",
          "ContractMultiplier": "0",
          "SettlMethod": "",
          "Underlying": null,
          "PutOrCall": null,
          "ExercisePrice": "0",
          "ExerciseStyle": "",
          "ExcerciseRatio": "0",
          "ListedShare": "1501130137",
          "TickPrice1": null,
          "TickIncrement1": null,
          "TickPrice2": null,
          "TickIncrement2": null,
          "TickPrice3": null,
          "TickIncrement3": null,
          "TickPrice4": null,
          "TickIncrement4": null
        }
      ]
    }
  ],
  "message": "Success",
  "status": "Success",
  "totalRecord": 1
}

GET IndexComponents

https://fc-data.ssi.com.vn/api/v2/Market/IndexComponents

To get securities list of an index.

Details

Input

Field	Type	Required?	Description
Indexcode	string	Yes	Input one index code to get securities list
pageIndex	integer	Yes	From 1 to 10. Default value is 1
pageSize	integer	Yes	10; 20; 50; 100; 1000 Default value is 10

Output

Field	Type	Description
message	string
status	number
totalRecord	number
data	list	List data
IndexCode	string
IndexName	string
Exchange	string	HOSE|HNX
TotalSymbolNo	number	Total number of symbols in the index
IndexComponent	list
Isin	string
StockSymbol	string

Sample:

Input: 
{
pageIndex: "1"
pageSize: "10"
indexCode: "VN30"
}
Output: 
{
  "data": [
    {
      "IndexCode": "VN30",
      "IndexName": "VN30",
      "Exchange": "HOSE",
      "TotalSymbolNo": "30",
      "IndexComponent": [
        {
          "Isin": "ACB",
          "StockSymbol": "ACB"
        },
        {
          "Isin": "BCM",
          "StockSymbol": "BCM"
        }
        }
      ]
    }
  ],
  "message": "Success",
  "status": "Success",
  "totalRecord": 1
}

GET IndexList

https://fc-data.ssi.com.vn/api/v2/Market/IndexList

To get index list.

Details

Input

Field	Type	Required?	Description
exchange	string	Yes	HOSE | HNX
pageIndex	integer	Yes	From 1 to 10. Default 1
pageSize	integer	Yes	10; 20; 50; 100; 1000. Default 10

Output

Field	Type	Description
message	string
status	number
totalRecord	number
data	list	List data
IndexCode	string	Index code
IndexName	string	Index name
Exchange	string	Exchange: HOSE|HNX

Sample

Input: 
{
pageIndex: "1"
pageSize: "10"
exchange: "HOSE"
}
Output: 
{
  "data": [
    {
      "IndexCode": "VN100",
      "IndexName": "VN100",
      "Exchange": "HOSE"
    },
    {
      "IndexCode": "VN30",
      "IndexName": "VN30",
      "Exchange": "HOSE"
    }
  ],
  "message": "Success",
  "status": "Success",
  "totalRecord": 2

GET DailyOhlc

https://fc-data.ssi.com.vn/api/v2/Market/DailyOhlc

To get daily open, high, low, close, volume, value.

Details

Input

Field	Type	Required?	Description
symbol	string	No	Securities/Index code
fromDate	string	Yes	Default is today if not set. In dd/mm/yyyy format
toDate	string	Yes	Default is today if not set. In dd/mm/yyyy format
pageIndex	integer	Yes	From 1 to 10 Default 1
pageSize	integer	Yes	10; 20; 50; 100; 1000 Default 10
ascending	boolean	No	true/ false

Output

Field	Type	Description
message	string
status	number
totalRecord	number
data	list	List data
Symbol	String
Market	String	HOSE | HNX | UPCOM
TradingDate	Date	dd/mm/yyyy
Time	Timestamp
Open	Number
High	Number
Low	Number
Close	Number
Volume	Number	Total normal matched volume
Value	Number	Total normal matched value

Sample

Input: 
{
pageIndex: "1"
pageSize: "10"
Symbol: "SSI"
Fromdate: 10/08/2023
Todate: 13/08/2023
}
Output: 
{
  "data": [
    {
      "Symbol": "SSI",
      "Market": "HOSE",
      "TradingDate": "10/08/2023",
      "Time": null,
      "Open": "28600",
      "High": "28850",
      "Low": "28100",
      "Close": "28100",
      "Volume": "23382100",
      "Value": "663258204999.9850"
    },
    {
      "Symbol": "SSI",
      "Market": "HOSE",
      "TradingDate": "11/08/2023",
      "Time": null,
      "Open": "28250",
      "High": "28300",
      "Low": "27650",
      "Close": "28150",
      "Volume": "27536000",
      "Value": "769411290000.0090"
    }
  ],
  "message": "Success",
  "status": "Success",
  "totalRecord": 2
}

GET IntradayOhlc

https://fc-data.ssi.com.vn/api/v2/Market/IntradayOhlc

To get realtime open, high, low, close, volume of securities.

Details

Input

Field	Type	Required?	Description
symbol	string	No	Securities symbols, indexes
fromDate	string	Yes	If not set, default to today Format dd/mm/yyyy
toDate	string	Yes	If not set, default to today Format dd/mm/yyyy
pageIndex	integer	Yes	From 1 to 10 Default 1
pageSize	integer	Yes	10; 20; 50; 100; 1000 Default 10
ascending	boolean	No	true/ false
resollution	integer	No	Default 1 minute

Output

Field	Type	Description
message	string
status	number
totalRecord	number
data	list	List data
Symbol	String
Market	String
TradingDate	Date	Format dd/mm/yyyy
Time	Timestamp
Open	Number
High	Number
Low	Number
Close	Number
Volume	Number
Value	Number

Sample

Input: 
{
pageIndex: "1"
pageSize: "10"
Symbol: "SSI"
Fromdate: 14/08/2023
Todate: 14/08/2023
}
Output: 
{
data: [
{
Symbol: "SSI",
Value: "29150",
TradingDate: "14/08/2023",
Time: "14:45:04",
Open: "29150",
High: "29150",
Low: "29150",
Close: "29150",
Volume: "529200"
},
{
Symbol: "SSI",
Value: "29100",
TradingDate: "14/08/2023",
Time: "14:29:59",
Open: "29050",
High: "29150",
Low: "29050",
Close: "29100",
Volume: "166400"
}
],
message: "Success",
status: "Success",
totalRecord: 2
}

GET DailyIndex

https://fc-data.ssi.com.vn/api/v2/Market/DailyIndex

To get daily trading data of Index

Details

Input

Field	Type	Required?	Description
indexId	string	Yes	IndexID. The list of indexes can be retrieved by api getIndexList, or refer to this page.
fromDate	string	Yes	Default is today if not set. In dd/mm/yyyy format
toDate	string	Yes	Default is today if not set. In dd/mm/yyyy format
pageIndex	integer	Yes	From 1 to 10 Default 1
pageSize	integer	Yes	10; 20; 50; 100; 1000 Default 10
ascending	boolean	No	true/ false

Output

Field	Type	Description
message	string
status	number
totalRecord	number
data	list	List data
Indexcode	string
IndexValue	number
Trading Date	Date	Format dd/mm/yyyy
Time	Timestamp
Change	number
RatioChange	number
TotalTrade	number	Total trades (both normal and put-through)
Totalmatchvol	number	Total matched vol
Totalmatchval	number	Total matched value
TypeIndex	string
IndexName	string
Advances	number	Total number of symbols with increased price
Nochanges	number	Total number of symbols with unchanged price
Declines	number	Total number of declined symbols
Ceiling	number	Total number of symbols with ceiling price
Floor	number	Total number of symbols with floor price
Totaldealvol	number	Total put-through matched quantity
Totaldealval	number	Total put-through matched value
Totalvol	number	Total matched quantity (both normal and put-through)
Totalval	number	Total matched value (both normal and put-through)
TradingSession	string	Trading session
Market	string
Exchange	string	HOSE | HNX

Sample

Input: 
{
pageIndex: "1"
pageSize: "10"
indexID: "HNX30"
Fromdate: 14/08/2023
Todate: 14/08/2023
}
Output: 
{
data: [
{
IndexId: "HNX30",
IndexValue: "510.56",
TradingDate: "14/08/2023",
Time: null,
Change: "19.09",
RatioChange: "3.89",
TotalTrade: "0",
TotalMatchVol: "84693600",
TotalMatchVal: "1836008470000",
TypeIndex: null,
IndexName: "HNX30",
Advances: "21",
NoChanges: "4",
Declines: "5",
Ceilings: "2",
Floors: "0",
TotalDealVol: "2504000",
TotalDealVal: "60256000000",
TotalVol: "87197600",
TotalVal: "1896264470000",
TradingSession: "C"
}
],
message: "Success",
status: "Success",
totalRecord: 1
}

GET DailyStockPrice

 https://fc-data.ssi.com.vn/api/v2/Market/DailyStockPrice

To get daily price of securities.

Details

Input

Field	Type	Required?	Description
Symbol	string	No
fromDate	string	Yes	Default is today if not set. In dd/mm/yyyy format
toDate	string	Yes	Default is today if not set. In dd/mm/yyyy format
pageIndex	integer	Yes	From 1 to 10 Default 1
pageSize	integer	Yes	10; 20; 50; 100; 1000 Default 10
market	string	No	HOSE|HNX|UPCOM|DER|BOND

Output

Field	Type	Description
message	string
status	number
totalRecord	number
data	list	List data
Tradingdate	string
Symbol	string
Pricechange	string
Perpricechange	string
Ceilingprice	string
Floorprice	string
Refprice	string
Openprice	string
Highestprice	string
Lowestprice	string
Closeprice	string
Averageprice	string
Closepriceadjusted	string
Totalmatchvol	string
Totalmatchval	string
Totaldealval	string
Totaldealvol	string
Foreignbuyvoltotal	string
Foreigncurrentroom	string
Foreignsellvoltotal	string
Foreignbuyvaltotal	string
Toreignsellvaltotal	string
Totalbuytrade	string
Totalbuytradevol	string
Totalselltrade	string
Totalselltradevol	string
Netforeivol	string
Netforeignval	string
Totaltradedvol	string	Total traded vol, including odd lot
Totaltradedvalue	string	Total traded value, including odd lot
Time	string

Input: 
{
pageIndex: "1"
pageSize: "10"
symbol: "SSI"
market: "HOSE"
Fromdate: 19/07/2023
Todate: 19/07/2023
}
Output: 
{
data: [
{
TradingDate: "19/07/2023",
PriceChange: "-150",
PerPriceChange: "-0.70",
CeilingPrice: "21550",
FloorPrice: "18750",
RefPrice: "20150",
OpenPrice: "20950",
HighestPrice: "20950",
LowestPrice: "20000",
ClosePrice: "20000",
AveragePrice: "20118",
ClosePriceAdjusted: "17392",
TotalMatchVol: "18900",
TotalMatchVal: "380230000",
TotalDealVal: "0",
TotalDealVol: "0",
ForeignBuyVolTotal: "0",
ForeignCurrentRoom: "0",
ForeignSellVolTotal: "0",
ForeignBuyValTotal: "0",
ForeignSellValTotal: "0",
TotalBuyTrade: "0",
TotalBuyTradeVol: "0",
TotalSellTrade: "0",
TotalSellTradeVol: "0",
NetBuySellVol: "0",
NetBuySellVal: "0",
TotalTradedVol: "18900",
TotalTradedValue: "380230000",
Symbol: "HUB",
Time: null
}
],
message: "Success",
status: "Success",
totalRecord: 1
}

Sample