> ## 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.

# Phân tích tài chính doanh nghiệp theo kỳ

> Các chỉ số tài chính theo kỳ. Mỗi row luôn có `year`; `quarter` chỉ có
khi `period=quarterly`.

**Kích thước payload**: API trả về **~200 metric code** mỗi row
(tên romanized tiếng Việt như `pe`, `pb`, `roa`, `bienlaigop`, `ebitda`,
`thanhtoan_hienhanh`, `novay_vonchu`, `lnst_yoy`, `vonhoa`, …). Bộ key
phụ thuộc vào loại doanh nghiệp (ngân hàng có `nim`; công ty chứng khoán
có `margin_loan_to_equity_ratio`, …). Nhiều code có thể `null` khi dữ
liệu nguồn thiếu. Example bên dưới chỉ là **subset đại diện** — tham
chiếu `additionalProperties` trong schema là nguồn chuẩn.




## OpenAPI

````yaml /openapi.yaml get /market/company-financial/analysis
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:
  /market/company-financial/analysis:
    get:
      tags:
        - Phân tích cơ bản
      summary: Phân tích tài chính doanh nghiệp theo kỳ
      description: |
        Các chỉ số tài chính theo kỳ. Mỗi row luôn có `year`; `quarter` chỉ có
        khi `period=quarterly`.

        **Kích thước payload**: API trả về **~200 metric code** mỗi row
        (tên romanized tiếng Việt như `pe`, `pb`, `roa`, `bienlaigop`, `ebitda`,
        `thanhtoan_hienhanh`, `novay_vonchu`, `lnst_yoy`, `vonhoa`, …). Bộ key
        phụ thuộc vào loại doanh nghiệp (ngân hàng có `nim`; công ty chứng khoán
        có `margin_loan_to_equity_ratio`, …). Nhiều code có thể `null` khi dữ
        liệu nguồn thiếu. Example bên dưới chỉ là **subset đại diện** — tham
        chiếu `additionalProperties` trong schema là nguồn chuẩn.
      operationId: fundamentalGetAnalysis
      parameters:
        - name: symbol
          in: query
          required: true
          description: Mã stock (chữ hoa, chữ số).
          schema:
            type: string
            example: VNM
        - name: period
          in: query
          required: false
          description: Kỳ báo cáo. Mặc định `annual`.
          schema:
            $ref: '#/components/schemas/FinancialPeriod'
      responses:
        '200':
          description: >-
            Trả về `data` mảng các kỳ báo cáo, mỗi item là 1 record `year` (+
            `quarter` khi `period=quarterly`) cộng ~200 metric code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisResponse'
              example:
                error_code: '0'
                message: success
                data:
                  - year: 2025
                    quarter: 4
                    pe: null
                    pb: 4.31317
                    roa: null
                    roe: null
                    eps: null
                    ebit: 3566980066852
                    ebitda: 4108719059869
                    bienlaigop: 0.404497
                    bienlaiebitda: 0.241213
                    bienlaisauthue: 0.165978
                    lnst_yoy: 0.316942
                    lnst_qoq: 0.126135
                    dtt_qoq: 0.004738
                    tt_dtt_yoy: 0.100567
                    nophaitra_vcsh: 0.546047
                    novay_vonchu: 0.274241
                    thanhtoan_hienhanh: 1.957917
                    thanhtoan_nhanh: 1.575433
                    thanhtoan_tienmat: 0.096914
                    bvps: 14189.099355
                    lnwpershare: 4529.851333
                    bookvalue: 29654585456641
                    ev: 113837320151135
                    vonhoa: 127905273234000
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |
            curl -H "X-FH-APIKEY: $FINHAY_API_KEY" \
              "https://open-api.fhsc.com.vn/market/company-financial/analysis?symbol=VNM&period=quarterly"
components:
  schemas:
    FinancialPeriod:
      type: string
      description: |
        Kỳ báo cáo cho truy vấn tài chính doanh nghiệp.

        | Giá trị | Ý nghĩa |
        |---------|---------|
        | `annual` | Theo năm |
        | `quarterly` | Theo quý |
      enum:
        - annual
        - quarterly
      x-enum-varnames:
        - ANNUAL
        - QUARTERLY
    FinancialAnalysisResponse:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          required:
            - data
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/FinancialAnalysisEntry'
    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
    FinancialAnalysisEntry:
      type: object
      description: |
        Các chỉ số tài chính cho 1 kỳ báo cáo. `year` luôn có; `quarter` chỉ có
        khi `period=quarterly`. Các field còn lại là metric code động (ví dụ
        `pe`, `roe`, `eps`, `pb`) nhận giá trị số hoặc null — bộ key thay đổi
        theo loại doanh nghiệp (ngân hàng có `nim`, sản xuất có `gross_margin`,
        …).
      properties:
        year:
          type: integer
          example: 2023
        quarter:
          type:
            - integer
            - 'null'
          description: Present only for quarterly period (1–4).
          example: 2
      additionalProperties:
        type:
          - number
          - 'null'
    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.

````