For the complete documentation index, see llms.txt. This page is also available as Markdown.

Danh sách các API

exchangeIDFastConnect Trading hỗ trợ API về Đặt/ Hủy/ Sửa lệnh, Chuyển tiền nội bộ, Nộp/ Rút ký quỹ, Chuyển chứng khoán, Ứng trước tiền bán, Đăng ký quyền mua và Tra cứu thông tin tài khoản.

Danh sách API

I. API lấy Token và xác thực 2FA

API
Method
Path

AccessToken

POST

Trading/AccessToken

GetOTP

POST

Trading/GetOTP

II. API tra cứu thông tin tài khoản cơ sở và phái sinh

API
Method
Path

orderBook

GET

Trading/orderBook

auditOrderBook

GET

Trading/auditOrderBook

cashAcctBal

GET

Trading/cashAcctBal

derivAcctBal

GET

Trading/derivAcctBal

ppmmraccount

GET

Trading/ppmmraccount

stockPosition

GET

Trading/stockPosition

derivPosition

GET

Trading/derivPosition

maxBuyQty

GET

Trading/maxBuyQty

maxSellQty

GET

Trading/maxSellQty

orderHistory

GET

Trading/orderHistory

rateLimit

GET

Trading/rateLimit

III. API đặt lệnh cơ sở/ phái sinh

API
Method
Path

NewOrder

POST

Trading/NewOrder

CancelOrder

POST

Trading/CancelOrder

derNewOrder

POST

Trading/derNewOrder

ModifyOrder

POST

Trading/ModifyOrder

derCancelOrder

POST

Trading/derCancelOrder

derModifyOrder

POST

Trading/derModifyOrder

IV. API Chuyển tiền nội bộ, Nộp/ Rút ký quỹ và Ứng trước tiền bán

API
Method
Path

cashInAdvanceAmount

GET

cash/cashInAdvanceAmount

unsettleSoldTransaction

GET

cash/unsettleSoldTransaction

transferHistories

GET

cash/transferHistories

cashInAdvanceHistories

GET

cash/cashInAdvanceHistories

estCashInAdvanceFee

GET

cash/estCashInAdvanceFee

vsdCashDW

POST

cash/vsdCashDW

transferInternal

POST

cash/transferInternal

createCashInAdvance

POST

cash/createCashInAdvance

V. API Chuyển chứng khoán

API
Method
Path

transferable

GET

stock/transferable

transferHistories

GET

stock/transferHistories

transfer

POST

stock/transfer

VI. API liên quan Đăng ký quyền mua

API
Method
Path

dividend

GET

ors/dividend

exercisableQuantity

GET

ors/exercisableQuantity

histories

GET

ors/histories

create

POST

ors/create

VII. API lệnh điều kiện

API
Method
Path

neworder

POST

fco/neworder

cancelorder

POST

fco/cancelorder

orderbook

GET

fco/orderbook

statusHistory

GET

fco/statusHistory

list

GET

fco/list

Yêu cầu Config

Method
Content
Content

Post

Header (Authorization, Content-Type)

Body (json)

Get

Header (Authorization)

Params

API Details

I. API lấy Token và xác thực 2FA

POST AccessToken

Dùng để tạo access token truy cập vào các api của FC Trading.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

consumerID

string

Yes

ConsumerID trong thông tin kết nối

consumerSecret

string

Yes

ConsumerSecret trong thông tin kết nối

code

string

No

Mã xác thực khi thực hiện giao dịch, nếu isSave = true thì bắt buộc truyền

TwoFactorType

string

Yes

Loại xác thực giao dịch của tài khoản, hỗ trợ type = 0 (PIN), type = 1 (OTP)

isSave

boolean

Yes

Lưu code khi giao dịch có các giá trị: true (hệ thống sẽ lưu PIN/OTP cho đến khi hết hiệu lực), false (các giao dịch lệnh đều cần truyền code)

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

accessToken

string

Token kết nối API

Ví dụ

  • Trường hợp thành công

  • Trường hợp lỗi

POST GetOTP

Dùng để lấy mã OTP nếu tài khoản đã đăng ký sử dụng SMS OTP và Email OTP.

Nếu lấy OTP quá 5 lần mà không xác thực thì dịch vụ OTP sẽ bị tạm khóa.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

consumerID

string

Yes

ConsumerID trong thông tin kết nối

consumerSecret

string

Yes

ConsumerSecret trong thông tin kết nối

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

Ví dụ

  • Trường hợp thành công

  • Trường hợp lỗi

II. API tra cứu thông tin tài khoản cơ sở và phái sinh

GET auditOrderBook

Trả ra lịch sử cập nhật của lệnh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản muốn truy vấn bao gồm Cơ sở và Phái sinh

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

uniqueID

string

ID lệnh của bên gửi

orderID

string

ID lệnh

buySell

string

Bên mua/ bán

price

number

Giá đặt

quantity

number

Khối lượng đặt

filledQty

string

Khối lượng khớp

orderStatus

string

Trạng thái lệnh

marketID

string

Mã sàn

inputTime

string

Thời gian đặt

modifiedTime

string

Thời gian cập nhật

instrumentID

string

Mã chứng khoán

orderType

string

Loại lệnh

cancelQty

string

Khối lượng hủy

avgPrice

string

Giá khớp trung binh

isForcesell

boolean

isShortsell

boolean

rejectReason

string

Lý do từ chối

lastErrorEvent

list

Thông tin lệnh hệ thống trả lỗi khi trùng orderID

Ví dụ

GET OrderBook

Tra cứu lệnh đặt trong ngày của cả tài khoản cơ sở và phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản muốn truy vấn bao gồm Cơ sở và Phái sinh

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

uniqueID

string

ID lệnh của bên gửi

orderID

string

ID lệnh

buySell

string

Bên mua/ bán

price

number

Giá đặt

quantity

number

Khối lượng đặt

filledQty

string

Khối lượng khớp

orderStatus

string

Trạng thái lệnh

marketID

string

Mã sàn

inputTime

string

Thời gian đặt

modifiedTime

string

Thời gian cập nhật

instrumentID

string

Mã chứng khoán

orderType

string

Loại lệnh

cancelQty

string

Khối lượng hủy

avgPrice

string

Giá khớp TB

isForcesell

boolean

isShortsell

boolean

rejectReason

string

Lý do từ chối

Ví dụ

GET orderHistory

Truy vấn lịch sử lệnh

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản muốn truy vấn bao gồm Cơ sở và Phái sinh

startDate

date

Yes

Ngày bắt đầu tìm kiếm

Định dạng dd/mm/yyyy

endDate

date

Yes

Ngày kết thúc tìm kiếm

Định dạng dd/mm/yyyy

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

orderHistories

list

Danh sách lịch sử lệnh

uniqueID

string

ID lệnh của bên gửi

orderID

string

ID lệnh

buySell

string

Bên mua/ bán

price

number

Giá đặt

quantity

number

Khối lượng đặt

filledQty

string

Khối lượng khớp

orderStatus

string

Trạng thái lệnh

marketID

string

Mã sàn

inputTime

string

Thời gian đặt

modifiedTime

string

Thời gian cập nhật

instrumentID

string

Mã chứng khoán

orderType

string

Loại lệnh

cancelQty

string

Khối lượng hủy

avgPrice

string

Giá khớp trung bình

isForcesell

boolean

isShortsell

boolean

rejectReason

string

Lý do từ chối

Ví dụ

GET ppmmrAccount

Truy vấn thông tin tài sản của tài khoản

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản muốn truy vấn bao gồm Cơ sở và Phái sinh

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

collateralAsset

number

Tài sản thế chấp

callLMW

number

Yêu cầu ký quỹ theo LMW

liability

number

Nghĩa vụ nợ phải trả

eeOrigin

number

Vốn gốc có thể sử dụng

forceLMV

number

Giá trị thị trường bị cưỡng chế

equity

number

Vốn chủ sở hữu (tổng tài sản trừ nợ phải trả)

ee

number

Vốn có thể sử dụng

callMargin

number

Lệnh báo ký quỹ

cashBalance

number

Số dư tiền mặt

purchasingPower

number

Sức mua

callForceSell

number

Lệnh bán cưỡng chế

lmv

number

Giá trị thị trường

marginCall

number

Yêu cầu bổ sung ký quỹ

withdrawal

number

Số tiền rút được

collateralA

number

Tài sản thế chấp

action

string

Trạng thái tài khoản/Hành động

marginRatio

number

Tỷ lệ ký quỹ

debt

number

Tổng dư nợ

accruedInterest

number

Lãi phải trả tích lũy

holdRight

number

Quyền nắm giữ

preLoan

number

Khoản vay trước

fees

number

Phí phải nộp

buyUnmatch

number

Lệnh mua chưa khớp

ap

number

Phải trả/Phải trả T+1

apT1

number

Phải trả/Phải trả T+1

sellUnmatch

number

Lệnh bán chưa khớp

cia

number

Tiền ứng trước (Cash in Advance)

ar

number

Phải thu/Phải thu T+1

arT1

number

Phải thu/Phải thu T+1

ppCredit

number

Sức mua tín dung

creditLimit

number

Hạn mức tín dụng

totalAssets

number

Tổng tài sản trong tài khoản

marginCallLMVSold

number

Giá trị thị trường đã bán do margin call

lmvNonMarginable

number

Giá trị thị trường cổ phiếu không ký quỹ được

eeCredit

number

Vốn có thể sử dụng tín dụng

totalEquity

number

Tổng vốn chủ sở hữu

eE90

number

Vốn sử dụng được theo tỷ lệ ký quỹ 90%/80%/70%/60%/50%

eE80

number

Vốn sử dụng được theo tỷ lệ ký quỹ 90%/80%/70%/60%/50%

eE70

number

Vốn sử dụng được theo tỷ lệ ký quỹ 90%/80%/70%/60%/50%

eE60

number

Vốn sử dụng được theo tỷ lệ ký quỹ 90%/80%/70%/60%/50%

eE50

number

Vốn sử dụng được theo tỷ lệ ký quỹ 90%/80%/70%/60%/50%

dividend

number

Cổ tức

Ví dụ

GET cashAccountBalance

Truy vấn thông tin tiền của tài khoản cơ sở.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản cơ sở muốn truy vấn

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

account

string

Số tài khoản cơ sở

cashbal

number

Tổng tiền mặt

cashonhold

number

Tiền bị phong tỏa

secureamount

number

Secure amount intraday

withdrawable

number

Số tiền có thể rút

receivingcasht1

number

Tiền bán chờ về ngày T1

receivingcasht2

number

Tiền bán chờ về ngày T2

matchedbuyvolume

number

Tiền khớp mua trong ngày

matchedsellvolume

number

Tiền khớp bán trong ngày

unmatchedbuyvolume

number

Tiền mua chứng khoán chờ khớp

unmatchedsellvolume

number

Tiền bán chứng khoán chờ khớp

paidcasht1

number

Tiền mua chứng khoán ngày T1

paidcasht2

number

Tiền mua chứng khoán ngày T2

cia

number

Số tiền ứng trước

debt

number

Dư nợ

purchasingpower

number

Sức mua

totalasset

number

Tổng tài sản

Ví dụ

GET stockPosition

Truy vấn danh mục của tài khoản cơ sở.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản cơ sở muốn truy vấn

Tên trường
Kiểu dữ liệu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

totalMarketValue

number

Tổng giá trị thị trường danh mục

= sum(maketprice * onhand)

stockPositions

list

Danh mục đầu tư của tài khoản

marketID

string

Mã sàn

instrumentID

string

Mã chứng khoán

onHand

number

Tổng khối lượng đang nắm giữ, bao gồm cả chứng khoán bán chưa thanh toán T0, T1; không bao gồm chứng khoán mua chờ thanh toán T0, T1 và chứng khoán quyền.

block

number

Phong tỏa

bonus

number

Cổ phiếu quyền quyền

buyT0

number

Mua khớp thanh toán ngày T0

buyT1

number

Mua khớp thanh toán ngày T1

buyT2

number

Mua khớp thanh toán ngày T2

sellT0

number

Bán khớp thanh toán ngày T0

sellT1

number

Bán khớp thanh toán ngày T1

sellT2

number

Bán khớp thanh toán ngày T2

avgPrice

number

Giá vốn trung bình

mortgage

number

Chứng khoán cầm cố

holdForTrade

number

Chứng khoán hạn chế chuyển nhượng

marketPrice

number

Giá trị trường

exchangeID

string

Mã sàn giao dịch

sellingQty

string

Khối lượng bán

buyingQty

string

Khối lượng mua

Ví dụ

GET derivativeAccountBalance

Kiểm tra số dư tiền tài khoản phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản phái sinh muốn truy vấn

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

account

string

Số tài khoản phái sinh

accountbalance

number

Tổng số dư tiền

fee

number

Phí

commission

number

Thuế

interest

number

Lãi

Loan

number

Nợ

deliveryamount

number

Giá trị chuyển giao

floatingpl

number

Lãi lỗ tạm tính

totalpl

number

Lãi lỗ vị thế

marginable

number

Số dư tối thiếu tiền

depositable

number

Tiền có thể ký quỹ

rccall

number

withdrawable

number

Tiền có thể rút

noncashdrawablerccall

number

Giá trị chứng khoán có thể rút

internalassets

list

Tài sản nội bộ bao gồm:

  • Cash

  • Validnoncash

  • totalvalue:

  • maxvalidnoncash

  • cashwithdrawable

  • Ee

exchangeassets

list

Tài sản ký quỹ bao gồm:

  • Cash

  • Validnoncash

  • totalvalue:

  • maxvalidnoncash

  • cashwithdrawable

  • Ee

internalmargin

list

Margin nội bộ bao gồm:

  • initialmargin

  • deliverymargin

  • marginreq

  • accountratio

  • usedlimitwarninglevel1

  • usedlimitwarninglevel2

  • usedlimitwarninglevel3

  • margincall

exchangemargin

list

Margin ký quỹ bao gồm:

  • marginreq

  • accountratio

  • usedlimitwarninglevel1

  • usedlimitwarninglevel2

  • usedlimitwarninglevel3

  • margincall

nav

number

Giá trị tài sản ròng

origMarginRatio

number

Tỷ lệ ký quỹ ban đầu

Ví dụ

GET derivativePosition

Truy vấn vị thế của tài khoản phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản phái sinh muốn truy vấn

querySummary

boolean

Yes

Mode net vị thế: - True: có net vị thế - False: không net vị thế

Dữ liệu
Kiểu dữ liệu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

account

string

Số tài khoản

openPositions

list

Mở vị thế

closePositions

list

Đóng vị thế

marketID

string

Mã sàn

instrumentID

string

Mã chứng khoán

longQty

number

Vị thế mở

shortQty

number

Vị thế đóng

net

number

Net

bidAvgPrice

number

Giá mua trung bình

askAvgPrice

number

Giá bán trung bình

tradePrice

number

Giá khớp

marketPrice

number

Giá thị trường

floatingPL

number

Lãi/ Lỗ tạm tính

tradingPL

number

Lãi/ Lỗ đã chốt

Ví dụ

GET maxBuyQty

Truy vấn số lượng mua tối đa, sử dụng cho cả tài khoản cơ sở và phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản muốn truy vấn bao gồm Cơ sở và Phái sinh

instrumentID

string

Yes

Mã chứng khoán

price

number

Yes

Giá

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

account

string

Số tài khoản

maxbuyqty

number

Khối lượng mua tối đa

marginRatio

number

tỷ lệ Margin

purchasingPower

number

Sức mua

origMarginRatio

number

Tỷ lệ ký quỹ ban đầu

Ví dụ

GET maxSellQty

Truy vấn số lượng bán tối đa, sử dụng cho cả tài khoản cơ sở và phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản muốn truy vấn bao gồm Cơ sở và Phái sinh

instrumentID

string

Yes

Mã chứng khoán

price

number

Yes

Giá

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

account

string

Số tài khoản

maxSellQty

number

Khối lượng bán tối đa

Ví dụ

III. API đặt lệnh cơ sở/ phái sinh

POST NewOrder

Dùng để đặt lệnh, sử dụng cho cả tài khoản cơ sở và phái sinh. Khi gửi thông tin lệnh thành công, api trả 200. Để xem lệnh có đẩy lên sàn thành công hay không cần kết nối streaming để nhận kết quả (hoặc call api oderBook)

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

instrumentID

string

Yes

Mã chứng khoán đặt lệnh

market

string

Yes

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

Yes

B: Buy

S: Sell

orderType

string

Yes

channelID

string

Yes

Kênh đặt lệnh Chỉ hỗ trợ mã TA (FCTrading API)

price

number

Yes

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Yes

Khối lượng đặt

account

string

Yes

Số tài khoản muốn đặt lệnh

requestID

string

Yes

ID đặt lệnh trong ngày. Bắt buộc 8 số random

stopOrder

string

Yes

Loại lệnh:

True: Nếu là lệnh điều kiện. Chỉ áp dụng cho tài khoản phái sinh.

False: nếu là lệnh thường

stopPrice

number

Yes

Giá đặt mong muốn cắt lỗ/chốt lãi

Nếu stopOrder = true -> stopPrice > 0

stopType

string

Yes

Loại điều kiện. Bắt buộc nhập nếu stopType = true

- D: Down

- U: Up

- V: Trailling Up

- E: Trailing Down

- O: OCO

- B: BullBear

stopStep

number

Yes

Bước chốt lỗ, chỉ dùng cho lệnh điều kiện BullBear (stopType = B)

profitStep

number

Yes

Bước chốt lãi, chỉ dùng cho lệnh điện BullBear (stopType = B)

code

number

No

Trading code: PIN, OTP

Nếu API Xác thực người dùng input: isSave = false, code bắt buộc điền

deviceId

string

Yes

userAgent

string

No

Tác nhân người dùng

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

requestID

string

ID của lệnh gửi

requestData

string

Dữ liệu yêu cầu

instrumentID

string

mã chứng khoán đặt lệnh

marketID

string

Thị trường:

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

buy (B): mua/Sell (S): bán đã đặt theo orderID của lệnh

B: Buy

S: Sell

orderType

string

channelID

string

Kênh đặt lệnh VD: TA (trader API)

price

number

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Khối lượng đặt

account

string

Số tài khoản muốn đặt lệnh:

xxxxxx1: Cơ sở

xxxxxx8: Phái sinh

requestID

string

ID đặt lệnh trong ngày. Bắt buộc 8 số random

stopOrder

string

Loại lệnh:

True: Đối với lệnh điều kiện

False: Đối với lệnh thường

stopPrice

number

Giá đặt mong muốn cắt lỗ/chốt lãi

Nếu stopOrder = true -> stopPrice > 0s

stopType

string

Loại điều kiện. Bắt buộc nhập nếu stopType = true

- D: Down

- U: Up

- V: Trailling Up

- E: Trailing Down

- O: OCO

- B: BullBear

stopStep

number

Bước chốt lỗ, chỉ dùng cho lệnh điều kiện BullBear (stopType = B)

profitStep

number

Bước chốt lãi, chỉ dùng cho lệnh điện BullBear (stopType = B)

forceSell

boolean

Đánh dấu có phải lệnh forceSell không

modifiable

boolean

Đánh dấu có cho phép sửa lệnh không

note

string

Ghi chú với lệnh

brokerID

string

Mã môi giới

Ví dụ

  • Thành công

  • Trường hợp lỗi

POST ModifyOrder

Dùng để sửa lệnh, sử dụng cho cả tài khoản cơ sở và phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

orderID

string

Yes

ID của lệnh

instrumentID

string

Yes

mã chứng khoán đặt lệnh

marketID

string

Yes

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

Yes

B: Buy

S: Sell

orderType

string

Yes

channelID

string

Yes

Kênh đặt lệnh Chỉ hỗ trợ mã TA (FCTrading API)

price

number

Yes

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Yes

Khối lượng đặt

account

string

Yes

requestID

string

Yes

ID duy nhất của yêu cầu do client sinh. Bao gồm 8 kí tự số.

code

number

No

Trading code: PIN, OTP

Nếu API Xác thực người dùng input: isSave = false, code bắt buộc điền

deviceId

string

Yes

Định danh thiết bị xuất phát yêu cầu.

userAgent

string

No

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

requestID

string

ID của lệnh gửi

requestData

string

Dữ liệu yêu cầu

instrumentID

string

mã chứng khoán đặt lệnh

market

string

Sàn:

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

buy (B): mua/Sell (S): bán đã đặt theo orderID của lệnh

B: Buy

S: Sell

orderType

string

price

number

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Khối lượng đặt

orderID

string

ID của lệnh

account

string

Số tài khoản

note

string

Ghi chú với lệnh

brokerId

string

Mã môi giới

Ví dụ

  • Thành công

  • Trường hợp lỗi

POST CancelOrder

Sử dụng để hủy lệnh, sử dụng cho cả tài khoản cơ sở và phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

orderID

string

Yes

ID của lệnh

instrumentID

string

Yes

mã chứng khoán đặt lệnh

market

string

Yes

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

Yes

B: Buy

S: Sell

orderType

string

Yes

channelID

string

Yes

Kênh đặt lệnh Chỉ hỗ trợ mã TA (FCTrading API)

price

number

Yes

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Yes

Khối lượng đặt

account

string

Yes

requestID

string

Yes

code

number

No

Trading code: PIN, OTP

Nếu API Xác thực người dùng input: isSave = false, code bắt buộc điền

deviceId

string

Yes

Định danh thiết bị xuất phát yêu cầu.

userAgent

string

No

Tác nhân người dùng

VD: FCTrading

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

requestData

string

Dữ liệu yêu cầu

instrumentID

string

mã chứng khoán đặt lệnh

marketID

string

Sàn:

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

buy (B): mua/Sell (S): bán đã đặt theo orderID của lệnh

B: Buy

S: Sell

orderType

string

price

number

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Khối lượng đặt

orderID

string

ID của lệnh

account

string

Số tài khoản

Ví dụ

  • Thành công

  • Trường hợp lỗi

POST derNewOrder

Dùng để đặt lệnh phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

instrumentID

string

Yes

mã chứng khoán đặt lệnh

market

string

Yes

VNFE: thị trường phái sinh

buySell

string

Yes

B: Buy

S: Sell

orderType

string

Yes

channelID

string

Yes

Kênh đặt lệnh Chỉ hỗ trợ mã TA (FCTrading API)

price

number

Yes

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Yes

Khối lượng đặt

account

string

Yes

Số tài khoản muốn đặt lệnh:

xxxxxx8: Phái sinh

requestID

string

Yes

ID đặt lệnh trong ngày. Bắt buộc 8 số random

stopOrder

string

Yes

Loại lệnh:

True: Đối với lệnh điều kiện

False: Đối với lệnh thường

stopPrice

number

Yes

Giá đặt mong muốn cắt lỗ/chốt lãi

Nếu stopOrder = true -> stopPrice > 0s

stopType

string

Yes

Loại điều kiện. Bắt buộc nhập nếu stopType = true

- D: Down

- U: Up

- V: Trailling Up

- E: Trailing Down

- O: OCO

- B: BullBear

stopStep

number

Yes

Bước chốt lỗ, chỉ dùng cho lệnh điều kiện BullBear (stopType = B)

profitStep

number

Yes

Bước chốt lãi, chỉ dùng cho lệnh điện BullBear (stopType = B)

code

number

No

Trading code: PIN, OTP

Nếu API Xác thực người dùng input: isSave = false, code bắt buộc điền

deviceId

string

Yes

Thiết bị định danh từ máy tính (lap) khách hàng cài đặt

userAgent

string

No

Tác nhân người dùng

VD: FCTrading

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

requestID

string

ID của lệnh gửi

requestData

string

Dữ liệu yêu cầu

instrumentID

string

mã chứng khoán đặt lệnh

marketID

string

Thị trường:

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

buy (B): mua/Sell (S): bán đã đặt theo orderID của lệnh

B: Buy

S: Sell

orderType

string

channelID

string

Kênh đặt lệnh VD: TA (trader API)

price

number

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Khối lượng đặt

account

string

Số tài khoản muốn đặt lệnh:

xxxxxx1: Cơ sở

xxxxxx8: Phái sinh

requestID

string

ID đặt lệnh trong ngày. Tối đa 8 số random

stopOrder

string

Loại lệnh:

True: Đối với lệnh điều kiện

False: Đối với lệnh thường

stopPrice

number

Giá đặt mong muốn cắt lỗ/chốt lãi

Nếu stopOrder = true -> stopPrice > 0

stopType

string

Loại điều kiện. Bắt buộc nhập nếu stopType = true

- D: Down

- U: Up

- V: Trailling Up

- E: Trailing Down

- O: OCO

- B: BullBear

stopStep

number

Bước chốt lỗ, chỉ dùng cho lệnh điều kiện BullBear (stopType = B)

profitStep

number

Bước chốt lãi, chỉ dùng cho lệnh điện BullBear (stopType = B)

forceSell

boolean

Đánh dấu có phải lệnh forceSell không?

modifiable

boolean

Đánh dấu có cho phép sửa lệnh không?

note

string

Ghi chú với lệnh

brokerID

string

Mã môi giới

Ví dụ

  • Thành công

  • Trường hợp lỗi

POST derModifyOrder

Dùng để sửa lệnh phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

orderID

string

Yes

ID của lệnh

instrumentID

string

Yes

mã chứng khoán đặt lệnh

marketID

string

Yes

Sàn:

VNFE: thị trường phái sinh

buySell

string

Yes

buy (B): mua/Sell (S): bán đã đặt theo orderID của lệnh

B: Buy

S: Sell

orderType

string

Yes

channelID

string

Yes

Kênh đặt lệnh Chỉ hỗ trợ mã TA (FCTrading API)

price

number

Yes

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Yes

Khối lượng đặt

account

string

Yes

Số tài khoản muốn đặt lệnh:

xxxxxx8: Phái sinh

requestID

string

Yes

ID đặt lệnh trong ngày. Bắt buộc 8 số random

code

number

No

Trading code: PIN, OTP

Nếu API Xác thực người dùng input: isSave = false, code bắt buộc điền

deviceId

string

Yes

Thiết bị định danh từ máy tính (lap) khách hàng cài đặt

userAgent

string

No

Tác nhân người dùng

VD: FCTrading

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

requestID

string

ID của lệnh gửi

requestData

string

Dữ liệu yêu cầu

instrumentID

string

mã chứng khoán đặt lệnh

market

string

Sàn:

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

buy (B): mua/Sell (S): bán đã đặt theo orderID của lệnh

B: Buy

S: Sell

orderType

string

price

number

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Khối lượng đặt

orderID

string

ID của lệnh

account

string

Số tài khoản

note

string

Ghi chú lệnh

BrokerId

string

Mã môi giới

Ví dụ

  • Thành công

  • Trường hợp lỗi

POST derCancelOrder

Dùng để hủy lệnh phái sinh.

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

orderID

string

Yes

ID của lệnh

instrumentID

string

Yes

mã chứng khoán của lệnh

market

string

Yes

VNFE: thị trường phái sinh

buySell

string

Yes

buy (B): mua/Sell (S): bán đã đặt theo orderID của lệnh

B: Buy

S: Sell

orderType

string

Yes

channelID

string

Yes

Kênh đặt lệnh Chỉ hỗ trợ mã TA (FCTrading API)

price

number

Yes

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Yes

Khối lượng đặt

account

stri

requestID

string

Yes

ID đặt lệnh trong ngày. Bắt buộc 8 số random

code

number

No

Trading code: PIN, OTP

Nếu API Xác thực người dùng input: isSave = false, code bắt buộc điền

deviceId

string

Yes

userAgent

string

No

Dữ liệu
Kiểu
Mô tả

message

string

Thông báo trả ra khi call api

status

number

Trạng thái

data

list

List data

requestData

string

Dữ liệu yêu cầu

instrumentID

string

mã chứng khoán đặt lệnh

marketID

string

Sàn:

VN: thị trường cơ sở

VNFE: thị trường phái sinh

buySell

string

buy (B): mua/Sell (S): bán đã đặt theo orderID của lệnh

B: Buy

S: Sell

orderType

string

price

number

Giá đặt lệnh:

- Nếu loại lệnh là LO -> Giá đặt > 0

- Nếu loại lệnh khác LO -> Giá đặt = 0

quantity

number

Khối lượng đặt

orderID

string

ID của lệnh

account

string

Số tài khoản

Ví dụ

  • Thành công

  • Trường hợp lỗi

GET rateLimit

Truy vấn thông tin những API được set rateLimit

Thông tin chi tiết

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tin dữ liệu trả ra

endpoint

string

Thông tin set rateLimit bao gồm 1 trong các trường hợp sau: * -> Toàn bộ các API post:* -> Toàn bộ các API method POST get:* -> Toàn bộ các API method GET *:*/api_name -> rateLimit riêng từng API

period

string

Thời gian giới hạn (s,m,h,d)

limit

number

Số lần giới hạn

Ví dụ

IV. API Chuyển tiền nội bộ, Nộp/ Rút ký quỹ và Ứng trước tiền bán

GET cashInAdvanceAmount

Trả danh sách giao dịch Ứng trước tiền bán và thông tin số tiền có thể ứng

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản muốn truy vấn

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tin dữ liệu trả ra

account

string

Số tài khoản

ciaAmounts

list

Thông tin số tiền có thể ứng

dueDate

string

Ngày tiền về

Định dạng: dd/mm/yyyy

sellValue

number

Giá trị bán chứng khoán

netSellValue

number

Tiền bán đã trừ phí thuế

advance

number

Tiền đã ứng

cashAdvance

number

Tiền có thể ứng

Ví dụ

GET unsettleSoldTransaction

Trả danh sách giao dịch chưa thanh toán (tiền chưa về tài khoản)

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

settleDate

string

No

Ngày tất toán

Định dạng: dd/mm/yyyy

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

unsettledSoldTransactions

list

Danh sách đã bán chưa xử lý

tradeDate

string

Ngày bán Chứng khoán

instrumentID

string

Mã chứng khoán

netSellValue

number

Tiền bán khớp (đã trừ phí thuế)

quantity

number

Khối lượng

price

number

Giá khớp

Ví dụ

GET transferHistories

Tra cứu thông tin Lịch sử chuyển tiền nội bộ và Nộp/Rút kỹ quỹ

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

fromDate

string

Yes

Ngày bắt đầu tìm kiếm

Định dạng: dd/mm/yyyy

toDate

string

Yes

Ngày kết thúc tìm kiếm Định dạng: dd/mm/yyyy

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

transferHistories

list

Danh sách lịch sử chuyển tiền và Nộp/Rút ký quỹ

transactionID

string

Mã chi nhánh ngân hàng

date

string

Ngày thực hiện giao dịch

account

string

Số tài khoản chuyển

beneficiaryAccount

string

Số tài khoản nhận

amount

number

Số tiền

bankName

string

Ngân hàng nhận

bankBranchName

string

Chi nhánh ngân hàng nhận

beneficiary

string

Tên người nhận

remark

string

Nội dung

type

string

Loại giao dịch (Nộp/ Rút)

status

string

Trạng thái chuyển

Ví dụ

GET cashInAdvanceHistories

Truy vấn lịch sử giao dịch ứng trước tiền bán

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

fromDate

string

Yes

Ngày bắt đầu tìm kiếm

Định dạng: dd/mm/yyyy

toDate

string

Yes

Ngày kết thúc tìm kiếm Định dạng: dd/mm/yyyy

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

ciaHistories

list

Danh sách lịch sử ứng trước tiền bán

transactionID

string

Mã chi nhánh ngân hàng

date

string

Ngày thực hiện giao dịch

totalAmount

number

Tổng số tiền đã ứng

status

string

Trạng thái giao dịch

detai

list

Bản ghi lặp lại của giao dịch

type

string

Loại giao dịch (I: Fee và D & W: ciaAmount)

value

number

Số tiền đã ứng trước, phí

settleDate

string

Ngày tiền về của giao dịch Ứng trước tiền bán

Lưu ý:

  • Tìm kiếm fromDate - toDate không quá 1 tháng

  • Thời gian tìm kiếm quá khứ không quá 6 tháng

Ví dụ

GET estCashInAdvanceFee

Truy vấn mức phí của giao dịch Ứng trước tiền bán

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

ciaAmount

string

No

Số tiền muốn ứng trước

receiveAmount

string

No

Số tiền nhận được

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

ciaAmount

number

Số tiền ứng trước tiền bán

receiveAmount

number

Số tiền nhận được

fee

number

Mức phí

Ví dụ

POST vsdCashDW

Tạo giao dịch nộp/ rút phái sinh

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn

amount

number

Yes

Số tiền

type

string

Yes

Loại giao dịch D = Nộp W = Rút

remark

string

No

Mô tả nội dung tạo giao dịch

code

string

No

isSave = false -> Điền PIN/ OTP tùy phương thức xác thực isSave = true -> Không cần điền

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

transactionID

string

Số hiệu giao dịch

Ví dụ

  • Thành công

  • Lỗi

POST transferInternal

Tạo giao dịch chuyển tiền giữa các tài khoản Cơ sở hoặc chuyển tiền từ tài khoản Phái sinh sang Cơ sở

Lưu ý:

Số tài khoản nguồn và Số tài khoản nhận phải cùng tên và chỉ được chuyển tiền giữa các tiểu khoản

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn

beneficiaryAccount

string

Yes

Số tài khoản nhận

amount

number

Yes

Số tiền

remark

string

No

Mô tả nội dung tạo giao dịch

code

string

No

isSave = false -> Điền PIN/ OTP tùy phương thức xác thực isSave = true -> Không cần điền

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

transactionID

string

Số hiệu giao dịch

Ví dụ

  • Thành công

  • Lỗi

POST createCashInAdvance

Tạo giao dịch ứng trước tiền bán

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

ciaAmount

string

No

Số tiền muốn ứng trước

receiveAmount

string

No

Số tiền nhận được

code

string

Yes

Mã OTP/PIN cần nhập trước khi làm giao dịch

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

transactionID

string

Số hiệu giao dịch

Ví dụ

  • Thành công

  • Lỗi

Giao dịch liên quan đến đăng ký quyền mua

GET dividend

Truy vấn thông tin cổ tức bằng tiền, Chứng khoán mà khách hàng được nhận (không phải đăng ký)

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

dividends

list

Danh sách cổ tức

stockDividend

string

Loại hưởng quyền bao gồm: - STOCK DIVIDEND

- CASH DIVIDEND

- BONUS ISSUE

- EXERCISE CW

- EXERCISE RIGHTS

instrumentID

string

Mã chứng khoán

quantity

number

Số lượng chứng khoán hưởng quyền

executedRate

string

Tỉ lệ

closeDate

string

Ngày chốt quyền Định dạng: dd/mm/yyyy

paidDate

string

Ngày thực hiện Định dạng: dd/mm/yyyy

amount

number

Số tiền nhận được

status

string

Tình trạng

receivedQuantity

number

Số chứng khoán nhận được

issueInstrument

string

Mã chứng khoán được nhận

distributedFlag

string

Cờ phân bổ

payableDate

string

Ngày dự kiến Định dạng: dd/mm/yyyy

subscriptionPrice

number

Giá đăng ký

subscriptionAmount

number

Số tiền đăng ký

subscriptionQuantity

number

Khối lượng đăng ký

subscriptionPeriodFrom

string

Ngày đăng ký từ Định dạng: dd/mm/yyyy

subscriptionPeriodTo

string

Ngày đăng ký đến Định dạng: dd/mm/yyyy

entitlementID

string

Mã sự kiện quyền

exchangeID

string

Mã sàn giao dịch (HOSE/HNX/UPCOM)

Ví dụ

GET exercisableQuantity

Truy vấn số lượng chứng khoán có thể thực hiện đăng ký quyền

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

exercisableQuantities

list

Danh sách số lượng chứng khoán có thể thực hiện

entitlementID

string

Mã quyền

instrumentID

string

Mã chứng khoán

subscriptionPrice

number

Giá mua

executedRateFrom

number

Tỉ lệ từ

subscriptionPeriodFrom

string

Ngày bắt đầu đăng ký quyền Định dạng: dd/mm/yyyy

subscriptionPeriodTo

string

Hạn đăng ký Định dạng: dd/mm/yyyy

exerciseableQuantity

number

Số chứng khoán hưởng quyền

exerciseableReceiveQuantity

number

Số chứng khoán còn được mua

exercisedReceiveQuantity

number

Số chứng khoán đã đăng ký mua

executedRateTo

number

Ngày đăng ký từ Định dạng: dd/mm/yyyy

exercisedQuantity

number

Số lượng thực hiện

payableDate

string

Ngày dự kiến thanh toán Định dạng: dd/mm/yyyy

Ví dụ

GET histories

Truy vấn lịch sử giao dịch đăng ký quyền mua

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

startDate

string

Yes

Ngày bắt đầu tìm kiếm Định dạng: dd/mm/yyyy

endDate

string

Yes

Ngày kết thúc tìm kiếm Định dạng: dd/mm/yyyy

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

onlineRightSubscriptionHistories

list

Danh sách giao dịch đăng ký quyền mua

transactionID

string

ID của giao dịch

dateTime

string

Thời gian yêu cầu

instrumentID

string

Mã chứng khoán

ratioFrom

number

Tỉ lệ từ

subscriptionPrice

number

Giá mua

subscriptionPeriodFrom

string

Ngày bắt đầu đăng ký Định dạng: dd/mm/yyyy

subscriptionPeriodTo

string

Hạn đăng ký quyền Định dạng: dd/mm/yyyy

exercisedReceivedQty

number

Số chứng khoán đã đăng ký mua

amount

number

Số tiền đã nộp

status

string

Tình trạng

ratioTo

number

Tỉ lệ đến

underlyingInstrumentID

string

Mã chứng khoán tham chiếu

Lưu ý:

  • Tìm kiếm startDate - endDate không quá 1 tháng

  • Thời gian tìm kiếm quá khứ không quá 1 năm

Ví dụ

POST create

Tạo giao dịch đăng ký quyền

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản

instrumentID

string

Yes

Mã chứng khoán

entitlementID

string

Yes

Mã quyền

quantity

number

Yes

Khối lượng

amount

number

Yes

Số tiền

code

string

No

Mã OTP/PIN cần nhập trước khi làm giao dịch

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

transactionID

string

Số hiệu giao dịch

Ví dụ

  • Thành công

  • Lỗi

V. API Chuyển chứng khoán

GET transferable

Truy vấn thông tin số lượng chứng khoán có thể chuyển nhượng của tài khoản

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

transferableStocks

list

Danh sách thông tin số lượng mã chứng khoán có thể chuyển nhượng

instrumentID

string

Mã chứng khoán

quantity

number

Khối lượng

instrumentType

string

Loại mã chứng khoán

Ví dụ

GET transferHistories

Truy vấn lịch sử giao dịch chuyển nhượng chứng khoán giữa các tài khoản

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn truy vấn

startDate

string

Yes

Ngày bắt đầu tìm kiếm

Định dạng: dd/mm/yyyy

endDate

string

Yes

Ngày kết thúc tìm kiếm Định dạng: dd/mm/yyyy

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

stockTransferHistories

list

Danh sách thông tin số lượng mã chứng khoán có thể chuyển nhượng

transactionID

string

ID của giao dịch

beneficiaryAccount

string

Số tài khoản nhận

instrumentID

string

Mã chứng khoán

quantity

number

Khối lượng

dateTime

string

Thời gian thực hiện

status

string

Trạng thái

remark

string

Lý do

auditRemark

string

Lưu ý:

  • Tìm kiếm startDate - endDate không quá 1 tháng

  • Thời gian tìm kiếm quá khứ không quá 6 tháng

Ví dụ

POST transfer

Tạo giao dịch chuyển chứng khoán có trong danh mục giữa các tài khoản cơ sở

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

account

string

Yes

Số tài khoản nguồn

beneficiaryAccount

string

Yes

Số tài khoản nhận

exchangeID

string

Yes

Mã sàn

instrumentID

string

Yes

Mã chứng khoán

quantity

number

Yes

Khối lượng

code

string

No

isSave = false -> Điền PIN/ OTP tùy phương thức xác thực isSave = true -> Không cần điền

Dữ liệu
Kiểu
Mô tả

message

string

Mô tả msg call API

status

number

Trạng thái

data

list

Thông tn dữ liệu trả ra

account

string

Số tài khoản

transactionID

string

Số hiệu giao dịch

Ví dụ

  • Thành công

  • Lỗi

VI. API liên quan Đăng ký quyền mua

Chưa update

VII. API Lệnh điều kiện

POST newOrder

Uses: Đặt lệnh điều kiện & kích hoạt lệnh điều kiện.

Authen: Bearer token

Header: "Content-Type":"application/json" and "User-Agent":"fctrading application for customer 123456"

Thông tin chi tiết

Dữ liệu
Kiểu
Bắt buộc
Mô tả

instrumentID

string

Y

Mã chứng khoán. Mã chứng khoán, đối với mã phái sinh thì truyền theo mã 1M, 2M, 1Q, 2Q, VN30FYYMM ( Mã tổng quát và chi tiết phái sinh)

quantity

number

Y

Khối lượng muốn đặt lệnh

price

string

N

Giá đặt (đơn vị đồng): 23500/MP/MOK/MTL

Ví dụ: đặt giá mua SSI: 24000

priceSlip

number

N

Khoảng trượt giá (đơn vị đồng).

Ví dụ: trượt giá 300 khi đặt giá SSI 24000. Lệnh tìm giá khớp tốt nhất từ 23700 → 24300

account

string

Y

Tiểu khoản muốn đặt lệnh: ví dụ tài khoản đuôi 8 đuôi 6

fromDate

string

N

Ngày bắt đầu thực hiên lệnh, định dạng dd/MM/yyyy HH:mm:ss. Nếu không truyền thì tính từ lúc tạo thành công

toDate

string

N

Ngày kết thúc, định dạng dd/MM/yyyy HH:mm:ss. Nếu không truyền thì tính đến 24 giờ kể từ lúc tạo. Chỉ được truyền tối đa 31 ngày kể từ ngày fromDate

code

string

N

Mã OTP (Nếu đã lưu thì không cần truyền)

userAgent

string

Y

Agent sử dụng API FCTrading

deviceId

string

Y

Định danh máy người dùng: MAC

type

string

Y

Loại lệnh điều kiện: hiện hỗ trợ các lệnh điều kiện

· "stop_limit": Stop limit

· "stop": Stop

· "gtd": Good till Date

· "bullbear": lệnh điều kiện Bull Bear

· "oco": One cancel the other

· "trailing_stop": Trailing Stop

· "trailing_stop_limit": Trailing Stop Limit

Tham chiếu thêm sang mục:

FCO và các tham số điền theo từng loại lệnh

Tham số lệnh điều kiện

stopPrice

number

N

Giá đặt

side

string

Y

Loại lệnh (B/ S)

activePrice

number

N

Giá thực hiện ban đầu

trailingAmount

number

N

Khoảng trượt giá

tpActivePrice

number

N

Giá thực hiện chốt lời ban đầu

slActivePrice

number

N

Giá thực hiện cắt lỗ ban đầu

tpPrice

string

N

Giá chốt lời. Giá đặt (đơn vị đồng): 23500/MP/MOK/MTL

slPrice

string

N

Giá cắt lỗ. Giá đặt (đơn vị đồng): 23500/MP/MOK/MTL

tpSlip

number

N

Khoảng chốt lời

slSlip

number

N

Khoảng cắt lỗ

operator

string

N

Dấu cho phép chọn để hỗ trợ biểu thức so sánh kích hoạt lệnh Bao gồm:

Các tham số theo từng loại lệnh điều kiện.

  • greater_or_equal: >=

  • equal: =

  • greater: >

  • lesser: <

  • lesser_or_equal: <=

Tham chiếu sang:

FCO và các tham số điền theo từng loại lệnh để xem ví dụ cho từng loại lệnh

Trường dữ liệu
Kiểu
Mô tả

status

string

Tham chiếu sang:

FCO status code

message

string

Thông báo lỗi

fcoid

string

ID lệnh điều kiện

Ví dụ

  • Trường hợp thành công

  • Trường hợp lỗi

POST cancelOrder

Uses: Hủy kích hoạt lệnh điều kiện

Authen: Bearer token

Header: "Content-Type":"application/json" and "User-Agent":"fctrading application for customer 123456"

Thông tin chi tiết

Trường dữ liệu
Kiểu
Bắt buộc
Mô tả

fcoid

string

Y

ID của lệnh điều kiện

code

string

Y

Mã OTP

userAgent

string

Y

Agent sử dụng API FCTrading

deviceId

string

Y

Định danh máy người dùng: MAC

Trường dữ liệu
Kiểu dữ liệu
Mô tả

status

string

Tham chiếu sang:

FCO status code

message

string

Thông báo lỗi

fcoid

string

ID lệnh điều kiện

Ví dụ

  • Trường hợp thành công

  • Trường hợp lỗi

GET orderBook

Uses: Lấy danh sách các lệnh (order) trigger bởi lệnh điều kiện

Authen: Bearer token

Header: "Content-Type":"application/json" and "User-Agent":"fctrading application for customer 123456"

Thông tin chi tiết

Trường dữ liệu
Kiểu
Bắt buộc
Mô tả

fcoid

string

Y

ID của lệnh điều kiện

pageIndex

Number

N

Trang muốn truy vấn. Mặc định là 1

pageSize

Number

N

Kích cỡ của trang truy vấn. Mặc định là 20

api/v2/fco/orderbook?fcoid= {fcoid}&pageIndex={page}&pageSize={size}

status

string

Tham chiếu sang:

FCO status code

message

string

Thông báo lỗi

itemsCount

string

Tổng số bản ghi

pageCount

string

Tổng số trang

pageNumber

string

Số trang hiện tại

pageSize

string

Số bản ghi trong 1 trang

data

json

{mảng các orders trigger bởi dcoId tương ứng}

fcoId

string

Mã lệnh điều kiện

accountNo

string

Tài khoản đặt lệnh

quantity

number

Khối lượng muốn đặt lệnh

price

string

Giá đặt lệnh

symbol

string

Mã chứng khoán

side

string

Loại lệnh (buy/sell)

orderType

string

Loại lệnh: LO, MP, MTL…

runningMode

boolean

Kiểu thực hiện điều kiện:

mainOrder

boolean

Có phải lệnh chính hay không

attachedOrder

boolean

Có phải lệnh đính kèm hay không

createdTime

string

Thời gian đặt lệnh

updatedTime

string

Thời gian cập nhật lệnh

uniquedId

string

Số hiệu lệnh của hệ thống

orderId

string

Số hiệu lệnh được ghi nhận

filledQuantity

number

Khối lượng đã khớp

osQuantity

number

Khối lượng còn lại

avgPrice

number

Giá khớp trung bình

status

string

Trạng thái lệnh:

- RQ: request - lệnh tại QEN chưa vào TAPI

- WA: Waiting Approval – Chờ duyệt

- RS: Ready to Send Exchange – Chờ gửi lên sàn

- SD: Send to Exchange - Đã gửi lên sàn

- QU: Queue in Exchange - Chờ khớp tại sàn

- PF: partially_filled - lệnh khớp 1 phần

- FF: fully_filled - lệnh khớp toàn bộ

- FFPC: fully_filled_partially_cancel - khớp một phần, hủy phần còn lại

- WM: Waiting Modify – Chờ sửa

- WC: Wait Cancel – Chờ hủy

- RJ: reject - lệnh đã bị hủy

- ERR: error - khi thông tin lệnh gửi đi có lỗi

- CL: cancel - lệnh đã hủy

- EX: expired - lệnh hết hiệu lực

Ví dụ

  • Trường hợp thành công

  • Trường hợp lỗi

GET list

Uses: Lấy danh sách các lệnh điều kiện đã tạo

Authen: Bearer token

Header: "Content-Type":"application/json" and "User-Agent":"fctrading application for customer 123456"

Thông tin chi tiết

Trường dữ liệu
Kiểu
Bắt buộc
Mô tả

fcoid

string

N

ID của lệnh điều kiện

account

string

N

Tài khoản đặt lệnh

type

string

N

Loại lệnh điều kiện: "stop_limit"; "stop"; "gtd"; "bullbear"; "oco"; "trailing_stop"; "trailing_stop_limit";

processStatus

string

N

Trạng thái của lệnh điều kiện: hỗ trợ filter nhiều giá trị, ngăn cách nhau bởi dấu phẩy (Ex: WAIT, EXP):

  • INIT: initial – khởi tạo điều kiện

  • WAIT: waiting - chờ thỏa điều kiện

  • TRI: triggered - đã kích hoạt

  • WC: waiting cancel - chờ hủy điều kiện

  • TER: terminated - đã hủy

  • TRIT: triggered_terminated - đã kích hoạt bị hủy

  • FIS: finish - hoàn thành

  • EXP: expired - hết hiệu lực

  • ERR: Error – Từ chối

instrumentID

string

N

Mã chứng khoán, hơp đồng

side

string

N

Loại lệnh buy/sell (B/S)

fromDate

string

N

Ngày đắt đầu thực hiện lệnh điều kiện

dd/MM/yyyy HH:mm:ss

toDate

string

N

Ngày kết thúc thực hiện lệnh điều kiện

dd/MM/yyyy HH:mm:ss

pageIndex

Number

N

Trang muốn truy vấn. Mặc định là 1

pageSize

Number

N

Kích cỡ của trang truy vấn. Mặc định là 20

Trường dữ liệu
Kiểu dữ liệu
Mô tả

status

string

Tham chiếu sang:

7.2 FCO status code

message

string

Thông báo lỗi

totalElements

string

Tổng số bản ghi

totalPages

string

Tổng số trang

page

string

Số trang hiện tại

size

string

Số bản ghi trong 1 trang

fcoList

json

{mảng các lệnh điều kiện đã được tạo}. Bao gồm các thành phần như sau

dcoId

string

Mã lệnh điều kiện

userid

string

Tài khoản của khách hàng

accountNo

string

Tiểu khoản đặt lệnh

quantit

number

Khối lượng muốn đặt lệnh

price

string

Giá đặt lệnh

instrumentID

string

Mã chứng khoán

side

string

Loại lệnh (buy/sell)

orderType

string

Loại lệnh: LO, MP, MTL…

runningMode

boolean

Kiểu thực hiện điều kiện:

mainOrder

boolean

Có phải lệnh chính hay không

attachedOrder

boolean

Có phải lệnh đính kèm hay không

createdTime

string

Thời gian đặt lệnh

updatedTime

string

Thời gian cập nhật lệnh

matchedQuality

number

Khối lượng đã khớp

placeOrder

boolean

Trạng thái phát sinh lệnh con: true: Có lệnh thực phát sinh (xuất hiện lệnh ở Orderbook); false: Chưa có Lệnh thực phát sinh

status

string

Trạng thái lệnh: Trả trạng thái giống QEngine trả về.

statusDetail

string

Mô tả trạng thái lệnh

params

string

Thông tin kích hoạt lệnh

Ví dụ

  • Trường hợp thành công

  • Trường hợp lỗi

GET statusHistory

Uses: Lấy danh sách trạng thái của lệnh điều kiện

Authen: Bearer token

Header: "Content-Type":"application/json" and "User-Agent":"fctrading application for customer 123456"

Thông tin chi tiết

Trường dữ liệu
Kiểu
Bắt buộc
Mô tả

fcoid

string

Y

ID của lệnh điều kiện

pageIndex

Number

N

Trang muốn truy vấn. Mặc định là 1

pageSize

Number

N

Kích cỡ của trang truy vấn. Mặc định là 20

api/v2/fco/orderbook?fcoid= {fcoid}&pageIndex={page}&pageSize={size}

Tên trường
Kiểu dữ liệu
Mô tả

status

string

Tham chiếu sang:

FCO status code

message

string

Thông báo lỗi

data

json

{mảng các status của fcoId tương ứng}

state

string

Trạng thái lệnh

time

string

Thời gian đổi trạng thái

code

number

Mã thông báo liên quan đổi trạng thái

detail

string

Thông báo chi tiết về đổi trạng thái

Ví dụ

  • Trường hợp thành công

  • Trường hợp lỗi

Last updated