Snapshot danh mục thật
API này trả về ảnh chụp (snapshot) danh mục thật của khách hàng tại thời điểm gọi, bao gồm số dư tiền mặt và danh sách cổ phiếu đang nắm giữ (chỉ những mã có khối lượng lớn hơn 0). Mỗi lượt gọi đọc một danh mục.
HTTP request
- URL:
/api/personalize/v1/partner/portfolio/{portfolioId}/snapshot - Method:
GET - Content Type: application/json
- Response Type: application/json
Tham số header
| Header | Mô tả | Kiểu dữ liệu | Bắt buộc |
|---|---|---|---|
| X-Api-Key | Khóa duy nhất. | string | có |
Tham Số Đường Dẫn (Path Parameters)
| Tên Tham Số | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| portfolioId | string | ID của danh mục cần lấy snapshot. |
Tham Số Truy Vấn (Query Parameters)
| Tên Tham Số | Kiểu Dữ Liệu | Bắt buộc | Mô Tả |
|---|---|---|---|
| recvWindow | string | không | Thời gian chấp nhận (ms), default: 5000 |
| timestamp | string | có | Unix timestamp (milliseconds). |
| signature | string | có | HMAC-SHA256 signature. |
Phản Hồi (Response)
Response Mẫu
{
"status": 200,
"message": "Success",
"data": {
"cashValue": 15000000,
"holdings": [
{
"ticker": "HPG",
"volume": 1000,
"marketPrice": 27.5,
"costPrice": 25.1
},
{
"ticker": "VNM",
"volume": 500,
"marketPrice": 64.2,
"costPrice": 68
}
]
}
}
Chi Tiết Tham Số Response
| Tên Thuộc Tính | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| status | number | Mã trạng thái HTTP |
| message | string | Thông báo kết quả |
| data | object (Xem chi tiết) | Snapshot của danh mục |
| Tên Thuộc Tính | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| cashValue | number | Số dư tiền mặt của danh mục (bằng 0 nếu không có ví) |
| holdings | array (Xem chi tiết) | Danh sách cổ phiếu đang nắm giữ (chỉ mã có khối lượng > 0) |
| Tên Thuộc Tính | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| ticker | string | Mã cổ phiếu |
| volume | number | Khối lượng đang nắm giữ |
| marketPrice | number | Giá thị trường (có thể null) |
| costPrice | number | Giá vốn (có thể null) |