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

symbol
enum<string>
required

Mã chỉ số. Chỉ các chỉ số có membership tra được mới dùng được ở nhóm endpoint này; chỉ số quốc tế không được hỗ trợ.

Available options:
VNINDEX,
HNXINDEX,
UPCOMINDEX,
VN30,
HNX30
Example:

"VNINDEX"

Query Parameters

sort
enum<string>

Field sắp xếp, thêm - ở đầu để giảm dần. Mặc định -weight_percent. Field hợp lệ: weight_percent, market_cap, change_percent, symbol.

Available options:
weight_percent,
-weight_percent,
market_cap,
-market_cap,
change_percent,
-change_percent,
symbol,
-symbol
Example:

"-weight_percent"

page
integer

Trang cần lấy, bắt đầu từ 1.

Required range: x >= 1
Example:

1

page_size
integer

Số mã mỗi trang, tối đa 50.

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

20

Response

data.items là danh sách mã trong rổ.

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

Danh sách mã trong rổ một chỉ số, đã phân trang.

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"