# Danh Sách Hàm

> Toàn bộ API công khai của vnstock-js 2.x.

Mọi số tiền tính bằng **đồng**, chỉ số bằng **điểm**. Xem [Quy ước & đơn vị](/docs/getting-started/conventions).

## Import

```ts
import { vn, createClient, memoryStorage } from "vnstock-js";
import { sma, rsi, macd /* ... */ } from "vnstock-js/indicators";
import { nextHandler, workerHandler, expressHandler } from "vnstock-js/proxy";
import { fileStorage } from "vnstock-js/node";
```

## Client

| Hàm | Trả về | Mô tả |
|---|---|---|
| `createClient(options?)` | client | `{ proxy, timeout, retries, storage, fetch, preload }` |
| `vn.stock(symbol)` | handle cổ phiếu | Tạo đồng bộ, không gọi mạng |
| `vn.index(symbol)` | handle chỉ số | `VNINDEX`, `VN30`, `VN100`, `HNXIndex`, `HNX30`, `HNXUpcomIndex` |
| `vn.prices(symbols \| { group } \| { exchange })` | `Quote[]` | Bảng giá nhiều mã trong một request |
| `vn.watch(symbols, cb, options?)` | hàm dừng | Giá trực tiếp, `cb` nhận `Tick` |
| `vn.market(options?)` | tổng quan | Chỉ số, thanh khoản, độ rộng, khối ngoại; `asOf` cho phiên đã qua |
| `vn.market.breadth(options?)` | độ rộng | Số mã tăng, giảm, trần, sàn |
| `vn.market.liquidity(options?)` | thanh khoản | Giá trị giao dịch so với phiên trước |
| `vn.market.foreign(options?)` | khối ngoại | Phiên hiện tại; thêm `range` để lấy lịch sử |
| `vn.market.intraday(options?)` | đường thanh khoản | Luỹ kế theo phút so với phiên trước |
| `vn.market.context(options?)` | bối cảnh cho AI | Xu hướng, thanh khoản so với trung bình, độ rộng |
| `vn.screen(options)` | `ScreenRow[]` | `{ group \| exchange, where, sort, limit }` |
| `vn.portfolio(input)` | tổng hợp danh mục | `{ positions, cash }`; kèm `save()`, `load()` |
| `vn.backtest(symbols, signal, options)` | kết quả backtest | Gộp lệnh và thống kê nhiều mã |
| `vn.search(query, { limit }?)` | `SymbolInfo[]` | Tìm theo mã hoặc tên công ty |
| `vn.symbols({ exchange, group, industry }?)` | `SymbolInfo[]` | Danh mục mã |
| `vn.calendar.isTradingDay(date)` | `boolean` | Có phải ngày giao dịch |
| `vn.calendar.next(date?)`, `previous(date?)` | `string` | Ngày giao dịch kế tiếp, trước đó |
| `vn.calendar.holidays(year)` | `string[]` | Ngày nghỉ trong năm |
| `vn.topMovers({ limit }?)` | `{ gainers, losers }` | Top tăng, giảm |
| `vn.gold({ source }?)` | `{ source, unit, items }` | Giá vàng đồng/lượng |
| `vn.fx({ date }?)` | `FxRate[]` | Tỷ giá Vietcombank |
| `vn.news({ date, source, query }?)` | tin tức | Tin tài chính trong một ngày |

## Handle cổ phiếu: `vn.stock(symbol)`

| Hàm | Trả về | Mô tả |
|---|---|---|
| `price()` | `Quote` | Giá, trần, sàn, tham chiếu, khối lượng, giá trị |
| `history(range \| { from, to, interval })` | `Bar[]` | Nến từ 1 phút tới 1 tháng |
| `company()` | hồ sơ | Ngành, số cổ phiếu, lịch sử |
| `shareholders()`, `officers()` | danh sách | Cổ đông lớn, ban lãnh đạo |
| `events()`, `dividends()`, `news()` | danh sách | Sự kiện, cổ tức, tin của công ty |
| `financials(kind, { period })` | `{ unit, fields, rows }` | `'balance' \| 'income' \| 'cashflow' \| 'ratios'`, theo `year` hoặc `quarter` |
| `foreign()` / `foreign(range)` | khối ngoại | Phiên hiện tại, hoặc lịch sử đã ghi |
| `context({ lookback, asOf })` | `AIContext` | Xu hướng, chỉ báo, mốc giá cho AI |
| `prompt({ lang })` | `string` | Bối cảnh dạng văn bản cho LLM |
| `patterns({ recent })` | báo cáo pattern | Hỗ trợ/kháng cự, mẫu nến, Turtle, breakout |
| `watch(cb, options?)` | hàm dừng | Giá trực tiếp của mã này |
| `alert({ when, lookback }, cb)` | hàm dừng | Cảnh báo `breakout` hoặc theo hàm |
| `backtest(signal, { tp, sl, hold, range })` | kết quả backtest | Event study trên nến ngày |
| `similar({ top, range })` | phiên tương tự | Thử nghiệm |

## Handle chỉ số: `vn.index(symbol)`

| Hàm | Trả về | Mô tả |
|---|---|---|
| `price()` | `Quote` | Mức điểm hiện tại so với phiên trước |
| `history(range \| { from, to, interval })` | `Bar[]` | Nến tính bằng điểm |
| `context(options?)`, `prompt(options?)` | bối cảnh | Như handle cổ phiếu |
| `health(options?)` | sức khoẻ thị trường | Ngày phân phối, ngày bùng nổ xác nhận (phương pháp của William O'Neil) |

## Chỉ báo: `vnstock-js/indicators`

`sma`, `ema`, `rsi`, `macd`, `bollinger`, `atr`, `superTrend`, `ichimoku`, `ichimokuFutureCloud`, `swingPivots`, `supportResistance`, `extremeZones`, `candlePatterns`, `turtleSignals`, `marketHealth`, `volumeZScore`, `breakouts`, `patternReport`. Mọi hàm nhận `Bar[]`, trả kết quả theo `time`. Xem [Chỉ báo & pattern](/docs/key-features/advanced/indicators).

## Proxy: `vnstock-js/proxy`

`nextHandler()`, `workerHandler()`, `expressHandler()`. Xem [Trình duyệt & proxy](/docs/key-features/advanced/proxy).

## Lỗi

`VnstockError`, `InvalidSymbolError`, `InvalidParameterError`, `NetworkError`, `RateLimitError`, `ApiError`, `ParseError`, `DataUnavailableError`. Xem [Quy ước & đơn vị](/docs/getting-started/conventions#lỗi).