Skip to main content

API Reference

Below is the API documentation for the HocChungKhoan CMS endpoints, auto-rendered from the project's OpenAPI Specification 3.0.

info

To test these APIs interactively, you can send HTTP requests directly to the base endpoint: https://api.hocchungkhoan.com.vn

API docs by Redocly

HocChungKhoan CMS API (1.0.0)

Download OpenAPI specification:Download

API cung cấp dữ liệu khách hàng, danh mục đầu tư, lịch sử giao dịch và thống kê hiệu quả đầu tư cho HocChungKhoan CMS.

Customers

Quản lý thông tin hồ sơ khách hàng

Lấy thông tin chi tiết khách hàng

Truy vấn chi tiết hồ sơ khách hàng theo slug, bao gồm thông tin cá nhân, nhân viên chăm sóc và danh sách tài khoản liên kết.

path Parameters
slug
required
string

Slug định danh duy nhất của khách hàng (ví dụ: bangnh)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Portfolio

Quản lý danh mục holdings hiện tại của khách hàng

Lấy danh mục đầu tư hiện tại

Truy vấn danh sách holdings (mã cổ phiếu, khối lượng, giá vốn, công ty chứng khoán) của khách hàng theo slug.

path Parameters
slug
required
string

Slug định danh duy nhất của khách hàng

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Transactions

Quản lý lịch sử giao dịch mua/bán cổ phiếu

Lấy lịch sử giao dịch (toàn bộ tài khoản)

Truy vấn toàn bộ lịch sử giao dịch mua/bán của khách hàng hỗ trợ phân trang và bộ lọc theo mã cổ phiếu, công ty chứng khoán, loại giao dịch.

path Parameters
slug
required
string

Slug định danh duy nhất của khách hàng

query Parameters
page
integer
Default: 1

Số trang kết quả (mặc định: 1)

per_page
integer
Default: 10

Số lượng kết quả trên mỗi trang (mặc định: 10)

broker
string

Mã công ty chứng khoán để lọc (ví dụ: SSI, PINETREE)

stock_code
string

Mã chứng khoán để lọc (ví dụ: FPT, HPG)

type
string
Enum: "buy" "sell"

Loại giao dịch (buy hoặc sell)

start_date
string <date>

Ngày bắt đầu lọc (YYYY-MM-DD)

end_date
string <date>

Ngày kết thúc lọc (YYYY-MM-DD)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Lấy lịch sử giao dịch theo tài khoản cụ thể

Truy vấn lịch sử giao dịch lọc theo ID tài khoản chứng khoán cụ thể của khách hàng.

path Parameters
slug
required
string

Slug định danh duy nhất của khách hàng

accountId
required
string <uuid>

UUID tài khoản chứng khoán liên kết

query Parameters
page
integer
Default: 1
per_page
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Stats

Thống kê tổng hợp hiệu quả đầu tư và lợi nhuận thực tế

Lấy thống kê hiệu quả đầu tư (P&L)

Truy vấn thống kê tổng giá trị mua/bán, tổng phí thuế và lợi nhuận thực tế (realized P&L) của khách hàng.

path Parameters
slug
required
string

Slug định danh duy nhất của khách hàng

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Analytics

Phân tích chi tiết phong cách giao dịch và hiệu suất đầu tư

Lấy phân tích phong cách giao dịch

Truy vấn phân tích hiệu quả giao dịch và phong cách đầu tư của khách hàng theo slug (bao gồm win rate, profit factor, holding time, trading frequency, và top 5 thắng/thua).

path Parameters
slug
required
string

Slug định danh duy nhất của khách hàng (ví dụ: bangnh)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Aggregate

Gộp tất cả thông tin khách hàng trong một request

Lấy dữ liệu tổng hợp khách hàng (All-in-one)

Truy vấn toàn bộ dữ liệu hồ sơ, danh mục holdings, thống kê P&L và phân tích phong cách giao dịch chỉ trong một lượt gọi duy nhất giúp giảm số lượng HTTP request từ frontend.

path Parameters
slug
required
string

Slug định danh duy nhất của khách hàng

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

System

Các API hệ thống và đồng bộ dữ liệu

Lấy danh sách các công ty chứng khoán

Truy vấn danh mục các công ty chứng khoán được hỗ trợ trong hệ thống (ví dụ: SSI, Pinetree).

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Trigger đồng bộ dữ liệu thủ công (Admin)

Cho phép Admin trigger thủ công việc kéo dữ liệu thay đổi từ Neon Postgres sang Insforge Postgres.

header Parameters
X-Admin-Key
required
string

API key xác thực quyền Admin

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}