Skip to main content
GET
cURL

Ủy quyền

X-FH-APIKEY
string
header
bắt buộc

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.

Tham số truy vấn

symbol
string
bắt buộc

Mã stock (chữ hoa, chữ số).

Ví dụ:

"VNM"

type
enum<string>
bắt buộc

Loại báo cáo. Loại báo cáo dùng cho /market/v2/financial-statement/statement.

Tùy chọn có sẵn:
income-statement,
balance-sheet,
cash-flow
period
enum<string>

Kỳ báo cáo. Kỳ báo cáo cho truy vấn tài chính doanh nghiệp.

Tùy chọn có sẵn:
annual,
quarterly
limit
integer
mặc định:5

Số kỳ cần lấy (1–5, mặc định 5).

Phạm vi bắt buộc: 1 <= x <= 5
Ví dụ:

5

page
integer
mặc định:1

Trang cần lấy, tính theo kỳ báo cáo (mỗi trang limit kỳ). Mặc định 1; trang 1 là các kỳ gần nhất, trang sau lùi về quá khứ. Hết dữ liệu khi trả về ít kỳ hơn kích thước trang.

Phạm vi bắt buộc: x >= 1
Ví dụ:

2

year
integer

Chỉ lấy kỳ của năm này: period=annual trả 1 row, period=quarterly trả các quý của năm (quý mới nhất trước).

Phạm vi bắt buộc: x >= 1
Ví dụ:

2023

Phản hồi

Trả về data mảng các kỳ báo cáo theo format wide — mỗi row là 1 kỳ; metric code khác nhau giữa income-statement / balance-sheet / cash-flow.

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.
data
object[]
bắt buộc
error_code
string

"0" khi thành công, khác "0" khi lỗi.

Ví dụ:

"0"

message
string

Thông điệp trạng thái dễ đọc.

Ví dụ:

"success"