Skip to main content
GET
cURL

Authorizations

X-FH-APIKEY
string
header
required

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.

Path Parameters

indicator
string
required

Slug chỉ tiêu vĩ mô. Chỉ dùng slug có sẵn trong danh mục chỉ tiêu vĩ mô đã tra trước đó — không tự đoán, slug sai sẽ không khớp chỉ tiêu nào. VD: vn-cpi.

Example:

"vn-cpi"

Query Parameters

from
string

Kỳ bắt đầu (bao gồm). Dạng yyyy, yyyy-Qn hoặc yyyy-MM.

Example:

"2024-01"

to
string

Kỳ kết thúc (bao gồm). Dạng yyyy, yyyy-Qn hoặc yyyy-MM.

Example:

"2024-12"

limit
integer

Số kỳ tối đa trả về (1–500). Mặc định 100 khi có khoảng thời gian; 1 khi bỏ trống from/to.

Required range: 1 <= x <= 500
Example:

100

Response

data.series là mảng {period, value} theo kỳ.

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
required
error_code
string

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

Example:

"0"

message
string

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

Example:

"success"