> ## Documentation Index > Fetch the complete documentation index at: https://developers.fhsc.com.vn/llms.txt > Use this file to discover all available pages before exploring further. # Lấy sổ lệnh trong ngày > Sổ lệnh (orderbook) đầy đủ trong ngày (bao gồm cả lệnh từ broker-signal và HayBond). ## OpenAPI ````yaml /openapi.yaml get /trading/v1/accounts/{subAccountId}/order-book openapi: 3.1.0 info: title: Finhay Securities Open API version: 0.2.0-preview.2 description: | Đặc tả chính thức của Finhay Securities Open API, dùng chung cho SDK codegen, Redoc docs, và (sau này) mock server / contract test. ## Authentication — 2 tier - **Tier 1 — chỉ cần API key**: các endpoint đọc dữ liệu thị trường (`GET /market/**`, `GET /trading/market/**`). Gửi kèm header `X-FH-APIKEY` là đủ. - **Tier 2 — HMAC signing**: các endpoint liên quan đến account / trading / user. Gửi kèm 4 header `X-FH-APIKEY` + `X-FH-TIMESTAMP` + `X-FH-NONCE` + `X-FH-SIGNATURE`; thêm `X-FH-BODYHASH` khi request có body. Chi tiết thuật toán xem extension `x-finhay-signing` ở root spec hoặc phần README. ## Bootstrap flow Gọi 2 endpoint tag **Khởi tạo** (`GET /users/v1/users/me` và `GET /users/v1/users/{userId}/sub-accounts`) **1 lần khi khởi tạo client** để lấy thông tin `user_id` và `subAccountId`. Mọi endpoint thuộc tag **Tổng tài sản / Tiểu khoản / Danh mục đầu tư / Sổ lệnh / Lãi-lỗ / Quyền cổ đông** đều cần 2 giá trị này để truyền vào path parameter. contact: {} servers: - url: https://open-api.fhsc.com.vn description: Production security: - FinhayApiKey: [] tags: - name: Khởi tạo description: >- Khởi tạo client — lấy `user_id` và `subAccountId`. Gọi 1 lần khi khởi tạo SDK rồi cache lại. - name: Dữ liệu giao dịch description: >- Giá stock realtime và lịch sử OHLCV (dạng columnar, phục vụ charting / time-series). - name: Phân tích cơ bản description: >- Chỉ số tài chính cơ bản của doanh nghiệp — chỉ số tổng quan, phân tích theo kỳ và báo cáo tài chính chuẩn (income statement / balance sheet / cash flow). - name: Tin tức-sự kiện description: >- Sự kiện doanh nghiệp (cổ tức, quyền mua, ĐHCĐ, …), tin tức stock, tin tức tài chính toàn cầu (forex / commodities / economic-indicators / stock-market / cryptocurrency) và báo cáo khuyến nghị từ analyst. - name: Kinh tế vĩ mô description: >- Chỉ số kinh tế vĩ mô (CPI, PMI, PCE, GDP, …) và lãi suất tiền gửi ngân hàng. - name: Hàng hoá description: >- Hàng hoá và tài sản thay thế — vàng, bạc (spot / chart / theo nhà cung cấp) và crypto trending. - name: Tổng hợp đa loại description: >- Endpoint composite tổng hợp cross-domain (vàng / bạc / crypto / FX / lãi suất / US index) trong 1 call. Nên dùng endpoint chuyên biệt nếu chỉ cần 1 loại. - name: Quỹ mở description: >- Quỹ mở (open-ended funds) — danh sách quỹ, công ty quản lý, NAV history, holdings, ranking và benchmark cross-fund. - name: Tổng tài sản description: >- Tổng quan tài sản cấp user — cross-product (stock, fund, bond, hay0) kèm cash, debt, PnL. - name: Tiểu khoản description: Thông tin tiểu khoản — số dư, margin, dư nợ và ngân hàng liên kết. - name: Danh mục đầu tư description: Danh mục stock đang nắm giữ kèm giá realtime và PnL theo vị thế. - name: Sổ lệnh description: >- Quản lý lệnh — sổ lệnh trong ngày, danh sách đầy đủ hoặc chi tiết theo `orderId`. - name: Lãi-lỗ description: PnL và analytics cá nhân — lãi / lỗ trong ngày tổng hợp theo user. - name: Quyền cổ đông description: Quyền cổ đông (cổ tức, quyền mua, bỏ phiếu, …) của tiểu khoản. - name: Phiên giao dịch description: >- Hạ tầng trading — trạng thái phiên giao dịch và order type khả dụng của mỗi exchange. - name: Thực thi lệnh description: | ⚠️ Nhóm endpoint này đang ở giai đoạn **preview**. Đặt / sửa / huỷ lệnh trên sàn — write operation nhạy cảm, yêu cầu Tier 2 HMAC đầy đủ + `X-FH-BODYHASH` + `X-FH-2FA-TOKEN` (daily 2FA session). paths: /trading/v1/accounts/{subAccountId}/order-book: get: tags: - Sổ lệnh summary: Lấy sổ lệnh trong ngày description: > Sổ lệnh (orderbook) đầy đủ trong ngày (bao gồm cả lệnh từ broker-signal và HayBond). operationId: ordersGetOrderBook parameters: - $ref: '#/components/parameters/SubAccountId' responses: '200': description: >- Trả về `result` mảng các lệnh trong ngày của tiểu khoản; mỗi item là 1 lệnh kèm trạng thái khớp / chờ / huỷ. content: application/json: schema: $ref: '#/components/schemas/OrderBookResponse' example: error_code: '0' message: success result: - custodycd: '0123456' txdate: '2024-04-18' custid: '123456' afacctno: '0001234567' orderid: ORD123456 odorderid: '0001' txtime: '09:15:23' symbol: VNM allowcancel: 'Y' allowamend: 'Y' side_code: NB side: BUY price: 72000 pricetype: LO via_code: WEB via: Web qtty: 100 execqtty: 0 execamt: 0 execprice: 0 remainqtty: 100 remainamt: 7200000 status_code: '01' status: SENT tlname: Finhay username: cuong@finhay hosesession: PROGRESS cancelqtty: 0 adjustqtty: 0 isdisposal: 'N' rootorderid: ORD123456 timetype: '0' timetypevalue: '' feedbackmsg: '' quoteqtty: 0 limitprice: 72000 odtimestamp: '2024-04-18T09:15:23' matchtype_code: '' producttypename: STOCK afacctno_ext: '0001234567.01' side_: BUY via_: Web status_: SENT matchtype_: '' strategy_id: null '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' security: - FinhayApiKey: [] FinhayTimestamp: [] FinhayNonce: [] FinhaySignature: [] x-codeSamples: - lang: bash label: cURL source: | curl \ -H "X-FH-APIKEY: $FINHAY_API_KEY" \ -H "X-FH-TIMESTAMP: $TIMESTAMP_MS" \ -H "X-FH-NONCE: $NONCE_UUID" \ -H "X-FH-SIGNATURE: $SIGNATURE_HEX" \ "https://open-api.fhsc.com.vn/trading/v1/accounts/$SUB_ACCOUNT_NORMAL/order-book" components: parameters: SubAccountId: name: subAccountId in: path required: true description: | subAccountId được lấy từ bootstrap flow (`GET /users/v1/users/{userId}/sub-accounts`), chọn NORMAL hoặc MARGIN tuỳ mục đích. schema: type: string example: '0001234567' schemas: OrderBookResponse: allOf: - $ref: '#/components/schemas/EnvelopeBase' - type: object required: - result properties: result: type: array items: $ref: '#/components/schemas/OrderBookEntry' EnvelopeBase: type: object description: | Các field chung của envelope trong mọi response của Finhay API. - `error_code` là `"0"` (string) khi thành công, mã khác `"0"` khi lỗi. - `message` là thông điệp ngắn từ server. properties: error_code: type: string description: '`"0"` khi thành công, khác `"0"` khi lỗi.' example: '0' message: type: string description: Thông điệp trạng thái dễ đọc. example: success OrderBookEntry: type: object description: | 1 row trong sổ lệnh của ngày. Dùng chung cho `/trading/v1/accounts/{subAccountId}/order-book` (array) và `/trading/v1/accounts/{subAccountId}/order-book/{orderId}` (đơn lẻ). properties: custodycd: type: string txdate: type: string description: Transaction date. custid: type: string afacctno: type: string description: Account number. orderid: type: string description: Order ID. odorderid: type: string txtime: type: string description: Transaction time. symbol: type: string example: VNM allowcancel: type: string description: Whether cancel is allowed. allowamend: type: string description: Whether amendment is allowed. side_code: type: string description: Side code (raw). side: type: string description: Side display name (BUY/SELL). price: type: integer format: int64 pricetype: type: string description: Price type code. via_code: type: string description: Order channel code. via: type: string description: Order channel name. qtty: type: integer format: int64 description: Order quantity. execqtty: type: integer format: int64 description: Executed quantity. execamt: type: integer format: int64 description: Executed amount. execprice: type: integer format: int64 description: Executed price. remainqtty: type: integer format: int64 description: Remaining quantity. remainamt: type: integer format: int64 description: Remaining amount. status_code: type: string description: Status code (raw). status: type: string description: Status display name. tlname: type: string username: type: string hosesession: type: string description: HOSE session info. cancelqtty: type: integer format: int64 adjustqtty: type: integer format: int64 isdisposal: type: string rootorderid: type: string timetype: type: string timetypevalue: type: string feedbackmsg: type: string description: Feedback message from exchange. quoteqtty: type: integer format: int64 limitprice: type: number format: double odtimestamp: type: string matchtype_code: type: string producttypename: type: string afacctno_ext: type: string side_: type: string via_: type: string status_: type: string matchtype_: type: string strategy_id: type: - string - 'null' description: >- Strategy ID if the order is linked to a strategy (only populated for `/order-book/{orderId}` detail). ErrorBody: type: object description: Body của response khi 4xx / 5xx. properties: error_code: type: string description: >- Mã lỗi khác `"0"` (ví dụ `AUTH_SIGNATURE_INVALID`, `RATE_LIMIT_EXCEEDED`, …). example: '400' message: type: string description: Thông điệp lỗi (tiếng Anh, từ server). example: Invalid parameter required: - error_code - message responses: BadRequest: description: Request không hợp lệ — thiếu hoặc sai tham số. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: error_code: '400' message: Invalid parameter Unauthorized: description: Không xác thực — thiếu, sai hoặc không hợp lệ chữ ký / API key. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: error_code: '401' message: Invalid signature RateLimited: description: >- Vượt giới hạn rate limit. Chờ đến thời điểm `X-RateLimit-Reset` rồi thử lại. headers: X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: error_code: '429' message: Too many requests InternalError: description: Lỗi server nội bộ. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: error_code: '500' message: Internal server error headers: XRateLimitReset: description: | Unix timestamp (giây) — thời điểm window rate limit reset. Client nhận `429 Too Many Requests` nên chờ đến thời điểm này rồi retry. schema: type: integer format: int64 example: 1713441600 securitySchemes: FinhayApiKey: type: apiKey in: header name: X-FH-APIKEY description: > API key dài hạn của client. Cấu hình 1 lần lúc khởi tạo; có thể wire thẳng vào static setter của SDK tự-gen. Đi kèm với `FINHAY_API_SECRET` — secret này chỉ dùng ở phía client để tính `X-FH-SIGNATURE`, **không** bao giờ gửi qua mạng. FinhayTimestamp: type: apiKey in: header name: X-FH-TIMESTAMP description: > Unix time hiện tại tính bằng **milliseconds**, đưới dạng chuỗi số thập phân. Được tính per-request bởi signing middleware. **Không** set thủ công — dùng middleware mẫu trong README. FinhayNonce: type: apiKey in: header name: X-FH-NONCE description: | UUIDv4 duy nhất per-request (ví dụ `crypto.randomUUID()`). Server cache cặp `(apiKey, nonce)` trong 5 phút; nếu nonce được reuse với cùng apiKey trong window này, request sẽ bị từ chối với `AUTH_NONCE_REUSED` (401). Server chấp nhận chuỗi opaque bất kỳ về mặt kỹ thuật, nhưng nên dùng UUIDv4 để đảm bảo tính unique. Được tính per-request bởi signing middleware. **Không** set thủ công — xem middleware mẫu trong tài liệu Authentication. FinhaySignature: type: apiKey in: header name: X-FH-SIGNATURE description: > HMAC-SHA256 của canonical signing payload, encode hex (lowercase). Signing payload: ``` {X-FH-TIMESTAMP}\n{METHOD}\n{REQUEST_PATH}[?{QUERY}]\n{BODYHASH} ``` - `?{QUERY}` chỉ nối vào path khi request có query string. - `{BODYHASH}` là chuỗi rỗng khi body rỗng (vẫn không có newline sau đó). Được tính per-request bởi signing middleware. **Không** set thủ công — dùng middleware mẫu trong README. ````