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.

Query Parameters

exchange
enum<string>

Chỉ lấy chỉ số của sàn này. Bỏ trống → mọi chỉ số, gồm cả chỉ số quốc tế.

Available options:
HOSE,
HNX,
UPCOM
Example:

"HOSE"

window
enum<string>
default:1D

Cửa sổ luỹ kế cho các field dòng tiền.

Available options:
1D,
1W,
1M,
3M,
6M,
1Y,
YTD
Example:

"YTD"

sort
string

Field sắp xếp, thêm - ở đầu để giảm dần. Mặc định -market_cap. Field hợp lệ: index_value, change, change_percent, market_cap, constituent_count, advancers, decliners, unchanged, volume, trading_value, foreign_net_value.

Example:

"-change_percent"

fields
string

Danh sách field cần trả, phân tách bằng dấu phẩy. Mặc định index,name,index_value,change_percent; field dùng trong sort/filter luôn được thêm vào. Field hợp lệ: index, name, exchange, index_value, change, change_percent, market_cap, constituent_count, advancers, decliners, unchanged, volume, trading_value, foreign_net_value.

Example:

"index,name,index_value,change_percent,foreign_net_value"

index_value_gt
number

Chỉ giữ dòng có index_value lớn hơn giá trị này.

index_value_lt
number

Chỉ giữ dòng có index_value nhỏ hơn giá trị này.

change_gt
number

Chỉ giữ dòng có change lớn hơn giá trị này.

change_lt
number

Chỉ giữ dòng có change nhỏ hơn giá trị này.

change_percent_gt
number

Chỉ giữ dòng có change_percent lớn hơn giá trị này.

change_percent_lt
number

Chỉ giữ dòng có change_percent nhỏ hơn giá trị này.

market_cap_gt
number

Chỉ giữ dòng có market_cap lớn hơn giá trị này.

market_cap_lt
number

Chỉ giữ dòng có market_cap nhỏ hơn giá trị này.

constituent_count_gt
number

Chỉ giữ dòng có constituent_count lớn hơn giá trị này.

constituent_count_lt
number

Chỉ giữ dòng có constituent_count nhỏ hơn giá trị này.

advancers_gt
number

Chỉ giữ dòng có advancers lớn hơn giá trị này.

advancers_lt
number

Chỉ giữ dòng có advancers nhỏ hơn giá trị này.

decliners_gt
number

Chỉ giữ dòng có decliners lớn hơn giá trị này.

decliners_lt
number

Chỉ giữ dòng có decliners nhỏ hơn giá trị này.

unchanged_gt
number

Chỉ giữ dòng có unchanged lớn hơn giá trị này.

unchanged_lt
number

Chỉ giữ dòng có unchanged nhỏ hơn giá trị này.

volume_gt
number

Chỉ giữ dòng có volume lớn hơn giá trị này.

volume_lt
number

Chỉ giữ dòng có volume nhỏ hơn giá trị này.

trading_value_gt
number

Chỉ giữ dòng có trading_value lớn hơn giá trị này.

trading_value_lt
number

Chỉ giữ dòng có trading_value nhỏ hơn giá trị này.

foreign_net_value_gt
number

Chỉ giữ dòng có foreign_net_value lớn hơn giá trị này.

foreign_net_value_lt
number

Chỉ giữ dòng có foreign_net_value nhỏ hơn giá trị này.

page
integer

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

Required range: x >= 1
Example:

1

page_size
integer

Số chỉ số mỗi trang, tối đa 50.

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

20

Response

data.items là danh sách chỉ số, mỗi item chỉ chứa các field được chọn qua fields.

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

Bảng so sánh các 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"