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ố đường dẫn

symbol
enum<string>
bắt buộc

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

Tùy chọn có sẵn:
VNINDEX,
HNXINDEX,
UPCOMINDEX,
VN30,
HNX30
Ví dụ:

"VNINDEX"

Tham số truy vấn

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.

Tùy chọn có sẵn:
weight_percent,
-weight_percent,
market_cap,
-market_cap,
change_percent,
-change_percent,
symbol,
-symbol
Ví dụ:

"-weight_percent"

page
integer

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

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

1

page_size
integer

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

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

20

Phản hồi

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
bắt buộc

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.

Ví dụ:

"0"

message
string

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

Ví dụ:

"success"