Chuyển tới nội dung chính

Hiệu suất đầu tư

API này trả về dữ liệu lịch sử lợi nhuận theo ngày của danh mục đầu tư, bao gồm so sánh với chỉ số VN-Index để đánh giá hiệu suất.

HTTP request

  • URL: /api/personalize/v1/partner/portfolio/return-value/${portfolioId}
  • Method: GET
  • Content Type: application/json
  • Response Type: application/json

Tham số header

HeaderMô tảKiểu dữ liệuBắt buộc
X-Api-KeyKhóa duy nhất.string

Tham Số Đường Dẫn (Path Parameters)

Tên Tham SốKiểu Dữ LiệuMô Tả
portfolioIdstringID của danh mục cần lấy dữ liệu lợi nhuận.

Tham Số Truy Vấn (Query Parameters)

Tên Tham SốKiểu Dữ LiệuBắt buộcMô Tả
isMaxstringkhôngNếu true, trả về toàn bộ lịch sử. Mặc định: false (chỉ trả về 1 năm gần nhất).
externalUserIdstringID người dùng duy nhất từ hệ thống của đối tác.
recvWindowstringkhôngThời gian chấp nhận (ms), default: 5000
timestampstringUnix timestamp (milliseconds).
signaturestringHMAC-SHA256 signature.

Phản Hồi (Response)

Response Mẫu

{
"status": 200,
"message": "Success",
"data": [
{
"date": "2024-01-14T00:00:00.000Z",
"unitReturn": 0,
"vnIndex": 1154.7,
"vnIndexReturn": 0,
"dailyReturn": 0,
"vnindexDailyReturn": 0
},
{
"date": "2024-01-15T00:00:00.000Z",
"unitReturn": -1.21,
"vnIndex": 1154.12,
"vnIndexReturn": -0.05,
"dailyReturn": -1.21,
"vnindexDailyReturn": -0.05
}
]
}

Chi Tiết Tham Số Response

Tên Thuộc TínhKiểu Dữ LiệuMô Tả
statusnumberMã trạng thái HTTP
messagestringThông báo kết quả
dataarray (Xem chi tiết)Danh sách dữ liệu lợi nhuận theo ngày

Cấu trúc thuộc tính data

Quay lại
Tên Thuộc TínhKiểu Dữ LiệuMô Tả
datestringNgày ghi nhận (Định dạng: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
unitReturnnumberLợi nhuận danh mục lũy kế (%)
vnIndexnumberGiá trị chỉ số VN-Index
vnIndexReturnnumberVNINDEX lũy kế (%)
dailyReturnnumberBiến động lợi nhuận danh mục trong ngày (%)
vnindexDailyReturnnumberBiến động VN-Index trong ngày (%)

CREDENTIALS

* Timestamp và Signature sẽ được tự động tạo khi gọi API

RESPONSE200

{
"status": 200,
"message": "Success",
"data": [
{
"date": "2024-01-14T00:00:00.000Z",
"unitReturn": 0,
"vnIndex": 1154.7,
"vnIndexReturn": 0,
"dailyReturn": 0,
"vnindexDailyReturn": 0
},
{
"date": "2024-01-15T00:00:00.000Z",
"unitReturn": -1.21,
"vnIndex": 1154.12,
"vnIndexReturn": -0.05,
"dailyReturn": -1.21,
"vnindexDailyReturn": -0.05
}
]
}