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

Hiệu quả đầu tư

API này cung cấp dữ liệu lịch sử về hiệu quả đầu tư của danh mục Nebula, bao gồm lợi nhuận hàng ngày, hàng tháng và hàng năm, cũng như so sánh với chỉ số VN-Index.

HTTP request

  • URL: /api/personalize/v1/partner/nebula-ultra/profiles/portfolio/returns/calendar
  • Method: GET
  • Content Type: None
  • 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ố Truy Vấn (Query Parameters)

Tên Tham SốKiểu Dữ LiệuBắt buộcMô Tả
externalUserIdstringUserId của đối tác.
typestringkhôngLoại portfolio:
- backtest: Hiệu suất quá khứ (default)
- paper: Giao dịch giả lập
- live: Dành cho bạn
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": {
"portfolioReturns": [
{
"nebulaValue": 1,
"vnindexValue": 701.8,
"timestamp": "2020-04-02T17:00:00.000Z"
},
{
"nebulaValue": 1,
"vnindexValue": 736.75,
"timestamp": "2020-04-05T17:00:00.000Z"
},
{
"nebulaValue": 1,
"vnindexValue": 746.69,
"timestamp": "2020-04-06T17:00:00.000Z"
},
{
"nebulaValue": 1.01,
"vnindexValue": 748.02,
"timestamp": "2020-04-07T17:00:00.000Z"
},
{
"nebulaValue": 1.01,
"vnindexValue": 760.33,
"timestamp": "2020-04-08T17:00:00.000Z"
},
{
"nebulaValue": 1,
"vnindexValue": 757.94,
"timestamp": "2020-04-09T17:00:00.000Z"
},
{
"nebulaValue": 1,
"vnindexValue": 765.79,
"timestamp": "2020-04-12T17:00:00.000Z"
}
],
"monthlyReturns": {
"2020": [
{
"period": "1"
},
{
"period": "2"
},
{
"period": "3"
},
{
"period": "4"
},
{
"pnl": 6.32,
"period": "5"
},
{
"pnl": -1.23,
"period": "6"
},
{
"pnl": -3.39,
"period": "7"
},
{
"pnl": 8.54,
"period": "8"
},
{
"pnl": 4.78,
"period": "9"
},
{
"pnl": 0.47,
"period": "10"
},
{
"pnl": 4.45,
"period": "11"
},
{
"pnl": 10.47,
"period": "12"
}
],
"2021": [
{
"pnl": -3.85,
"period": "1"
},
{
"pnl": 6.46,
"period": "2"
},
{
"pnl": 2.88,
"period": "3"
},
{
"pnl": -3.34,
"period": "4"
},
{
"pnl": 5.74,
"period": "5"
},
{
"pnl": 4.59,
"period": "6"
},
{
"pnl": -1.26,
"period": "7"
},
{
"pnl": 2.86,
"period": "8"
},
{
"pnl": 2.98,
"period": "9"
},
{
"pnl": 2.2,
"period": "10"
},
{
"pnl": -0.22,
"period": "11"
},
{
"pnl": 2.96,
"period": "12"
}
],
"2022": [
{
"pnl": 3.37,
"period": "1"
},
{
"pnl": 0.57,
"period": "2"
},
{
"pnl": -0.24,
"period": "3"
},
{
"pnl": -4.94,
"period": "4"
},
{
"pnl": -3.1,
"period": "5"
},
{
"pnl": -3.58,
"period": "6"
},
{
"pnl": 3.07,
"period": "7"
},
{
"pnl": 3.96,
"period": "8"
},
{
"pnl": -9.73,
"period": "9"
},
{
"pnl": 0.36,
"period": "10"
},
{
"pnl": 4.95,
"period": "11"
},
{
"pnl": -0.44,
"period": "12"
}
],
"2023": [
{
"pnl": 7.16,
"period": "1"
},
{
"pnl": -6.36,
"period": "2"
},
{
"pnl": 3.28,
"period": "3"
},
{
"pnl": 2.71,
"period": "4"
},
{
"pnl": 1.62,
"period": "5"
},
{
"pnl": 4.16,
"period": "6"
},
{
"pnl": 5.5,
"period": "7"
},
{
"pnl": -0.59,
"period": "8"
},
{
"pnl": -0.49,
"period": "9"
},
{
"pnl": -6.44,
"period": "10"
},
{
"pnl": 4.56,
"period": "11"
},
{
"pnl": 2.15,
"period": "12"
}
],
"2024": [
{
"pnl": 8.59,
"period": "1"
},
{
"pnl": 8.97,
"period": "2"
},
{
"pnl": 0.76,
"period": "3"
},
{
"pnl": -3.81,
"period": "4"
},
{
"pnl": 7.76,
"period": "5"
},
{
"pnl": 2,
"period": "6"
},
{
"pnl": 2.24,
"period": "7"
},
{
"pnl": -0.42,
"period": "8"
},
{
"pnl": 2.35,
"period": "9"
},
{
"pnl": 0.69,
"period": "10"
},
{
"pnl": 0.92,
"period": "11"
},
{
"pnl": 1.92,
"period": "12"
}
],
"2025": [
{
"pnl": -1.44,
"period": "1"
},
{
"pnl": 3.47,
"period": "2"
},
{
"pnl": -3.01,
"period": "3"
},
{
"pnl": -2.07,
"period": "4"
},
{
"pnl": 2.58,
"period": "5"
},
{
"pnl": 3.17,
"period": "6"
},
{
"pnl": 3.87,
"period": "7"
},
{
"pnl": 9.01,
"period": "8"
},
{
"pnl": -2.96,
"period": "9"
},
{
"pnl": 3.97,
"period": "10"
},
{
"pnl": -1.74,
"period": "11"
},
{
"pnl": 2.7,
"period": "12"
}
]
},
"yearlyReturns": [
{
"pnl": 33.76,
"period": "2020"
},
{
"pnl": 23.62,
"period": "2021"
},
{
"pnl": -6.57,
"period": "2022"
},
{
"pnl": 17.5,
"period": "2023"
},
{
"pnl": 36.04,
"period": "2024"
},
{
"pnl": 18.18,
"period": "2025"
},
{
"period": "2026"
},
{
"period": "2027"
},
{
"period": "2028"
},
{
"period": "2029"
},
{
"period": "2030"
},
{
"period": "2031"
}
]
}
}

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ả xử lý.
dataobject (Xem chi tiết)Dữ liệu hiệu quả đầu tư.

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

Quay lại
Tên Thuộc TínhKiểu Dữ LiệuMô Tả
portfolioReturnsarray (Xem chi tiết)Danh sách hiệu quả đầu tư theo biểu đồ timeseries.
monthlyReturnsobject (Xem chi tiết)- key: năm
- value: Danh sách hiệu quả đầu tư theo từng tháng (đầy đủ 12 tháng).
yearlyReturnsarray (Xem chi tiết)Danh sách hiệu quả đầu tư theo từng năm trả về dữ liệu 12 năm bao gồm cả các năm trong tương lai nếu chưa có dữ liệu.

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

Quay lại
Tên Thuộc TínhKiểu Dữ LiệuMô Tả
portfolioValuenumber- Giá trị của Portfolio, dữ liệu này có thể có hoặc không tùy vào thời gian giao dịch của người dùng.
- Công thức: UN(t1) - UN(t0)
- Trong đó: UN(t1) là portfolioValue tại một thời điểm, UN(t0) là portfolioValue tại mốc đầu tiên.
nebulaValuenumber- Giá trị của Nebula
- Công thức: (UP(t1) / UP(t0) - 1) * 100
- Trong đó: UP là nebulaValue tại 1 thời điểm, UP(t0) là giá trị nebulaValue tại mốc đầu tiên.
vnindexValuenumber- Giá trị của chỉ số VN-Index.
- Công thức: (VN(t1) / VN(t0) - 1) * 100
- Trong đó: VN(t1) là vnindexValue tại một thời điểm, VN(t0) là vnindexValue tại mốc đầu tiên.
timestampstringThời gian giao dịch (Định dạng: yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

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

Quay lại
Tên Thuộc TínhKiểu Dữ LiệuMô Tả
[year]array (Xem chi tiết)Dữ liệu lợi nhuận các tháng trong năm đó.

Cấu trúc đối tượng trong mảng data.monthlyReturns.[year]

Quay lại
Tên Thuộc TínhKiểu Dữ LiệuMô Tả
pnlnumberLợi nhuận/thua lỗ (%) trong tháng.
periodstringTháng trong năm (ví dụ: '1', '2', ..., '12').

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

Quay lại
Tên Thuộc TínhKiểu Dữ LiệuMô Tả
pnlnumberLợi nhuận/thua lỗ (%) trong năm.
periodstringNăm.

CREDENTIALS

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

RESPONSE200

{
"status": 200,
"message": "Success",
"data": {
"portfolioReturns": [
{
"nebulaValue": 1,
"vnindexValue": 701.8,
"timestamp": "2020-04-02T17:00:00.000Z"
},
{
"nebulaValue": 1,
"vnindexValue": 736.75,
"timestamp": "2020-04-05T17:00:00.000Z"
},
{
"nebulaValue": 1,
"vnindexValue": 746.69,
"timestamp": "2020-04-06T17:00:00.000Z"
},
{
"nebulaValue": 1.01,
"vnindexValue": 748.02,
"timestamp": "2020-04-07T17:00:00.000Z"
},
{
"nebulaValue": 1.01,
"vnindexValue": 760.33,
"timestamp": "2020-04-08T17:00:00.000Z"
},
{
"nebulaValue": 1,
"vnindexValue": 757.94,
"timestamp": "2020-04-09T17:00:00.000Z"
},
{
"nebulaValue": 1,
"vnindexValue": 765.79,
"timestamp": "2020-04-12T17:00:00.000Z"
}
],
"monthlyReturns": {
"2020": [
{
"period": "1"
},
{
"period": "2"
},
{
"period": "3"
},
{
"period": "4"
},
{
"pnl": 6.32,
"period": "5"
},
{
"pnl": -1.23,
"period": "6"
},
{
"pnl": -3.39,
"period": "7"
},
{
"pnl": 8.54,
"period": "8"
},
{
"pnl": 4.78,
"period": "9"
},
{
"pnl": 0.47,
"period": "10"
},
{
"pnl": 4.45,
"period": "11"
},
{
"pnl": 10.47,
"period": "12"
}
],
"2021": [
{
"pnl": -3.85,
"period": "1"
},
{
"pnl": 6.46,
"period": "2"
},
{
"pnl": 2.88,
"period": "3"
},
{
"pnl": -3.34,
"period": "4"
},
{
"pnl": 5.74,
"period": "5"
},
{
"pnl": 4.59,
"period": "6"
},
{
"pnl": -1.26,
"period": "7"
},
{
"pnl": 2.86,
"period": "8"
},
{
"pnl": 2.98,
"period": "9"
},
{
"pnl": 2.2,
"period": "10"
},
{
"pnl": -0.22,
"period": "11"
},
{
"pnl": 2.96,
"period": "12"
}
],
"2022": [
{
"pnl": 3.37,
"period": "1"
},
{
"pnl": 0.57,
"period": "2"
},
{
"pnl": -0.24,
"period": "3"
},
{
"pnl": -4.94,
"period": "4"
},
{
"pnl": -3.1,
"period": "5"
},
{
"pnl": -3.58,
"period": "6"
},
{
"pnl": 3.07,
"period": "7"
},
{
"pnl": 3.96,
"period": "8"
},
{
"pnl": -9.73,
"period": "9"
},
{
"pnl": 0.36,
"period": "10"
},
{
"pnl": 4.95,
"period": "11"
},
{
"pnl": -0.44,
"period": "12"
}
],
"2023": [
{
"pnl": 7.16,
"period": "1"
},
{
"pnl": -6.36,
"period": "2"
},
{
"pnl": 3.28,
"period": "3"
},
{
"pnl": 2.71,
"period": "4"
},
{
"pnl": 1.62,
"period": "5"
},
{
"pnl": 4.16,
"period": "6"
},
{
"pnl": 5.5,
"period": "7"
},
{
"pnl": -0.59,
"period": "8"
},
{
"pnl": -0.49,
"period": "9"
},
{
"pnl": -6.44,
"period": "10"
},
{
"pnl": 4.56,
"period": "11"
},
{
"pnl": 2.15,
"period": "12"
}
],
"2024": [
{
"pnl": 8.59,
"period": "1"
},
{
"pnl": 8.97,
"period": "2"
},
{
"pnl": 0.76,
"period": "3"
},
{
"pnl": -3.81,
"period": "4"
},
{
"pnl": 7.76,
"period": "5"
},
{
"pnl": 2,
"period": "6"
},
{
"pnl": 2.24,
"period": "7"
},
{
"pnl": -0.42,
"period": "8"
},
{
"pnl": 2.35,
"period": "9"
},
{
"pnl": 0.69,
"period": "10"
},
{
"pnl": 0.92,
"period": "11"
},
{
"pnl": 1.92,
"period": "12"
}
],
"2025": [
{
"pnl": -1.44,
"period": "1"
},
{
"pnl": 3.47,
"period": "2"
},
{
"pnl": -3.01,
"period": "3"
},
{
"pnl": -2.07,
"period": "4"
},
{
"pnl": 2.58,
"period": "5"
},
{
"pnl": 3.17,
"period": "6"
},
{
"pnl": 3.87,
"period": "7"
},
{
"pnl": 9.01,
"period": "8"
},
{
"pnl": -2.96,
"period": "9"
},
{
"pnl": 3.97,
"period": "10"
},
{
"pnl": -1.74,
"period": "11"
},
{
"pnl": 2.7,
"period": "12"
}
]
},
"yearlyReturns": [
{
"pnl": 33.76,
"period": "2020"
},
{
"pnl": 23.62,
"period": "2021"
},
{
"pnl": -6.57,
"period": "2022"
},
{
"pnl": 17.5,
"period": "2023"
},
{
"pnl": 36.04,
"period": "2024"
},
{
"pnl": 18.18,
"period": "2025"
},
{
"period": "2026"
},
{
"period": "2027"
},
{
"period": "2028"
},
{
"period": "2029"
},
{
"period": "2030"
},
{
"period": "2031"
}
]
}
}