diff --git a/.gitignore b/.gitignore index b7926f33..60236964 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,5 @@ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json old_docs .superpowers +docs/superpowers +.claude/worktrees diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index bcd64881..bf23f1ed 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -128,6 +128,7 @@ export default defineConfig( pattern: ({ filePath }) => { return `https://github.com/longbridge/developers/edit/main/docs/${filePath}` }, + text: 'Edit', }, logo: { src: 'https://assets.wbrks.com/assets/logo/logo-without-title-lb.svg', diff --git a/docs/.vitepress/locales/en/nav.ts b/docs/.vitepress/locales/en/nav.ts index 7193b3f9..bb21096a 100644 --- a/docs/.vitepress/locales/en/nav.ts +++ b/docs/.vitepress/locales/en/nav.ts @@ -1,14 +1,12 @@ import type { DefaultTheme } from 'vitepress' -import { filterNavItems, getRegion } from '../../region-utils' +import { filterNavItems } from '../../region-utils' export const nav = (): DefaultTheme.NavItem[] => { - const isCN = getRegion() === 'cn' return filterNavItems([ { text: 'Home', link: '/', activeMatch: '^(/en)?/$' }, { text: 'Skill', link: '/skill', activeMatch: '^(/en)?/skill' }, - isCN - ? { text: 'CLI', link: '/docs/cli', activeMatch: '^(/en)?/docs/cli' } - : { text: 'Docs', link: '/docs', activeMatch: '^(/en)?/docs(?!/api)' }, + { text: 'Docs', link: '/docs', activeMatch: '^(/en)?/docs(?!/cli)(?!/api)' }, + { text: 'CLI', link: '/docs/cli', activeMatch: '^(/en)?/docs/cli' }, { text: 'API Reference', link: '/docs/api', activeMatch: '^(/en)?/docs/api' }, { text: 'SDK', link: '/sdk', activeMatch: '^(/en)?/sdk' }, { text: 'Issues', link: 'https://github.com/longbridge/openapi/issues', target: '_blank' }, diff --git a/docs/.vitepress/locales/en/sidebar.ts b/docs/.vitepress/locales/en/sidebar.ts index b82700c2..89af7a06 100644 --- a/docs/.vitepress/locales/en/sidebar.ts +++ b/docs/.vitepress/locales/en/sidebar.ts @@ -1,6 +1,25 @@ import { DefaultTheme } from 'vitepress' -import { genMarkdowDocs } from '../../theme/utils/gen' +import { genMarkdowDocs, SIDEBAR_ICONS_MAP } from '../../theme/utils/gen' -const docsSidebar = genMarkdowDocs('en', 'docs') +const docsSidebar = genMarkdowDocs('en', 'docs', { exclude: ['cli'] }) +const cliSidebar = genMarkdowDocs('en', 'docs/cli') -export const sidebar: DefaultTheme.Sidebar = docsSidebar() +function buildCliSidebar(): DefaultTheme.SidebarItem[] { + const items = cliSidebar() + const installIdx = items.findIndex((item) => typeof item.link === 'string' && item.link.includes('installation')) + const githubItem: DefaultTheme.SidebarItem = { + text: `${SIDEBAR_ICONS_MAP.github}GitHub`, + link: 'https://github.com/longbridge/longbridge-terminal', + } + if (installIdx !== -1) { + items.splice(installIdx + 1, 0, githubItem) + } else { + items.push(githubItem) + } + return items +} + +export const sidebar: DefaultTheme.Sidebar = { + '/docs/cli': buildCliSidebar(), + '/docs': docsSidebar(), +} diff --git a/docs/.vitepress/locales/zh-CN/nav.ts b/docs/.vitepress/locales/zh-CN/nav.ts index fe137eac..dae471fc 100644 --- a/docs/.vitepress/locales/zh-CN/nav.ts +++ b/docs/.vitepress/locales/zh-CN/nav.ts @@ -1,14 +1,12 @@ import type { DefaultTheme } from 'vitepress' -import { filterNavItems, getRegion } from '../../region-utils' +import { filterNavItems } from '../../region-utils' export const nav = (lang: string): DefaultTheme.NavItem[] => { - const isCN = getRegion() === 'cn' return filterNavItems([ { text: '首页', link: `/${lang}/`, activeMatch: `^/${lang}/$` }, { text: 'Skill', link: `/${lang}/skill`, activeMatch: `^/${lang}/skill` }, - isCN - ? { text: 'CLI', link: `/${lang}/docs/cli`, activeMatch: `^/${lang}/docs/cli` } - : { text: '文档', link: `/${lang}/docs`, activeMatch: `^/${lang}/docs(?!/api)` }, + { text: '文档', link: `/${lang}/docs`, activeMatch: `^/${lang}/docs(?!/cli)(?!/api)` }, + { text: 'CLI', link: `/${lang}/docs/cli`, activeMatch: `^/${lang}/docs/cli` }, { text: 'API 参考', link: `/${lang}/docs/api`, activeMatch: `^/${lang}/docs/api` }, { text: 'SDK', link: `/${lang}/sdk`, activeMatch: `^/${lang}/sdk` }, { text: 'Issues', link: 'https://github.com/longbridge/openapi/issues', target: '_blank' }, diff --git a/docs/.vitepress/locales/zh-CN/sidebar.ts b/docs/.vitepress/locales/zh-CN/sidebar.ts index aa7cf932..59041a19 100644 --- a/docs/.vitepress/locales/zh-CN/sidebar.ts +++ b/docs/.vitepress/locales/zh-CN/sidebar.ts @@ -1,9 +1,26 @@ import { DefaultTheme } from 'vitepress' -import { genMarkdowDocs } from '../../theme/utils/gen' +import { genMarkdowDocs, SIDEBAR_ICONS_MAP } from '../../theme/utils/gen' const lang = 'zh-CN' -const docsSidebar = genMarkdowDocs(lang, 'docs') +const docsSidebar = genMarkdowDocs(lang, 'docs', { exclude: ['cli'] }) +const cliSidebar = genMarkdowDocs(lang, 'docs/cli') + +function buildCliSidebar(): DefaultTheme.SidebarItem[] { + const items = cliSidebar() + const installIdx = items.findIndex((item) => typeof item.link === 'string' && item.link.includes('installation')) + const githubItem: DefaultTheme.SidebarItem = { + text: `${SIDEBAR_ICONS_MAP.github}GitHub`, + link: 'https://github.com/longbridge/longbridge-terminal', + } + if (installIdx !== -1) { + items.splice(installIdx + 1, 0, githubItem) + } else { + items.push(githubItem) + } + return items +} export const sidebar: DefaultTheme.Sidebar = { - [`/${lang}`]: { base: `/${lang}`, items: docsSidebar() }, + [`/${lang}/docs/cli`]: buildCliSidebar(), + [`/${lang}/docs`]: docsSidebar(), } diff --git a/docs/.vitepress/locales/zh-HK/nav.ts b/docs/.vitepress/locales/zh-HK/nav.ts index d822d107..695622d9 100644 --- a/docs/.vitepress/locales/zh-HK/nav.ts +++ b/docs/.vitepress/locales/zh-HK/nav.ts @@ -1,14 +1,12 @@ import type { DefaultTheme } from 'vitepress' -import { filterNavItems, getRegion } from '../../region-utils' +import { filterNavItems } from '../../region-utils' export const nav = (lang: string): DefaultTheme.NavItem[] => { - const isCN = getRegion() === 'cn' return filterNavItems([ { text: '首頁', link: `/${lang}/`, activeMatch: `^/${lang}/$` }, { text: 'Skill', link: `/${lang}/skill`, activeMatch: `^/${lang}/skill` }, - isCN - ? { text: 'CLI', link: `/${lang}/docs/cli`, activeMatch: `^/${lang}/docs/cli` } - : { text: '文檔', link: `/${lang}/docs`, activeMatch: `^/${lang}/docs(?!/api)` }, + { text: '文檔', link: `/${lang}/docs`, activeMatch: `^/${lang}/docs(?!/cli)(?!/api)` }, + { text: 'CLI', link: `/${lang}/docs/cli`, activeMatch: `^/${lang}/docs/cli` }, { text: 'API 參考', link: `/${lang}/docs/api`, activeMatch: `^/${lang}/docs/api` }, { text: 'SDK', link: `/${lang}/sdk`, activeMatch: `^/${lang}/sdk` }, { text: 'Issues', link: 'https://github.com/longbridge/openapi/issues', target: '_blank' }, diff --git a/docs/.vitepress/locales/zh-HK/sidebar.ts b/docs/.vitepress/locales/zh-HK/sidebar.ts index 9de0dfb8..12bc5a8f 100644 --- a/docs/.vitepress/locales/zh-HK/sidebar.ts +++ b/docs/.vitepress/locales/zh-HK/sidebar.ts @@ -1,9 +1,26 @@ import { DefaultTheme } from 'vitepress' -import { genMarkdowDocs } from '../../theme/utils/gen' +import { genMarkdowDocs, SIDEBAR_ICONS_MAP } from '../../theme/utils/gen' const lang = 'zh-HK' -const docsSidebar = genMarkdowDocs(lang, 'docs') +const docsSidebar = genMarkdowDocs(lang, 'docs', { exclude: ['cli'] }) +const cliSidebar = genMarkdowDocs(lang, 'docs/cli') + +function buildCliSidebar(): DefaultTheme.SidebarItem[] { + const items = cliSidebar() + const installIdx = items.findIndex((item) => typeof item.link === 'string' && item.link.includes('installation')) + const githubItem: DefaultTheme.SidebarItem = { + text: `${SIDEBAR_ICONS_MAP.github}GitHub`, + link: 'https://github.com/longbridge/longbridge-terminal', + } + if (installIdx !== -1) { + items.splice(installIdx + 1, 0, githubItem) + } else { + items.push(githubItem) + } + return items +} export const sidebar: DefaultTheme.Sidebar = { - [`/${lang}`]: { base: `/${lang}`, items: docsSidebar() }, + [`/${lang}/docs/cli`]: buildCliSidebar(), + [`/${lang}/docs`]: docsSidebar(), } diff --git a/docs/.vitepress/md-plugins/cli-command.ts b/docs/.vitepress/md-plugins/cli-command.ts index 1e4d6090..2eb92df4 100644 --- a/docs/.vitepress/md-plugins/cli-command.ts +++ b/docs/.vitepress/md-plugins/cli-command.ts @@ -8,8 +8,61 @@ function escapeHtml(str: string): string { .replace(/"/g, '"') } +// Map CLI subcommand names to their doc page paths (locale-independent) +const CLI_COMMAND_MAP: Record = { + // Market Data + quote: '/docs/cli/market-data/quote', + depth: '/docs/cli/market-data/depth', + kline: '/docs/cli/market-data/kline', + trades: '/docs/cli/market-data/trades', + brokers: '/docs/cli/market-data/brokers', + intraday: '/docs/cli/market-data/intraday', + static: '/docs/cli/market-data/static', + 'market-temp': '/docs/cli/market-data/market-temp', + 'calc-index': '/docs/cli/market-data/calc-index', + capital: '/docs/cli/market-data/capital', + trading: '/docs/cli/market-data/trading', + participants: '/docs/cli/market-data/participants', + 'security-list': '/docs/cli/market-data/security-list', + subscriptions: '/docs/cli/market-data/subscriptions', + // Derivatives + option: '/docs/cli/derivatives/option', + warrant: '/docs/cli/derivatives/warrant', + // Content + news: '/docs/cli/content/news', + topic: '/docs/cli/content/topic', + topics: '/docs/cli/content/topic', + filing: '/docs/cli/content/filing', + // Watchlist + watchlist: '/docs/cli/watchlist/watchlist', + // Account + assets: '/docs/cli/account/assets', + positions: '/docs/cli/account/positions', + 'fund-positions': '/docs/cli/account/fund-positions', + 'cash-flow': '/docs/cli/account/cash-flow', + portfolio: '/docs/cli/account/portfolio', + // Orders + order: '/docs/cli/orders/order', + orders: '/docs/cli/orders/order', + buy: '/docs/cli/orders/order', + sell: '/docs/cli/orders/order', + cancel: '/docs/cli/orders/order', + replace: '/docs/cli/orders/order', + executions: '/docs/cli/orders/order', + 'max-qty': '/docs/cli/orders/max-qty', + 'margin-ratio': '/docs/cli/orders/margin-ratio', + 'exchange-rate': '/docs/cli/orders/exchange-rate', +} + +function getLocalePrefix(localeIndex: string): string { + switch (localeIndex) { + case 'zh-CN': return '/zh-CN' + case 'zh-HK': return '/zh-HK' + default: return '' + } +} -function getInstallLabel(localeIndex: string): string { +function getInstallTitle(localeIndex: string): string { switch (localeIndex) { case 'zh-CN': return '安装 CLI' case 'zh-HK': return '安裝 CLI' @@ -17,12 +70,30 @@ function getInstallLabel(localeIndex: string): string { } } -function getInstallUrl(localeIndex: string): string { +function getUsageTitle(localeIndex: string): string { switch (localeIndex) { - case 'zh-CN': return '/zh-CN/docs/cli' - case 'zh-HK': return '/zh-HK/docs/cli' - default: return '/docs/cli' + case 'zh-CN': return 'CLI 使用文档' + case 'zh-HK': return 'CLI 使用文件' + default: return 'CLI Usage Docs' + } +} + +function getInstallUrl(localeIndex: string): string { + return `${getLocalePrefix(localeIndex)}/docs/cli/installation` +} + +function extractFirstCommand(content: string): string | null { + for (const line of content.split('\n')) { + const trimmed = line.trim() + if (!trimmed || trimmed.startsWith('#')) continue + const parts = trimmed.split(/\s+/) + if (parts[0] === 'longbridge' && parts[1]) return parts[1] } + return null +} + +function getUsageUrl(cmd: string): string | null { + return CLI_COMMAND_MAP[cmd] ?? null } // Colors matching github-light / github-dark shiki themes (auto-switch via CSS vars) @@ -67,36 +138,54 @@ function renderLine(line: string): string { return html + '' } -function generateCliBlock(content: string, installLabel: string, installUrl: string): string { +// Inline SVG icons for the CLI header +const ICON_TERMINAL = `` +const ICON_BOOK = `` +const ICON_DOWNLOAD = `` + +function generateCliBlock(content: string, installTitle: string, installUrl: string, usageTitle: string, usageUrl: string | null): string { const lines = content .split('\n') .map(renderLine) .filter(Boolean) .join('\n') + const usageBtn = usageUrl + ? `${ICON_BOOK}` + : '' + const installBtn = `${ICON_DOWNLOAD}` + return ( `
` + - `

CLI${escapeHtml(installLabel)}

` + + `
` + + `${ICON_TERMINAL}CLI` + + `
${usageBtn}${installBtn}
` + + `
` + `
` + - `bash` + `
` +
     `${lines}
` + `
` ) } -function replaceCliCommand(src: string, installLabel: string, installUrl: string): string { +function replaceCliCommand(src: string, installTitle: string, installUrl: string, usageTitle: string, localeIndex: string): string { return src.replace( /([\s\S]*?)<\/CliCommand>/g, - (_, content: string) => generateCliBlock(content.trim(), installLabel, installUrl), + (_, content: string) => { + const trimmed = content.trim() + const cmd = extractFirstCommand(trimmed) + const usageUrl = cmd ? getUsageUrl(cmd) : null + return generateCliBlock(trimmed, installTitle, installUrl, usageTitle, usageUrl) + }, ) } export function CliCommandPlugin(md: MarkdownIt) { md.core.ruler.push('cli_command', (state) => { const localeIndex: string = state.env?.localeIndex ?? 'root' - const installLabel = getInstallLabel(localeIndex) + const installTitle = getInstallTitle(localeIndex) const installUrl = getInstallUrl(localeIndex) + const usageTitle = getUsageTitle(localeIndex) let i = 0 while (i < state.tokens.length) { @@ -104,7 +193,7 @@ export function CliCommandPlugin(md: MarkdownIt) { // Case 1: already an html_block (e.g. multiline ) if (token.type === 'html_block' && token.content.includes('')) { - token.content = replaceCliCommand(token.content, installLabel, installUrl) + token.content = replaceCliCommand(token.content, installTitle, installUrl, usageTitle, localeIndex) i++ continue } @@ -116,7 +205,7 @@ export function CliCommandPlugin(md: MarkdownIt) { state.tokens[i + 1].content.includes('') && state.tokens[i + 2]?.type === 'paragraph_close' ) { - const replaced = replaceCliCommand(state.tokens[i + 1].content, installLabel, installUrl) + const replaced = replaceCliCommand(state.tokens[i + 1].content, installTitle, installUrl, usageTitle, localeIndex) const htmlToken = new state.Token('html_block', '', 0) htmlToken.content = replaced state.tokens.splice(i, 3, htmlToken) diff --git a/docs/.vitepress/theme/layouts/Layout.vue b/docs/.vitepress/theme/layouts/Layout.vue index 21fc0e59..7caf40a2 100644 --- a/docs/.vitepress/theme/layouts/Layout.vue +++ b/docs/.vitepress/theme/layouts/Layout.vue @@ -23,9 +23,9 @@ const { llmMarkdownLink } = useLLMMarkdownLink() diff --git a/docs/.vitepress/theme/style/index.css b/docs/.vitepress/theme/style/index.css index 70743dea..078c1dea 100644 --- a/docs/.vitepress/theme/style/index.css +++ b/docs/.vitepress/theme/style/index.css @@ -85,11 +85,14 @@ html:root { } .llms-text-link { - font-size: 13px; - font-style: italic; + display: inline-flex; + align-items: center; + line-height: 32px; + font-size: 14px; + font-weight: 400; color: var(--vp-c-text-2); text-decoration: none; - white-space: nowrap; + transition: color 0.25s; } .llms-text-link:hover { @@ -145,29 +148,64 @@ html:root { } /* CLI Command block */ -.vp-cli-command h2 { +.vp-cli-command { + margin: 16px 0 20px; + border-radius: 8px; + overflow: hidden; +} + +.vp-cli-command div[class*="language-"].vp-adaptive-theme { + border-radius: 0 !important; + box-shadow: none !important; + padding-top: 0 !important; + margin: 0 !important; +} + +.vp-cli-command div[class*="language-"].vp-adaptive-theme::before { + display: none; +} + +.vp-cli-header { display: flex; align-items: center; + padding: 6px 10px 6px 14px; + border-radius: 8px 8px 0 0; + border-bottom: 1px solid var(--vp-code-block-divider-color, rgba(128,128,128,0.15)); + background-color: var(--vp-code-block-bg); } -.vp-cli-install-link { +.vp-cli-badge { display: inline-flex; align-items: center; - gap: 4px; - font-size: 12px; - font-weight: 500; - line-height: 1; - color: var(--vp-c-text-2) !important; - text-decoration: none !important; - transition: color 0.15s; + gap: 5px; + font-size: 11px; + font-weight: 600; + letter-spacing: 0.06em; + text-transform: uppercase; + color: var(--vp-c-text-3); + user-select: none; +} + +.vp-cli-actions { + display: flex; + align-items: center; + gap: 2px; margin-left: auto; } -.vp-cli-install-link::after { - content: '↗'; - font-size: 11px; +.vp-cli-action { + display: inline-flex; + align-items: center; + justify-content: center; + width: 26px; + height: 26px; + border-radius: 5px; + color: var(--vp-c-text-3); + text-decoration: none !important; + transition: color 0.15s, background-color 0.15s; } -.vp-cli-install-link:hover { - color: var(--vp-c-text-1) !important; +.vp-cli-action:hover { + color: var(--vp-c-text-1); + background-color: var(--vp-c-default-soft); } diff --git a/docs/.vitepress/theme/utils/gen.ts b/docs/.vitepress/theme/utils/gen.ts index b7d0fe60..291c6a46 100644 --- a/docs/.vitepress/theme/utils/gen.ts +++ b/docs/.vitepress/theme/utils/gen.ts @@ -10,11 +10,24 @@ const SIDEBAR_ICONS: Record = { cpu: ``, terminal: ``, sparkles: ``, + 'bar-chart-2': ``, + layers: ``, + 'book-open': ``, + search: ``, + briefcase: ``, + 'arrow-right-left': ``, + 'trending-up': ``, + star: ``, + newspaper: ``, + github: ``, } +export const SIDEBAR_ICONS_MAP = SIDEBAR_ICONS + interface CategoryConfig { position?: number label?: string + icon?: string collapsible?: boolean collapsed?: boolean link?: string | null | { title: string; slug: string } @@ -26,18 +39,26 @@ interface CategoryConfig { } type MSidebar = DefaultTheme.SidebarItem & { position?: number } + +interface GenOptions { + exclude?: string[] + debug?: boolean +} + /** * Generate navigation items by reading markdown files from a directory * @param lang Language code (e.g., 'en', 'zh-CN') * @param basePath Base path to read files from (e.g., 'docs') * @returns Function that returns an array of navigation items */ -export function genMarkdowDocs(lang: string, basePath: string, debug = false) { +export function genMarkdowDocs(lang: string, basePath: string, options: GenOptions = {}) { return function (): DefaultTheme.SidebarItem[] { const docsRoot = path.resolve(process.cwd(), 'docs') const rootDir = path.join(docsRoot, lang, basePath) - const fc = generateSidebarItems(rootDir, `/${basePath}`, `/${basePath}`, 0, docsRoot) - if (debug) { + const langPrefix = lang === 'en' ? '' : `/${lang}` + const relPath = `${langPrefix}/${basePath}` + const fc = generateSidebarItems(rootDir, relPath, relPath, 0, docsRoot, options.exclude) + if (options.debug) { fs.writeFileSync(path.resolve(__dirname, `./${lang}_sidebar.json`), JSON.stringify(fc, null, 2)) } return fc @@ -85,7 +106,8 @@ function generateSidebarItems( relativePath: string, rootPath: string, depth = 0, - docsRoot?: string + docsRoot?: string, + excludeDirs?: string[] ): DefaultTheme.SidebarItem[] { const items: DefaultTheme.SidebarItem[] = [] @@ -138,18 +160,22 @@ function generateSidebarItems( const dirItems: MSidebar[] = [] for (const dir of directories) { + if (depth === 0 && excludeDirs?.includes(dir)) continue const subDirPath = path.join(dirPath, dir) const subRelativePath = path.join(relativePath, dir) const subCategoryConfig = readCategoryConfig(subDirPath) - const subItems = generateSidebarItems(subDirPath, subRelativePath, rootPath, depth + 1, docsRoot) + const subItems = generateSidebarItems(subDirPath, subRelativePath, rootPath, depth + 1, docsRoot, excludeDirs) if (subItems.length > 0) { const dirTitle = subCategoryConfig?.label || formatDirName(dir) + const iconKey = subCategoryConfig?.icon + const iconHtml = iconKey && SIDEBAR_ICONS[iconKey] ? `${SIDEBAR_ICONS[iconKey]}` : '' + const text = iconHtml ? `${iconHtml}${dirTitle}` : dirTitle const collapsed = depth === 0 ? false : (subCategoryConfig?.collapsed ?? true) const position = subCategoryConfig?.position const sidebarItem: MSidebar = { - text: dirTitle, + text, items: subItems, collapsed, position, diff --git a/docs/en/docs/cli.md b/docs/en/docs/cli.md deleted file mode 100644 index 74c16476..00000000 --- a/docs/en/docs/cli.md +++ /dev/null @@ -1,408 +0,0 @@ ---- -sidebar_position: 2.1 -slug: /cli -sidebar_label: CLI -sidebarCollapsed: true -sidebar_icon: terminal -id: cli ---- - -# Longbridge CLI - -Longbridge CLI is an AI-native CLI tool covering every Longbridge OpenAPI endpoint — real-time market data, account management, and trading. Designed for scripting, AI-agent tool-calling, and daily trading workflows from the terminal. - -**GitHub:** [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal) - -```bash -$ longbridge static NVDA.US -+---------+--------------------+----------+----------+----------+--------------+--------------+--------------------+--------------------+-------------------+----------------+ -| Symbol | Name (EN) | Exchange | Currency | Lot Size | Total Shares | Circ. Shares | EPS | EPS TTM | BPS | Dividend Yield | -+============================================================================================================================================================================+ -| NVDA.US | NVIDIA Corporation | NASD | USD | 1 | 24300000000 | 23501828621 | 4.9410288065843621 | 4.9410288065843621 | 6.472962962962963 | 0.04 | -+---------+--------------------+----------+----------+----------+--------------+--------------+--------------------+--------------------+-------------------+----------------+ - -$ longbridge quote TSLA.US NVDA.US --format json -[ - { - "high": "403.730", - "last": "395.560", - "low": "394.420", - "open": "396.220", - "prev_close": "391.200", - "status": "Normal", - "symbol": "TSLA.US", - "turnover": "23138752546.000", - "volume": "58068343" - }, - { - "high": "188.880", - "last": "183.220", - "low": "181.410", - "open": "182.970", - "prev_close": "180.250", - "status": "Normal", - "symbol": "NVDA.US", - "turnover": "40023702698.000", - "volume": "217307380" - } -] -``` - -## Installation - - - - -```bash -brew install --cask longbridge/tap/longbridge-terminal -``` - - - - -```bash -curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh -``` - - - - -```powershell -scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json -``` - - - - -```powershell -iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex -``` - - - - -Installs `longbridge` to `/usr/local/bin` (macOS/Linux) or `%LOCALAPPDATA%\Programs\longbridge` (Windows). On Windows the binary is `longbridge.exe`. - -After installation, authenticate and explore available commands: - -```bash -longbridge --help # List all available commands -longbridge login # Authenticate via device flow — displays a URL and code to authorize on any device -``` - -## Authentication - -Uses OAuth 2.0 device authorization flow — works in any environment (local, SSH, headless): - -```bash -longbridge login # Displays a verification URL and code; authorize on any device or browser -longbridge logout # Clear saved token -``` - -## Available capabilities - -### Market data - -```bash -longbridge quote TSLA.US 700.HK # Real-time quotes -longbridge depth TSLA.US # Level 2 order book depth -longbridge trades TSLA.US [--count 50] # Recent tick-by-tick trades -longbridge kline TSLA.US [--period day] [--count 100] # OHLCV candlestick data -longbridge kline history TSLA.US --start 2024-01-01 --end 2024-12-31 # Historical candlestick data -longbridge intraday TSLA.US # Intraday minute-by-minute data -longbridge static TSLA.US # Static reference info -longbridge calc-index TSLA.US --index pe,pb,eps # Financial indexes (PE, PB, EPS, etc.) -longbridge capital flow TSLA.US # Intraday capital flow time series -longbridge capital dist TSLA.US # Capital distribution snapshot -longbridge market-temp [HK|US|CN|SG] # Market sentiment temperature (0–100) -``` - -### Company filings & announcements - -```bash -longbridge filing list AAPL.US [--count 20] # Company filings and announcements (earnings, disclosures, SEC filings, etc.) -longbridge filing detail AAPL.US # Full Markdown content of a filing; --file-index N for multi-file filings (e.g. 8-K exhibit) -``` - -### Fundamentals & analysis - -```bash -# Financial statements (income, balance sheet, cash flow) -longbridge financial-report TSLA.US -# Income statement, annual -longbridge financial-report TSLA.US --kind IS --report af -# Balance sheet, quarterly -longbridge financial-report TSLA.US --kind BS --report qf -# Valuation snapshot: P/E, P/B, P/S, dividend yield + peer comparison -longbridge valuation TSLA.US -# Historical P/E time series -longbridge valuation TSLA.US --history -# P/B history, 5-year range -longbridge valuation TSLA.US --history --indicator pb --range 5 -# Analyst EPS forecast consensus -longbridge forecast-eps TSLA.US -# Revenue/profit/EPS consensus with beat/miss annotations -longbridge consensus TSLA.US -# Rating distribution and consensus target price -longbridge institution-rating TSLA.US -# Monthly rating trends and analyst accuracy -longbridge institution-rating detail TSLA.US -# Institutional shareholders with change tracking -longbridge shareholder AAPL.US -# Increasing holders, sorted by position size -longbridge shareholder AAPL.US --range inc --sort owned -# Funds and ETFs that hold a symbol (top 20) -longbridge fund-holder AAPL.US -# All holders -longbridge fund-holder AAPL.US --count -1 -# Historical dividends -longbridge dividend AAPL.US -# Dividend distribution plan details -longbridge dividend detail AAPL.US -# Upcoming financial events -longbridge finance-calendar financial -# Earnings calendar for specific symbols -longbridge finance-calendar report --symbol AAPL.US --symbol TSLA.US -# High-importance macro events only -longbridge finance-calendar macrodata --star 3 -# Upcoming US dividend events -longbridge finance-calendar dividend --market US -# Exchange rates for all supported currencies -longbridge exchange-rate -# Top active fund managers by AUM (SEC 13F data; passive index giants excluded) -longbridge investors -# Top 10 only -longbridge investors --top 10 -# Holdings for a specific investor by SEC CIK -longbridge investors 0001067983 -# Insider trades (SEC Form 4) for a symbol -longbridge insider-trades TSLA.US -``` - -### Community content - -```bash -longbridge topic mine # My published topics (all types) -longbridge topic mine --type article # Articles only -longbridge topic mine --type post --size 10 # Short posts, 10 per page -longbridge topic mine --page 2 # Paginate -longbridge topic create --body "Bullish on 700.HK" # Short post (plain text) -longbridge topic create --body "NVDA GTC highlights" --tickers NVDA.US # With related tickers -longbridge topic create --title "My Analysis" --body "$(cat post.md)" --type article # Article from file -``` - -### Options & warrants - -```bash -longbridge option quote AAPL240119C190000 # Real-time option quotes -longbridge option chain AAPL.US # Option chain: all expiry dates -longbridge option chain AAPL.US --date 2024-01-19 # Strike prices for a given expiry -longbridge warrant quote 12345.HK # Real-time warrant quotes -longbridge warrant list 700.HK # Warrants linked to an underlying -``` - -### Watchlist - -```bash -longbridge watchlist # List watchlist groups -longbridge watchlist create "My Portfolio" # Create a new group -longbridge watchlist update --add TSLA.US --remove AAPL.US # Add/remove securities -longbridge watchlist delete # Delete a group -longbridge watchlist pin TSLA.US AAPL.US # Pin securities to the top of their group -longbridge watchlist pin --remove 700.HK # Unpin -``` - -### Trading - -```bash -longbridge orders # Today's orders; add --history for past orders -longbridge buy TSLA.US 100 --price 250.00 # Submit a buy order (prompts for confirmation) -longbridge sell TSLA.US 100 --price 260.00 # Submit a sell order (prompts for confirmation) -longbridge cancel # Cancel a pending order (prompts for confirmation) -longbridge replace --qty 200 --price 255.00 # Modify a pending order -longbridge assets # Full account assets overview (cash, buying power, margin, risk level) -longbridge portfolio # Portfolio P/L, asset distribution by market, holdings, and cash -longbridge positions # Stock positions -longbridge fund-positions # Fund positions -longbridge executions # Trade executions (fills) -``` - -### Account statements - -```bash -longbridge statement list # List recent daily statements -longbridge statement list --type monthly # List monthly statements -longbridge statement export --file-key --section equity_holdings # Export a section as Markdown to stdout -longbridge statement export --file-key --section stock_trades -o trades.csv # Export to CSV file -longbridge statement export --file-key --all # Export all non-empty sections -longbridge statement export --file-key --all -o ./report/ # Export all non-empty sections as CSV -``` - -### Symbol format - -``` -. e.g. TSLA.US 700.HK 600519.SH -``` - -Markets: `HK` (Hong Kong) · `US` (United States) · `CN` / `SH` / `SZ` (China A-share) · `SG` (Singapore) - -## AI integration - -### JSON output - -All commands support `--format json` for machine-readable output, suitable for AI-agent tool-calling and piping: - -```bash -longbridge quote TSLA.US --format json -longbridge positions --format json | jq '.[] | {symbol, quantity}' -``` - -### Install the AI skill - -Install the Longbridge Skill to let your AI assistant (Claude Code, Codex, Cursor, etc.) use all `longbridge` commands on your behalf. Once installed, you can ask in plain language and the AI handles the data fetching, analysis, and order execution. - -Things you can do after installing the Skill: - -- Screen stocks across US, HK, A-shares, and Singapore markets using conditions like market cap, P/E, and technical signals -- Get a full technical diagnosis for any stock — MA, MACD, KDJ, RSI, support/resistance levels, across daily/hourly/15-min charts -- Analyze earnings: actual vs analyst estimates, revenue by segment, valuation metrics, SEC filings -- Track insider trades and institutional position changes for any stock -- Place limit orders, trailing stops, and options orders — with confirmation before execution -- Review your portfolio P&L, position breakdown, and contribution by stock for any date range - -```bash -npx skills add longbridge/developers -``` - -If the Skill isn't triggered automatically, prefix your request with `/longbridge` to force it — for example: `/longbridge get the current quote for AAPL`. - -Once installed, AI can query market data, run technical analysis, and manage trades directly from the conversation: - -``` -claude> Show me recent 5 days performance of NVDA and TSLA - -⏺ Bash(longbridge kline TSLA.US --period day --count 5 & longbridge kline NVDA.US --period day --count 5 & wait) - ⎿ +---------------------+---------+---------+---------+---------+----------+-----------------+ - | Time | Open | High | Low | Close | Volume | Turnover | - … +11 lines (ctrl+o to expand) - -⏺ TSLA data loaded. Here's what we have: - - TSLA.US — Last 5 Days - - ┌────────┬────────┬────────┬────────┬────────┬──────────┐ - │ Date │ Open │ High │ Low │ Close │ Change │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 10 │ 402.22 │ 406.59 │ 398.19 │ 399.24 │ — │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 11 │ 402.28 │ 416.38 │ 402.15 │ 407.82 │ ▲ +2.15% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 12 │ 405.18 │ 406.50 │ 394.65 │ 395.01 │ ▼ -3.14% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 13 │ 399.17 │ 400.20 │ 389.95 │ 391.20 │ ▼ -0.96% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 16 │ 396.22 │ 403.73 │ 394.42 │ 395.56 │ ▲ +1.11% │ - └────────┴────────┴────────┴────────┴────────┴──────────┘ - - 5-day return: -0.92% | Range: $389.95 – $416.38 -``` - -### Earnings analysis example - -AI can use `filings` to discover filing IDs, then `filing-detail` to pull the full content and run cross-company earnings comparisons: - -``` -claude> Compare TSLA and NVDA Q4 2025 earnings - -⏺ Bash(longbridge filing list TSLA.US & longbridge filing list NVDA.US & wait) - ⎿ TSLA.US 610186794100660481 10-K 2025-02-26 Annual Report FY2025 - NVDA.US 620129220687041793 8-K 2026-02-26 Q4 FY2026 Earnings Release - … +18 filings - -⏺ Bash(longbridge filing detail TSLA.US 610186794100660481 --file-index 0 & - longbridge filing detail NVDA.US 620129220687041793 --file-index 1 & wait) - ⎿ [TSLA 10-K FY2025 / NVDA 8-K Exhibit 99.1 Q4 FY2026 loaded] - -⏺ Source: official filings via Longbridge filings + filing-detail - - TSLA: 10-K FY2025 (filing-detail TSLA.US 610186794100660481 --file-index 0) - - NVDA: 8-K Exhibit 99.1 Q4 FY2026 (filing-detail NVDA.US 620129220687041793 --file-index 1) - - 1. Income statement comparison (full year) - - ┌──────────────────┬─────────────┬─────────────┬─────────────┐ - │ Metric │ TSLA FY2025 │ NVDA FY2026 │ Delta │ - ├──────────────────┼─────────────┼─────────────┼─────────────┤ - │ Revenue │ $94,827M │ $215,938M │ NVDA 2.3x │ - │ Revenue YoY │ -3% │ +65% │ — │ - │ Gross profit │ $17,094M │ $153,463M │ NVDA 9x │ - │ Gross margin │ 18.0% │ 71.1% │ +53 ppts │ - │ Operating income │ $4,355M │ $130,387M │ NVDA 30x │ - │ Operating margin │ 4.6% │ 60.4% │ +56 ppts │ - │ Net income │ $3,794M │ $120,067M │ NVDA 32x │ - │ Diluted EPS │ $1.08 │ $4.90 │ — │ - └──────────────────┴─────────────┴─────────────┴─────────────┘ - - 2. Cash flow comparison (full year) - - ┌──────────────────┬─────────────┬─────────────┐ - │ Metric │ TSLA FY2025 │ NVDA FY2026 │ - ├──────────────────┼─────────────┼─────────────┤ - │ Operating CF │ $14,747M │ $102,718M │ - │ CapEx │ $8,527M │ $6,042M │ - │ Free cash flow │ $6,220M │ $96,676M │ - │ FCF margin │ 6.6% │ 44.8% │ - └──────────────────┴─────────────┴─────────────┘ - - NVDA's CapEx is lower than TSLA's yet it generates 15x the free cash flow. - - 3. Key risks - - TSLA: intensifying EV competition, brand headwinds, Musk attention risk; - auto revenue -10% YoY, partially offset by energy (+27%) and services (+19%). - NVDA: China export controls; Q1 FY27 guidance of $78B already excludes China - data-center revenue — a single quarter roughly equal to TSLA's full year. -``` - -## Rate limits - -Longbridge OpenAPI: maximum 10 calls per second. The SDK auto-refreshes OAuth tokens. - -## Release notes - -### [v0.15.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.15.0) - -- **New: `portfolio` command** — total P/L, asset distribution by market (US/HK/CN/SG/Cash), holdings, and cash balances -- **New: `investors` command** — SEC 13F-based active fund manager rankings; view any investor's holdings by CIK with live prices -- **New: `insider-trades`** — SEC Form 4 insider transaction history for any symbol -- **New: `watchlist pin/unpin`** — pin securities to the top of a watchlist group -- **Enhanced: `assets`** — renamed from `balance`; now shows full asset overview: net assets, buying power, margin, risk level, and per-currency cash breakdown - -### [v0.14.2](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.2) - -- **New: `--lang` global flag** — set content language (`zh-CN`, `zh-HK`, `en`) for all commands; falls back to system `LANG` env var then `en` - -### [v0.14.1](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.1) - -- **New: CN region login** — `longbridge login` now supports China region routing -- **New: `-v` flag** — show version without entering the full command - -### [v0.14.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.0) - -- **New: Device auth login** — `longbridge login` now uses OAuth device flow; displays a URL and code to authorize on any device, works in SSH and headless environments; `--headless` flag removed -- **New: Order enhancements** — trailing stop and AO order types; `--expire-date`, `--outside-rth`, `--remark` added to order commands -- **Fix: Linux segfault** — prebuilt Linux binary now uses musl to fix crash on some distributions - -### [v0.13.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.13.0) - -- **New: Fundamentals & analysis commands** — `financial-report`, `valuation`, `forecast-eps`, `consensus`, `institution-rating`, `shareholder`, `fund-holder`, `dividend`, `finance-calendar`, `exchange-rate` -- **Breaking: command restructure** — 19 flat commands moved into subcommand trees (e.g. `news-detail` → `news detail`, `kline-history` → `kline history`, `warrant-list` → `warrant list`) -- **CN region support** — set `LONGBRIDGE_REGION=cn` to route through the China endpoint - -### [v0.12.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.12.0) - -- **New: `statement` commands** — list and export daily/monthly account statements -- **TUI** — fixed `q` quit; added news list and detail views inside watchlist - ---- - -Full changelog: [github.com/longbridge/longbridge-terminal/releases](https://github.com/longbridge/longbridge-terminal/releases) diff --git a/docs/en/docs/cli/account/_category_.json b/docs/en/docs/cli/account/_category_.json new file mode 100644 index 00000000..8e85818b --- /dev/null +++ b/docs/en/docs/cli/account/_category_.json @@ -0,0 +1 @@ +{ "label": "Portfolio & Account", "icon": "briefcase", "position": 7, "collapsed": true } diff --git a/docs/en/docs/cli/account/assets.md b/docs/en/docs/cli/account/assets.md new file mode 100644 index 00000000..baa0e351 --- /dev/null +++ b/docs/en/docs/cli/account/assets.md @@ -0,0 +1,41 @@ +--- +title: 'assets' +sidebar_label: 'assets' +sidebar_position: 3 +--- + +# longbridge assets + +View your full account overview — net assets, buying power, margin status, risk level, and cash balances across all currencies. + +## Basic Usage + +```bash +longbridge assets +``` + +``` +| Currency | Net Assets | Total Cash | Buy Power | Max Finance | Remaining Finance | Init Margin | Maintenance Margin | Risk Level | +|----------|------------|------------|------------|-------------|-------------------|-------------|--------------------|------------| +| USD | 125422.43 | 58638.84 | 106743.46 | 410651.27 | 371985.59 | 18678.97 | 16305.97 | Safe | + +| Currency | Available Cash | Frozen Cash | Settling Cash | Withdrawable | +|----------|----------------|-------------|---------------|--------------| +| USD | -38665.68 | 332.19 | -10108.02 | -38665.68 | +| HKD | 755592.21 | 64.69 | -27760.00 | 755592.21 | +``` + +## Examples + +### Check account overview + +```bash +longbridge assets +longbridge assets --format json +``` + +Displays net assets, total cash, buying power, margin usage, and risk level in a readable table. + +## Requirements + +OAuth account permission required. See the [account permission setup](/docs/trade/) guide. diff --git a/docs/en/docs/cli/account/cash-flow.md b/docs/en/docs/cli/account/cash-flow.md new file mode 100644 index 00000000..e5db2b7b --- /dev/null +++ b/docs/en/docs/cli/account/cash-flow.md @@ -0,0 +1,42 @@ +--- +title: 'cash-flow' +sidebar_label: 'cash-flow' +sidebar_position: 4 +--- + +# longbridge cash-flow + +View your cash flow history — deposits, withdrawals, dividend payments, trade settlements, and other account movements. + +## Basic Usage + +```bash +longbridge cash-flow +``` + +``` +| Flow Name | Symbol | Business Type | Balance | Currency | Time | Description | +|-----------|--------|---------------|---------|----------|------|-------------| +``` + +## Examples + +### View last 30 days of cash flow + +```bash +longbridge cash-flow +``` + +Lists all cash movements in the past 30 days, including the flow type, associated symbol, balance, currency, and timestamp. + +### Filter by date range + +```bash +longbridge cash-flow --start 2026-01-01 --end 2026-03-31 +``` + +Fetches cash flow records within a specific date range. Useful for quarterly reconciliation or tax reporting. + +## Requirements + +OAuth account permission required. See the [account permission setup](/docs/trade/) guide. diff --git a/docs/en/docs/cli/account/fund-holder.md b/docs/en/docs/cli/account/fund-holder.md new file mode 100644 index 00000000..a8d73779 --- /dev/null +++ b/docs/en/docs/cli/account/fund-holder.md @@ -0,0 +1,48 @@ +--- +title: 'fund-holder' +sidebar_label: 'fund-holder' +sidebar_position: 6 +--- + +# longbridge fund-holder + +Find which ETFs and funds hold a given stock, along with each fund's position ratio and report date. + +## Basic Usage + +```bash +longbridge fund-holder AAPL.US +``` + +``` +| name | symbol | currency | weight | report_date | +|----------------------------------------|---------|----------|--------|-------------| +| T-Rex 2X Long Apple Daily Target ETF | AAPX.US | USD | 67.62% | 2026.04.03 | +| Global X PureCap MSCI Infor Tech ETF | GXPT.US | USD | 19.58% | 2026.04.06 | +| AAPL 周收益 ETF - Roundhill | AAPW.US | USD | 16.76% | 2026.04.06 | +| 信息科技 ETF - Vanguard | VGT.US | USD | 15.84% | 2026.02.28 | +... +``` + +## Examples + +### Find top ETF holders of a stock + +```bash +longbridge fund-holder AAPL.US +longbridge fund-holder AAPL.US --format json +``` + +Lists the ETFs and funds with the largest exposure to the given stock, sorted by position ratio. + +### Get more holders + +```bash +longbridge fund-holder TSLA.US --count 50 +``` + +Use `--count` to retrieve more results beyond the default limit. + +## Requirements + +OAuth account permission required. See the [account permission setup](/docs/trade/) guide. diff --git a/docs/en/docs/cli/account/fund-positions.md b/docs/en/docs/cli/account/fund-positions.md new file mode 100644 index 00000000..5ac73d0a --- /dev/null +++ b/docs/en/docs/cli/account/fund-positions.md @@ -0,0 +1,35 @@ +--- +title: 'fund-positions' +sidebar_label: 'fund-positions' +sidebar_position: 5 +--- + +# longbridge fund-positions + +List your current fund and ETF positions. + +## Basic Usage + +```bash +longbridge fund-positions +``` + +``` +| Symbol | Name | Net Asset Value | Cost Net Asset Value | Currency | Holding Units | +|--------|------|-----------------|----------------------|----------|---------------| +``` + +## Examples + +### View fund/ETF holdings + +```bash +longbridge fund-positions +longbridge fund-positions --format json +``` + +Displays all fund and ETF positions in your account, including symbol, quantity, and cost information. + +## Requirements + +OAuth account permission required. See the [account permission setup](/docs/trade/) guide. diff --git a/docs/en/docs/cli/account/portfolio.md b/docs/en/docs/cli/account/portfolio.md new file mode 100644 index 00000000..4afe5ad6 --- /dev/null +++ b/docs/en/docs/cli/account/portfolio.md @@ -0,0 +1,50 @@ +--- +title: 'portfolio' +sidebar_label: 'portfolio' +sidebar_position: 1 +--- + +# longbridge portfolio + +Get a full portfolio overview — total P/L, total assets, market value by market (US/HK/CN/SG), and cash balances. + +## Basic Usage + +```bash +longbridge portfolio +``` + +``` +| Field | Value | +|-------------------|-----------| +| Currency | USD | +| Total Asset | 125422.43 | +| Market Cap | 66783.59 | +| Total Cash | 58638.84 | +| P/L | 140473.44 | +| Intraday P/L | 14637.05 | +| Margin Call | 0 | +| Risk Level | Safe | +| Credit Limit | 410651.27 | + +| Market | Value (USD) | % | +|--------|-------------|---------| +| US | 58659.65 | 46.76% | +| HK | 493265.25 | 393.28% | +| Cash | 58638.84 | 46.75% | +``` + +## Examples + +### View portfolio summary + +```bash +longbridge portfolio +longbridge portfolio --format json +``` + +Displays total asset value, total and today's P/L, and a breakdown of market value per market. + +## Requirements + +OAuth account permission required. See the [account permission setup](/docs/trade/) guide. diff --git a/docs/en/docs/cli/account/positions.md b/docs/en/docs/cli/account/positions.md new file mode 100644 index 00000000..be134f2c --- /dev/null +++ b/docs/en/docs/cli/account/positions.md @@ -0,0 +1,39 @@ +--- +title: 'positions' +sidebar_label: 'positions' +sidebar_position: 2 +--- + +# longbridge positions + +List your current stock positions — symbol, quantity, available quantity, cost price, and market. + +## Basic Usage + +```bash +longbridge positions +``` + +``` +| Symbol | Name | Quantity | Available | Cost Price | Currency | Market | +|---------|-----------|----------|-----------|------------|----------|--------| +| NVDA.US | NVIDIA | 101 | 101 | 50.229 | USD | US | +| MSFT.US | Microsoft | 15 | 15 | 373.310 | USD | US | +| AAPL.US | Apple | 133 | 133 | 211.589 | USD | US | +| 9988.HK | BABA-W | 500 | 500 | 95.640 | HKD | HK | +``` + +## Examples + +### View all positions + +```bash +longbridge positions +longbridge positions --format json +``` + +Displays every open stock position with its name, symbol, quantity, available quantity for trading, cost price, and market. + +## Requirements + +OAuth account permission required. See the [account permission setup](/docs/trade/) guide. diff --git a/docs/en/docs/cli/content/_category_.json b/docs/en/docs/cli/content/_category_.json new file mode 100644 index 00000000..85ff021e --- /dev/null +++ b/docs/en/docs/cli/content/_category_.json @@ -0,0 +1 @@ +{ "label": "Content", "icon": "newspaper", "position": 10, "collapsed": true } diff --git a/docs/en/docs/cli/content/filing.md b/docs/en/docs/cli/content/filing.md new file mode 100644 index 00000000..48a3e583 --- /dev/null +++ b/docs/en/docs/cli/content/filing.md @@ -0,0 +1,45 @@ +--- +title: 'filing' +sidebar_label: 'filing' +sidebar_position: 2 +--- + +# longbridge filing + +Browse regulatory filings and disclosure documents for a symbol. For US-listed stocks, this includes [SEC EDGAR](https://www.sec.gov/cgi-bin/browse-edgar) filings such as [Form 4](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40) insider transactions, [8-K](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=8-K&dateb=&owner=include&count=40) current reports, and [10-K](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=10-K&dateb=&owner=include&count=40) annual reports. HK-listed stocks return exchange disclosure filings from the [Hong Kong Stock Exchange](https://www.hkexnews.hk/). + +## Basic Usage + +```bash +longbridge filing TSLA.US +``` + +``` +| id | title | file_name | files | publish_at | +|--------------------|---------------------------------------|----------------------------|-------|----------------------| +| 633214836329945345 | Tesla | 4 - Tesla, Inc. (Issuer) | 4 - Tesla, Inc. (Issuer) | 1 | 2026-04-03T00:08:52Z | +| 633048285147044097 | Tesla | 8-K - Tesla, Inc. (Filer) | 8-K - Tesla, Inc. (Filer) | 2 | 2026-04-02T13:07:13Z | +| 632835137097963777 | Tesla | 4 - Tesla, Inc. (Issuer) | 4 - Tesla, Inc. (Issuer) | 1 | 2026-04-01T23:00:13Z | +... +``` + +## Examples + +### View recent filings + +```bash +longbridge filing TSLA.US +# Output as JSON for scripting +longbridge filing TSLA.US --format json +``` + +Lists the most recent filings for the symbol with titles, form types, and publication dates. The `file_urls` field in JSON output contains direct download links to the filing documents. + +### Read a full filing + +```bash +# Use the id from the filing list to read the full document +longbridge filing detail 633214836329945345 +``` + +Returns the full text content of the filing. Useful for extracting specific disclosures or feeding to an AI model for analysis. diff --git a/docs/en/docs/cli/content/news.md b/docs/en/docs/cli/content/news.md new file mode 100644 index 00000000..a478e3a8 --- /dev/null +++ b/docs/en/docs/cli/content/news.md @@ -0,0 +1,47 @@ +--- +title: 'news' +sidebar_label: 'news' +sidebar_position: 1 +--- + +# longbridge news + +Get latest news articles for a symbol, or fetch the full content of an article by ID. + +## Basic Usage + +```bash +longbridge news TSLA.US +``` + +``` +| id | title | published_at | likes | comments | +|-----------|---------------------------------------------------------|----------------------|-------|----------| +| 282284711 | Wall Street Backs Tesla? Cathie Wood Spends Nearly $28… | 2026-04-10T03:48:22Z | 0 | 0 | +| 282276051 | In response to market rumors that "Tesla is developing… | 2026-04-10T02:16:27Z | 0 | 0 | +| 282265091 | SpaceX posted nearly $5 billion loss in 2025 | 2026-04-10T00:31:27Z | 0 | 0 | +| 282247843 | Down More Than 30% from All-Time Highs, Should You Buy… | 2026-04-09T20:46:26Z | 0 | 0 | +... +``` + +## Examples + +### Latest news for a stock + +```bash +longbridge news TSLA.US +# Get more articles +longbridge news NVDA.US --count 5 +# Output as JSON for scripting +longbridge news TSLA.US --format json +``` + +Lists the most recent news articles for the symbol with titles, publication times, and URLs. + +### Get full article content + +```bash +longbridge news detail 282276051 +``` + +Fetches the full Markdown content of a single article by its ID. Article IDs are available in the `id` field of the list output. diff --git a/docs/en/docs/cli/content/topic.md b/docs/en/docs/cli/content/topic.md new file mode 100644 index 00000000..1ad871a5 --- /dev/null +++ b/docs/en/docs/cli/content/topic.md @@ -0,0 +1,67 @@ +--- +title: 'topic' +sidebar_label: 'topic' +sidebar_position: 3 +--- + +# longbridge topic + +Fetch community discussion topics related to a symbol from the Longbridge platform. + +## Basic Usage + +```bash +longbridge topic TSLA.US +``` + +``` +| id | title | published_at | likes | comments | shares | +|----------|-------------------------------------------------|----------------------|-------|----------|--------| +| 39798312 | AI's Hard Limit: Compute Boom Meets a Power Cr… | 2026-04-09T11:32:03Z | 41 | 7 | 97 | +| 39816927 | Tesla is weirdly terrible. Other stocks are up… | 2026-04-09T19:54:50Z | 6 | 4 | 0 | +| 39822930 | What does everyone think about current Tesla? | 2026-04-10T04:43:49Z | 0 | 0 | 0 | +... +``` + +## Examples + +### View community discussions + +```bash +longbridge topic TSLA.US +# View discussions for another symbol +longbridge topic NVDA.US +``` + +Lists community posts and discussions related to the symbol, including titles, descriptions, and engagement metrics. + +### Read the full content of a post + +```bash +longbridge topic detail 39798312 +``` + +``` +ID: 39798312 +Type: article +Title: AI's Hard Limit: Compute Boom Meets a Power Crunch; Gas Turbines the Hidden Boss? +Tickers: ST/US/TSLA, ST/US/NVDA, ST/US/GOOG +Stats: 42 likes 7 comments 0 views +Created: 2026-04-09T11:32:03Z +URL: https://longbridge.cn/topics/39798312 + +In the prior piece on AI infrastructure, Dolphin Research argued that +the U.S. power shortfall is not a cyclical mismatch but a structural conflict +between surging AI compute and long-lagging energy and grid build-out... +``` + +Use the `id` from the topic list to fetch the full body text of any post. + +### Find high-engagement posts + +```bash +# Filter posts with significant likes using jq +longbridge topic TSLA.US --format json | jq '[.[] | select(.likes_count > 10)]' +``` + +Combines with `jq` to surface the most-discussed posts. Useful for gauging retail sentiment spikes around earnings or news events. diff --git a/docs/en/docs/cli/derivatives/_category_.json b/docs/en/docs/cli/derivatives/_category_.json new file mode 100644 index 00000000..d7e6a639 --- /dev/null +++ b/docs/en/docs/cli/derivatives/_category_.json @@ -0,0 +1 @@ +{ "label": "Derivatives", "icon": "layers", "position": 4, "collapsed": true } diff --git a/docs/en/docs/cli/derivatives/option.md b/docs/en/docs/cli/derivatives/option.md new file mode 100644 index 00000000..6318baaa --- /dev/null +++ b/docs/en/docs/cli/derivatives/option.md @@ -0,0 +1,81 @@ +--- +title: 'option' +sidebar_label: 'option' +sidebar_position: 1 +--- + +# longbridge option + +Look up real-time quotes for US option contracts and browse the full option chain for any underlying symbol. + +## Basic Usage + +```bash +longbridge option chain AAPL.US +``` + +``` +| Strike | Call Symbol | Put Symbol | Standard | +|--------|----------------------|----------------------|----------| +| 180 | AAPL260406C180000.US | AAPL260406P180000.US | true | +| 185 | AAPL260406C185000.US | AAPL260406P185000.US | true | +| 190 | AAPL260406C190000.US | AAPL260406P190000.US | true | +| 195 | AAPL260406C195000.US | AAPL260406P195000.US | true | +| 200 | AAPL260406C200000.US | AAPL260406P200000.US | true | +... +``` + +## Examples + +### Browse the option chain for a stock + +Without `--date`, this returns all available expiry dates for AAPL options. Pick an expiry date, then pass it with `--date` to see the strikes. + +### View strikes for a specific expiry + +```bash +longbridge option chain AAPL.US --date 2026-04-17 --format json +``` + +```json +[ + { "call_symbol": "AAPL260417C110000.US", "put_symbol": "AAPL260417P110000.US", "standard": "true", "strike": "110" }, + { "call_symbol": "AAPL260417C115000.US", "put_symbol": "AAPL260417P115000.US", "standard": "true", "strike": "115" }, + { "call_symbol": "AAPL260417C120000.US", "put_symbol": "AAPL260417P120000.US", "standard": "true", "strike": "120" } +] +``` + +Each row shows the call and put symbols for that strike. Copy a symbol from `call_symbol` or `put_symbol` to get a live quote. + +### Get a real-time quote for an option contract + +```bash +longbridge option quote AAPL260417C190000.US --format json +``` + +```json +[ + { + "symbol": "AAPL260417C190000.US", + "last": "12.35", + "bid": "12.30", + "ask": "12.40", + "open_interest": "4821", + "implied_volatility": "0.2341", + "delta": "0.4812", + "gamma": "0.0231", + "theta": "-0.0512", + "vega": "0.1843" + } +] +``` + +Returns the latest bid, ask, last price, implied volatility, and greeks (delta, gamma, theta, vega) for the given contract. + +## Requirements + +`option quote` requires an options account and options market data permission. `option chain` works with Level 1 quote access. See [Quote Permissions](/docs/quote/) for subscription details. + +## Notes + +Option symbol format: `AAPL260417C190000.US` — underlying AAPL, expiry 2026-04-17, Call, $190.00 strike. The numeric price component is in units of $0.001, so 190000 = $190.00. diff --git a/docs/en/docs/cli/derivatives/warrant.md b/docs/en/docs/cli/derivatives/warrant.md new file mode 100644 index 00000000..37f4fa2c --- /dev/null +++ b/docs/en/docs/cli/derivatives/warrant.md @@ -0,0 +1,106 @@ +--- +title: 'warrant' +sidebar_label: 'warrant' +sidebar_position: 2 +--- + +# longbridge warrant + +Browse HK warrants — list all warrants on an underlying, get real-time quotes for individual warrant contracts, or look up issuer information. + +## Basic Usage + +```bash +longbridge warrant 700.HK +``` + +``` +| Symbol | Name | Last | Leverage Ratio | Expiry | Type | +|----------|-----------------|------|----------------|------------|------| +| 24760.HK | UBTENCT@EP2606B | 0.66 | 7.65 | 2026-06-30 | Call | +| 25228.HK | GJTENCT@EP2606B | 0.65 | 7.77 | 2026-06-30 | Call | +| 24687.HK | JPTENCT@EP2606A | 0.65 | 7.77 | 2026-06-30 | Call | +| 24880.HK | CITENCT@EP2606B | 0.64 | 7.89 | 2026-06-30 | Call | +... +``` + +## Examples + +### List all warrants on a stock + +```bash +longbridge warrant 700.HK --format json +``` + +```json +[ + { + "expiry": "2026-06-30", + "last": "0.65", + "leverage_ratio": "7.7846153846153845", + "name": "UBTENCT@EP2606B", + "symbol": "24760.HK", + "type": "Put" + }, + { + "expiry": "2026-06-30", + "last": "0.65", + "leverage_ratio": "7.7846153846153845", + "name": "JPTENCT@EP2606A", + "symbol": "24687.HK", + "type": "Put" + }, + { + "expiry": "2026-06-30", + "last": "0.64", + "leverage_ratio": "7.90625", + "name": "GJTENCT@EP2606B", + "symbol": "25228.HK", + "type": "Put" + } +] +``` + +Returns all listed warrants for the underlying, including type (Call/Put), last price, leverage ratio, and expiry date. Use the `symbol` field to get a detailed quote. + +### Get a quote for one warrant + +```bash +longbridge warrant quote 24760.HK --format json +``` + +```json +[ + { + "expiry": "2026-06-30", + "implied_vol": "0.344", + "last": "0.650", + "prev_close": "0.640", + "symbol": "24760.HK", + "type": "Put" + } +] +``` + +Returns the real-time quote including implied volatility alongside the last and previous close prices. + +### Look up warrant issuers + +```bash +longbridge warrant issuers --format json +``` + +```json +[ + { "id": "1", "name_cn": "瑞信", "name_en": "CS" }, + { "id": "3", "name_cn": "摩通", "name_en": "JP" }, + { "id": "4", "name_cn": "麦银", "name_en": "MB" }, + { "id": "8", "name_cn": "法兴", "name_en": "SG" } +] +``` + +Lists all active warrant issuers in the HK market with their IDs and names. + +## Requirements + +Warrant market data permission is required. Warrant data covers the HK market only. See [Quote Subscriptions](/docs/quote/) for permission details. diff --git a/docs/en/docs/cli/fundamentals/_category_.json b/docs/en/docs/cli/fundamentals/_category_.json new file mode 100644 index 00000000..3ae1ae4c --- /dev/null +++ b/docs/en/docs/cli/fundamentals/_category_.json @@ -0,0 +1 @@ +{ "label": "Fundamentals", "icon": "book-open", "position": 5, "collapsed": true } diff --git a/docs/en/docs/cli/fundamentals/consensus.md b/docs/en/docs/cli/fundamentals/consensus.md new file mode 100644 index 00000000..34b3db26 --- /dev/null +++ b/docs/en/docs/cli/fundamentals/consensus.md @@ -0,0 +1,58 @@ +--- +title: 'consensus' +sidebar_label: 'consensus' +sidebar_position: 5 +--- + +# longbridge consensus + +See Wall Street's consensus financial estimates — revenue, EBIT, and EPS — for upcoming earnings periods. + +## Basic Usage + +```bash +longbridge consensus TSLA.US +``` + +``` +Currency: USD | Period: qf +| metric | Q3 2026 | Q2 2026 | Q1 2026 | Q4 2025 | Q3 2025 | +|---------------|---------|---------|----------|-----------|----------| +| Revenue | ~27.14B | ~24.71B | ~22.75B | 24.90B ↑ | 28.09B ↑ | +| Net Income | ~1.28B | ~1.08B | ~879.54M | 840.00M ↓ | 1.37B ↓ | +| EPS | ~0.3818 | ~0.2969 | ~0.2390 | 0.2400 ↓ | 0.3900 ↓ | +... +``` + +## Examples + +### Check consensus estimates + +```bash +longbridge consensus TSLA.US +``` + +Displays the analyst consensus estimates for the upcoming reporting period, covering key metrics like revenue, EBIT, and EPS. + +### JSON output + +```bash +longbridge consensus TSLA.US --format json +``` + +```json +{ + "currency": "USD", + "current_period": "qf", + "list": [ + { + "details": [ + { "key": "revenue", "name": "Revenue", "estimate": "27144782630.0000", "is_released": false }, + { "key": "ebit", "name": "EBIT", "estimate": "1496709370.0000", "is_released": false } + ] + } + ] +} +``` + +Each `details` entry includes the metric key, the consensus estimate value, and whether the actual result has already been released. `current_index` in the full response indicates which period in the list is the current one. diff --git a/docs/en/docs/cli/fundamentals/dividend.md b/docs/en/docs/cli/fundamentals/dividend.md new file mode 100644 index 00000000..921a15bc --- /dev/null +++ b/docs/en/docs/cli/fundamentals/dividend.md @@ -0,0 +1,68 @@ +--- +title: 'dividend' +sidebar_label: 'dividend' +sidebar_position: 3 +--- + +# longbridge dividend + +View the historical dividend payment history for a stock. + +## Basic Usage + +```bash +longbridge dividend 700.HK +``` + +``` +| desc | ex_date | payment_date | record_date | +|--------------------------------------|------------|--------------|-------------| +| Dividend: HKD 5.3/share | 2026.05.15 | 2026.06.01 | 2026.05.18 | +| Dividend: HKD 4.5/share | 2025.05.16 | 2025.05.30 | 2025.05.19 | +| Dividend: HKD 3.4/share | 2024.05.17 | 2024.05.31 | 2024.05.20 | +| Dividend: HKD 2.4/share | 2023.05.19 | 2023.06.05 | 2023.05.22 | +``` + +## Examples + +### View dividend history + +```bash +longbridge dividend AAPL.US +``` + +Lists all historical dividend payments for Apple, including payment dates, amounts per share, and dividend type. + +### HK dividend example + +```bash +longbridge dividend 700.HK +``` + +Works the same for Hong Kong-listed stocks. Tencent pays dividends periodically and this shows the full payment history. + +### Find the next ex-dividend date + +```bash +# The ex_date field shows the ex-dividend date for each record +longbridge dividend AAPL.US +``` + +The most recent record shows the last known ex-dividend date. For upcoming dividends not yet announced, check `finance-calendar` with the `dividend` type. + +### View dividend distribution scheme details + +```bash +# Show detailed dividend distribution scheme (lot size, currency, ratio) +longbridge dividend detail AAPL.US +``` + +The `detail` subcommand shows the full distribution scheme — useful when a dividend includes bonus shares or rights alongside cash. + +### JSON for automation + +```bash +longbridge dividend AAPL.US --format json +``` + +Returns structured JSON with `ex_date`, `payment_date`, `record_date`, and a `desc` field containing the dividend amount description (e.g., `"Dividend: USD 0.26/share"`) — suitable for piping into scripts or tracking tools. diff --git a/docs/en/docs/cli/fundamentals/finance-calendar.md b/docs/en/docs/cli/fundamentals/finance-calendar.md new file mode 100644 index 00000000..1766db83 --- /dev/null +++ b/docs/en/docs/cli/fundamentals/finance-calendar.md @@ -0,0 +1,55 @@ +--- +title: 'finance-calendar' +sidebar_label: 'finance-calendar' +sidebar_position: 6 +--- + +# longbridge finance-calendar + +Browse upcoming financial events — earnings reports, dividend payments, IPOs, and macroeconomic releases — filtered by symbol, market, or event type. + +## Basic Usage + +```bash +longbridge finance-calendar financial --symbol TSLA.US +``` + +``` +2026.01.28 (ET) [Financials] US Tesla (TSLA.US) + Q4 FY2025 Earnings Release + EPS: Est 0.3466 / Act 0.24 | Revenue: Est $24.8B / Act $24.9B +``` + +## Examples + +### Upcoming earnings for a stock + +```bash +longbridge finance-calendar financial --symbol TSLA.US +``` + +Shows Tesla's upcoming earnings dates along with analyst estimates for EPS and revenue. Use `--symbol` to narrow down to a specific stock. + +### Today's dividend events for the US market + +```bash +longbridge finance-calendar dividend --market US +``` + +Lists all dividend-related events (ex-dividend dates, payment dates) scheduled for US-listed stocks. Useful for tracking which stocks are going ex-dividend. + +### High-importance macro events + +```bash +longbridge finance-calendar macrodata --star 3 +``` + +Filters macroeconomic events to only show high-importance releases (3-star). Covers data like CPI, NFP, Fed rate decisions, and similar market-moving events. + +### IPO calendar + +```bash +longbridge finance-calendar ipo +``` + +Shows upcoming IPOs across supported markets. Combine with `--market` to filter by a specific exchange. diff --git a/docs/en/docs/cli/fundamentals/financial-report.md b/docs/en/docs/cli/fundamentals/financial-report.md new file mode 100644 index 00000000..34011d34 --- /dev/null +++ b/docs/en/docs/cli/fundamentals/financial-report.md @@ -0,0 +1,61 @@ +--- +title: 'financial-report' +sidebar_label: 'financial-report' +sidebar_position: 1 +--- + +# longbridge financial-report + +Fetch income statements, balance sheets, and cash flow statements for any public company. + +## Basic Usage + +```bash +longbridge financial-report TSLA.US --kind IS +``` + +``` +── IS ── +| metric | Q4 2025 | Q3 2025 | Q2 2025 | Q1 2025 | Q4 2024 | +|---------------------|---------|---------|---------|---------|---------| +| EPS (USD) | 0.2404 | 0.3900 | 0.3300 | 0.1200 | 0.6104 | +| ROE | 4.15% | 6.98% | 6.17% | 2.22% | 11.90% | +| Revenue (USD) | 24.90B | 28.09B | 22.50B | 19.34B | 25.71B | +| Net Income (USD) | 840.00M | 1.37B | 1.17B | 409.00M | 2.12B | +| Gross Margin | 20.12% | 17.99% | 17.24% | 16.31% | 16.26% | +| Net Margin | 3.37% | 4.89% | 5.21% | 2.12% | 8.28% | +``` + +## Examples + +### Get the latest income statement + +```bash +longbridge financial-report TSLA.US --kind IS +``` + +Returns the income statement for the most recent reporting period, including EPS, revenue, and other earnings line items. + +### Get all three statements + +```bash +longbridge financial-report TSLA.US +``` + +Fetches the income statement, balance sheet, and cash flow statement together. Equivalent to `--kind ALL`. + +### Get the cash flow statement + +```bash +longbridge financial-report TSLA.US --kind CF +``` + +Returns the cash flow statement, covering operating, investing, and financing activities. + +### Annual balance sheet + +```bash +longbridge financial-report 700.HK --kind BS --report af +``` + +Retrieves the annual balance sheet for Tencent. Use `--report` to choose the reporting period: `af` (annual), `saf` (semi-annual), `q1`, `3q`, or `qf` (quarterly). diff --git a/docs/en/docs/cli/fundamentals/forecast-eps.md b/docs/en/docs/cli/fundamentals/forecast-eps.md new file mode 100644 index 00000000..a16af81a --- /dev/null +++ b/docs/en/docs/cli/fundamentals/forecast-eps.md @@ -0,0 +1,60 @@ +--- +title: 'forecast-eps' +sidebar_label: 'forecast-eps' +sidebar_position: 4 +--- + +# longbridge forecast-eps + +Get analyst consensus EPS forecasts for upcoming reporting periods — mean, median, highest, and lowest estimates. + +## Basic Usage + +```bash +longbridge forecast-eps TSLA.US +``` + +``` +EPS Forecasts (recent 19): +| end_date | mean | median | highest | lowest | up | down | total | +|------------|-------|--------|---------|--------|----|------|-------| +| 2026-02-03 | 2.092 | 2.04 | 2.75 | 1.212 | 0 | 0 | 0 | +| 2026-02-04 | 2.092 | 2.04 | 2.75 | 1.212 | 0 | 0 | 0 | +| 2026-02-08 | 2.057 | 2.035 | 2.75 | 1.212 | 0 | 0 | 0 | +... +``` + +## Examples + +### Check EPS forecast + +```bash +longbridge forecast-eps TSLA.US +``` + +Displays the analyst consensus EPS forecast for each upcoming period, along with the range of estimates (highest and lowest). + +### JSON for tracking estimates + +```bash +longbridge forecast-eps TSLA.US --format json +``` + +```json +{ + "items": [ + { + "forecast_end_date": "1726790400", + "forecast_eps_highest": "3.79", + "forecast_eps_lowest": "2.37", + "forecast_eps_mean": "3.043", + "forecast_eps_median": "3.02", + "institution_down": 0, + "institution_total": 0, + "institution_up": 0 + } + ] +} +``` + +Each item covers one reporting period. `forecast_eps_mean` and `forecast_eps_median` represent the consensus, while `highest` and `lowest` show the range of analyst estimates. diff --git a/docs/en/docs/cli/fundamentals/institution-rating.md b/docs/en/docs/cli/fundamentals/institution-rating.md new file mode 100644 index 00000000..e3a0efea --- /dev/null +++ b/docs/en/docs/cli/fundamentals/institution-rating.md @@ -0,0 +1,80 @@ +--- +title: 'institution-rating' +sidebar_label: 'institution-rating' +sidebar_position: 2 +--- + +# longbridge institution-rating + +See the consensus from Wall Street analysts — buy/hold/sell distribution, price target range, and industry rankings. + +## Basic Usage + +```bash +longbridge institution-rating TSLA.US +``` + +``` +Consensus: +| recommend | target | change | updated_at | +|-----------|--------|--------|-------------| +| buy | 415.78 | 20.30% | 2026-04-09 | + +Rating breakdown: +| strong_buy | buy | hold | sell | under | no_opinion | total | +|------------|-----|------|------|-------|------------|-------| +| 18 | 5 | 17 | 6 | 2 | 4 | 52 | + +Target price range: +| lowest_price | highest_price | prev_close | +|--------------|---------------|------------| +| 125.000 | 600.000 | 345.62 | +``` + +## Examples + +### Check analyst consensus + +```bash +longbridge institution-rating TSLA.US +``` + +Shows the breakdown of analyst ratings (Buy, Hold, Sell, and variants), the consensus price target range, and industry peer ranking. + +### View historical rating changes over time + +```bash +# Show week-by-week rating count history and individual analyst target prices +longbridge institution-rating detail TSLA.US +``` + +The `detail` subcommand lists the historical rating distribution by week and individual analyst price targets, so you can track how sentiment has shifted over time. + +### JSON for monitoring + +```bash +longbridge institution-rating TSLA.US --format json +``` + +```json +{ + "analyst": { + "evaluate": { + "buy": 18, + "hold": 17, + "no_opinion": 4, + "over": 5, + "sell": 6, + "under": 2, + "total": 52 + }, + "target": { + "highest_price": "600.000", + "lowest_price": "125.000", + "prev_close": "345.62" + } + } +} +``` + +The `evaluate` object contains the per-rating counts across all 52 covering analysts. The `target` object shows the highest and lowest price targets alongside the previous close for context. diff --git a/docs/en/docs/cli/fundamentals/valuation.md b/docs/en/docs/cli/fundamentals/valuation.md new file mode 100644 index 00000000..d61ca9a0 --- /dev/null +++ b/docs/en/docs/cli/fundamentals/valuation.md @@ -0,0 +1,79 @@ +--- +title: 'valuation' +sidebar_label: 'valuation' +sidebar_position: 7 +--- + +# longbridge valuation + +Analyze a stock's current valuation (P/E, P/B, P/S, dividend yield) with 5-year historical context and industry peer comparison, or track how valuation has changed over time. + +## Basic Usage + +```bash +longbridge valuation TSLA.US --indicator pe +``` + +``` +Overview: +| indicator | current | high | low | median | industry_median | date | +|-----------|---------|--------|-------|--------|-----------------|------------| +| PE | 341.83x | 284.01 | 51.31 | 96.85 | -0.11 | 2026-04-09 | +Current P/E 341.83, above fair range, cheaper than 8.85% of last 5 years, industry rank 19/49 + +Peers (5): +| name | pe | +|-------|--------| +| TSLA | 341.83 | +... +``` + +## Examples + +### Current valuation snapshot + +```bash +longbridge valuation TSLA.US +``` + +Shows current P/E, P/B, P/S, and dividend yield alongside the 5-year historical range and where the current value sits within that range. Includes industry peer rank. + +### Historical P/E chart + +```bash +longbridge valuation TSLA.US --history --indicator pe --range 5 +``` + +Returns a 5-year time series of Tesla's P/E ratio. Use `--range` to set the lookback window: `1`, `3`, `5`, or `10` years. + +### Compare P/B over time + +```bash +longbridge valuation 700.HK --history --indicator pb +``` + +Tracks Tencent's price-to-book ratio over time. Supported indicators for `--history` mode: `pe`, `pb`, `ps`, `dvd_yld`. + +### JSON for monitoring + +```bash +# Export historical P/B data as JSON for scripting or monitoring pipelines +longbridge valuation TSLA.US --history --indicator pb --format json +``` + +```json +{ + "metrics": { + "pb": { + "desc": "current P/B 15.79, in reasonable range, cheaper than 50.31% of last 5 years, industry rank 35/49", + "high": "24.35", + "list": [ + { "timestamp": "1619841600", "value": "26.87" }, + { "timestamp": "1622520000", "value": "24.53" } + ] + } + } +} +``` + +The `desc` field provides a human-readable summary of how the current valuation compares to historical range and industry peers. The `list` array contains the time series data points. diff --git a/docs/en/docs/cli/index.md b/docs/en/docs/cli/index.md new file mode 100644 index 00000000..fd5c4fab --- /dev/null +++ b/docs/en/docs/cli/index.md @@ -0,0 +1,52 @@ +--- +title: 'Longbridge CLI' +sidebar_label: 'Overview' +sidebar_position: 1 +sidebar_icon: terminal +--- + +# Longbridge CLI + +Longbridge CLI (`longbridge`) is an AI-native command-line tool covering every Longbridge OpenAPI +endpoint — real-time market data, fundamentals, account management, and trading. Designed for +scripting, AI-agent tool-calling, and daily workflows from the terminal. + +**GitHub:** [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal) + +## Quick Start + +See [Installation](/docs/cli/installation) for platform-specific install instructions and authentication setup. After installing, try any command: + +```bash +# Check real-time price +longbridge quote TSLA.US NVDA.US + +# View your portfolio +longbridge portfolio + +# Get JSON output for scripting or AI agents +longbridge quote AAPL.US --format json +``` + +## JSON Output + +Every command supports `--format json` for machine-readable output. Use it for scripting, +piping into `jq`, or feeding data to AI agents: + +```bash +longbridge positions --format json +longbridge quote TSLA.US NVDA.US --format json +``` + +## Symbol Format + +Symbols use `CODE.MARKET` format: + +| Example | Market | +| ------------ | ---------------------------- | +| `TSLA.US` | US stocks | +| `700.HK` | Hong Kong | +| `600519.SH` | China A-share (Shanghai) | +| `000568.SZ` | China A-share (Shenzhen) | +| `D05.SG` | Singapore | +| `BTCUSD.HAS` | Crypto (Longbridge-specific) | diff --git a/docs/en/docs/cli/installation.md b/docs/en/docs/cli/installation.md new file mode 100644 index 00000000..b8b3465d --- /dev/null +++ b/docs/en/docs/cli/installation.md @@ -0,0 +1,85 @@ +--- +title: 'Installation' +sidebar_label: 'Installation' +sidebar_position: 2 +sidebar_icon: cpu +--- + +# Installation + +Install the CLI and authenticate with your Longbridge account. + +Source code and release binaries: [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal){target="_blank"} + +## Install + + + + +```bash +brew install --cask longbridge/tap/longbridge-terminal +``` + + + + +```bash +curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh +``` + + + + +```powershell +scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json +``` + + + + +```powershell +iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex +``` + + + + +## login + +Authenticate via OAuth 2.0 device authorization flow — works in any environment including SSH +and headless servers. + +```bash +longbridge login +``` + +Running `login` prints a URL and a short code. Open the URL in any browser, enter the code, +and authorize. The token is saved to `~/.longbridge/openapi/tokens/` and reused +automatically by all subsequent commands. + +## check + +Verifies token validity and API connectivity. Shows token status, cached region, and latency +to both Global and CN API endpoints. Does not require an active market session. + +```bash +longbridge check +longbridge check --format json +``` + +## update + +Downloads and runs the official install script to replace the current binary with the latest +release. + +```bash +longbridge update +``` + +## logout + +Clears the stored OAuth token. The next command or TUI launch will trigger re-authentication. + +```bash +longbridge logout +``` diff --git a/docs/en/docs/cli/market-data/_category_.json b/docs/en/docs/cli/market-data/_category_.json new file mode 100644 index 00000000..568bd37c --- /dev/null +++ b/docs/en/docs/cli/market-data/_category_.json @@ -0,0 +1 @@ +{ "label": "Market Data", "icon": "bar-chart-2", "position": 3, "collapsed": false } diff --git a/docs/en/docs/cli/market-data/brokers.md b/docs/en/docs/cli/market-data/brokers.md new file mode 100644 index 00000000..b74a683f --- /dev/null +++ b/docs/en/docs/cli/market-data/brokers.md @@ -0,0 +1,52 @@ +--- +title: 'brokers' +sidebar_label: 'brokers' +sidebar_position: 3 +--- + +# longbridge brokers + +See which broker IDs are present at each price level in the HK order book. Useful for identifying institutional order flow. + +## Basic Usage + +```bash +longbridge brokers 700.HK +``` + +``` +Symbol: 700.HK + +Ask Brokers: +| Position | Broker IDs | +|----------|---------------| +| 1 | 3014, 6409 | +| 2 | 7707, 724 | +| 3 | 1142 | + +Bid Brokers: +| Position | Broker IDs | +|----------|---------------| +| 1 | 5428, 3423 | +| 2 | 3506, 3507 | +| 3 | 4482, 4483 | +``` + +## Examples + +### View broker distribution + +```bash +longbridge brokers 700.HK +longbridge brokers 700.HK --format json +``` + +Displays each price level in the HK order book along with the broker IDs placing orders at that level. + +## Requirements + +Level 2 quote subscription required. HK market only. See [Quote Subscriptions](/docs/quote/) for subscription options. + +## Notes + +Use `longbridge participants` to look up broker names by ID. Broker IDs in the `brokers` output map directly to the `broker_id` field in the participants list. diff --git a/docs/en/docs/cli/market-data/calc-index.md b/docs/en/docs/cli/market-data/calc-index.md new file mode 100644 index 00000000..e1fcd32c --- /dev/null +++ b/docs/en/docs/cli/market-data/calc-index.md @@ -0,0 +1,54 @@ +--- +title: 'calc-index' +sidebar_label: 'calc-index' +sidebar_position: 8 +--- + +# longbridge calc-index + +Compute financial indexes for any symbol — P/E, P/B, dividend yield, turnover rate, options greeks, and more. + +## Basic Usage + +```bash +longbridge calc-index TSLA.US +``` + +``` +| Symbol | PE TTM | PB | DPS Rate | Turnover Rate | Total Market Value | +|---------|--------|-------|----------|---------------|---------------------| +| TSLA.US | 341.83 | 15.79 | - | 2.21 | 1296915542310.08 | +``` + +## Examples + +### Check P/E and P/B ratios + +```bash +longbridge calc-index TSLA.US NVDA.US --index pe pb +longbridge calc-index TSLA.US NVDA.US --index pe pb --format json +``` + +Calculates the specified indexes for each symbol. Multiple symbols and multiple indexes can be requested in a single call. Only indexes that have data appear in the JSON output — indexes with no value are omitted. + +### Default indexes (PE, PB, dividend yield, turnover rate, market cap) + +```bash +longbridge calc-index TSLA.US +``` + +When `--index` is omitted, the default set is returned: `pe`, `pb`, `dps_rate`, `turnover_rate`, `total_market_value`. + +### Options greeks for a derivative + +```bash +longbridge calc-index 24760.HK --index delta gamma vega theta +``` + +For options and warrants, request greeks directly. Only indexes applicable to the instrument type will appear in the output. Greek values are only meaningful for option/warrant symbols — passing a plain stock symbol returns no greek data. + +## Notes + +Full list of supported index names: `last_done`, `change_value`, `change_rate`, `volume`, `turnover`, `ytd_change_rate`, `turnover_rate`, `total_market_value`, `capital_flow`, `amplitude`, `volume_ratio`, `pe` (alias: `pe_ttm`), `pb`, `dps_rate` (alias: `dividend_yield`), `five_day_change_rate`, `ten_day_change_rate`, `half_year_change_rate`, `five_minutes_change_rate`, `implied_volatility`, `delta`, `gamma`, `theta`, `vega`, `rho`, `open_interest`, `expiry_date`, `strike_price`. + +Unknown index names are silently ignored — double-check spelling if an expected field is missing from the output. diff --git a/docs/en/docs/cli/market-data/capital.md b/docs/en/docs/cli/market-data/capital.md new file mode 100644 index 00000000..82cb2403 --- /dev/null +++ b/docs/en/docs/cli/market-data/capital.md @@ -0,0 +1,61 @@ +--- +title: 'capital' +sidebar_label: 'capital' +sidebar_position: 9 +--- + +# longbridge capital + +Track intraday capital flow — see where large, medium, and small money is moving minute by minute (`flow` subcommand) or as a snapshot distribution (`dist` subcommand). + +## Basic Usage + +```bash +longbridge capital flow TSLA.US +``` + +``` +| Time | Inflow | +|---------------------|----------| +| 2026-04-09 13:30:00 | 1100.46 | +| 2026-04-09 13:31:00 | 1129.09 | +| 2026-04-09 13:32:00 | 1711.27 | +| 2026-04-09 13:33:00 | 1955.54 | +| 2026-04-09 13:34:00 | 1609.27 | +... +``` + +## Examples + +### Track minute-by-minute large money inflow + +```bash +longbridge capital flow TSLA.US --format json +``` + +```json +[ + { "inflow": "1100.46", "time": "2026-04-09 13:30:00" }, + { "inflow": "1129.09", "time": "2026-04-09 13:31:00" }, + { "inflow": "1711.27", "time": "2026-04-09 13:32:00" } +] +``` + +Each bar shows net inflow for that minute. Positive values indicate net buying; negative values indicate net selling. + +### Snapshot: large/medium/small money distribution + +```bash +longbridge capital dist TSLA.US --format json +``` + +```json +{ + "capital_in": { "large": "30160.97", "medium": "131976.32", "small": "134017.99" }, + "capital_out": { "large": "21801.89", "medium": "132803.77", "small": "124441.20" }, + "symbol": "TSLA.US", + "timestamp": "2026-04-09 20:00:00" +} +``` + +`capital_in` shows total money flowing into the stock broken down by order size (large / medium / small). `capital_out` shows the corresponding outflows. Compare the two to assess whether large institutional money is net buying or selling. diff --git a/docs/en/docs/cli/market-data/depth.md b/docs/en/docs/cli/market-data/depth.md new file mode 100644 index 00000000..9bd45321 --- /dev/null +++ b/docs/en/docs/cli/market-data/depth.md @@ -0,0 +1,48 @@ +--- +title: 'depth' +sidebar_label: 'depth' +sidebar_position: 2 +--- + +# longbridge depth + +View the Level 2 order book for a symbol — the top 10 bid and ask prices with order counts and volumes. + +## Basic Usage + +```bash +longbridge depth TSLA.US +``` + +``` +Symbol: TSLA.US + +Asks (Sell): +| Position | Price | Volume | Orders | +|----------|---------|--------|--------| +| 1 | 344.990 | 200 | 3 | +| 2 | 345.000 | 500 | 8 | +| 3 | 345.010 | 300 | 4 | + +Bids (Buy): +| Position | Price | Volume | Orders | +|----------|---------|--------|--------| +| 1 | 344.980 | 400 | 6 | +| 2 | 344.970 | 600 | 9 | +| 3 | 344.960 | 250 | 3 | +``` + +## Examples + +### View the order book + +```bash +longbridge depth 700.HK +longbridge depth 700.HK --format json +``` + +Shows the current bid and ask ladder for 700.HK, including price levels, volume at each level, and order count. Up to 10 levels are returned per side when the market is open. + +## Requirements + +Level 2 quote subscription required. See [Quote Subscriptions](/docs/quote/) for subscription options. diff --git a/docs/en/docs/cli/market-data/intraday.md b/docs/en/docs/cli/market-data/intraday.md new file mode 100644 index 00000000..efb44581 --- /dev/null +++ b/docs/en/docs/cli/market-data/intraday.md @@ -0,0 +1,62 @@ +--- +title: 'intraday' +sidebar_label: 'intraday' +sidebar_position: 5 +--- + +# longbridge intraday + +Get today's minute-by-minute price and volume data (intraday line) for any symbol. + +## Basic Usage + +```bash +longbridge intraday TSLA.US +``` + +``` +| Time | Price | Avg Price | Volume | Turnover | +|---------------------|---------|-----------|---------|----------------| +| 2026-04-09 13:30:00 | 343.150 | 343.150 | 1234567 | 423567890.000 | +| 2026-04-09 13:31:00 | 344.200 | 343.675 | 987654 | 339876540.000 | +| 2026-04-09 13:32:00 | 343.800 | 343.717 | 876543 | 301234560.000 | +... +``` + +## Examples + +### View today's intraday price line + +```bash +longbridge intraday TSLA.US +longbridge intraday TSLA.US --format json +``` + +Outputs one bar per minute from market open to the latest available tick, showing price, average price, volume, and turnover. + +### Include pre-market and post-market for US stocks + +```bash +longbridge intraday AAPL.US --session all +``` + +```json +[ + { + "avg_price": "258.368439", + "price": "258.330", + "time": "2026-04-09 08:00:00", + "turnover": "97663.270", + "volume": "378" + }, + { + "avg_price": "258.382920", + "price": "258.240", + "time": "2026-04-09 08:01:00", + "turnover": "1622133.447", + "volume": "6278" + } +] +``` + +`--session all` includes pre-market bars starting from approximately 8:00 AM ET, as well as post-market bars after 4:00 PM ET. diff --git a/docs/en/docs/cli/market-data/kline.md b/docs/en/docs/cli/market-data/kline.md new file mode 100644 index 00000000..8df70e1d --- /dev/null +++ b/docs/en/docs/cli/market-data/kline.md @@ -0,0 +1,50 @@ +--- +title: 'kline' +sidebar_label: 'kline' +sidebar_position: 6 +--- + +# longbridge kline + +Fetch candlestick (K-line) data for any symbol. Supports multiple periods and historical date ranges. + +## Basic Usage + +```bash +longbridge kline TSLA.US --period day --count 3 +``` + +``` +| Time | Open | High | Low | Close | Volume | Turnover | +|---------------------|---------|---------|---------|---------|----------|-----------------| +| 2026-04-07 04:00:00 | 346.440 | 348.020 | 337.240 | 346.650 | 74515355 | 25563965746.000 | +| 2026-04-08 04:00:00 | 363.790 | 364.500 | 339.670 | 343.250 | 78838616 | 27457043487.000 | +| 2026-04-09 04:00:00 | 343.150 | 348.880 | 337.250 | 345.620 | 62164016 | 21375312140.000 | +``` + +## Examples + +### Daily candles (last 100 days, default) + +```bash +longbridge kline TSLA.US +``` + +Returns the last 100 daily candles by default, with open, high, low, close, volume, and turnover for each day. + +### Intraday candles with different period + +```bash +longbridge kline TSLA.US --period 1h --count 48 +``` + +Use `--period` to switch granularity (e.g. `1m`, `5m`, `15m`, `30m`, `1h`, `day`, `week`, `month`, `year`) and `--count` to control how many bars are returned. + +### Historical range + +```bash +longbridge kline TSLA.US --period day --start 2025-01-01 --end 2025-03-31 +longbridge kline TSLA.US --period day --start 2025-01-01 --end 2025-03-31 --format json +``` + +Fetch candles for a specific date window using `--start` and `--end` (format: `YYYY-MM-DD`). The `time` field in JSON output represents the candle open time — for US daily candles, this is US Eastern midnight expressed in UTC. diff --git a/docs/en/docs/cli/market-data/market-temp.md b/docs/en/docs/cli/market-data/market-temp.md new file mode 100644 index 00000000..c70fa066 --- /dev/null +++ b/docs/en/docs/cli/market-data/market-temp.md @@ -0,0 +1,58 @@ +--- +title: 'market-temp' +sidebar_label: 'market-temp' +sidebar_position: 10 +--- + +# longbridge market-temp + +Get the Longbridge market temperature index — a composite 0–100 sentiment gauge combining valuation and market sentiment. Higher = more bullish. + +## Basic Usage + +```bash +longbridge market-temp US +``` + +``` +| Field | Value | +|-------------|---------------------------------------| +| Market | US | +| Temperature | 64 | +| Description | Temp Comfortable & Gradually Dropping | +| Valuation | 83 | +| Sentiment | 45 | +``` + +## Examples + +### Current market temperature + +```bash +# Hong Kong market +longbridge market-temp HK +# US market +longbridge market-temp US +# China A-shares +longbridge market-temp CN +# JSON output for scripting or monitoring +longbridge market-temp US --format json +``` + +Supported markets: `HK` (default), `US`, `CN` (aliases: `SH`, `SZ`), `SG`. Running without an argument defaults to `HK`. + +### Historical temperature trend + +```bash +longbridge market-temp US --history --start 2026-04-01 --end 2026-04-09 --format json +``` + +```json +[ + { "description": "", "sentiment": "70", "temperature": "67", "time": "2026-04-01 04:00:00", "valuation": "64" }, + { "description": "", "sentiment": "34", "temperature": "50", "time": "2026-04-02 04:00:00", "valuation": "67" }, + { "description": "", "sentiment": "56", "temperature": "61", "time": "2026-04-06 04:00:00", "valuation": "67" } +] +``` + +Returns one record per trading day over the specified range. Useful for charting sentiment shifts around market events. diff --git a/docs/en/docs/cli/market-data/participants.md b/docs/en/docs/cli/market-data/participants.md new file mode 100644 index 00000000..847a115c --- /dev/null +++ b/docs/en/docs/cli/market-data/participants.md @@ -0,0 +1,42 @@ +--- +title: 'participants' +sidebar_label: 'participants' +sidebar_position: 13 +--- + +# longbridge participants + +Get the complete broker/participant directory for the HK market — maps broker IDs to firm names, letting you decode the `brokers` command output. + +## Basic Usage + +```bash +longbridge participants +``` + +``` +| Broker ID | Name EN | Name CN | +|------------|----------------------------------|----------------| +| 6596 | WE | 维恩证券 | +| 3014 | DRW (Hong Kong) Limited | DRW (Hong Kong) Limited | +| 7707, 7708 | Ark Securities (Hong Kong) Ltd | 同舟证券 | +| 724 | UTR8 Hong Kong Limited | UTR8 Hong Kong Limited | +| 1142 | Wanhai Securities (HK) Limited | 万海证券(香港) | +| 6409 | Standard Chartered(HK) | 渣打(香港) | +... +``` + +## Examples + +### Look up all broker IDs + +```bash +longbridge participants +longbridge participants --format json +``` + +Returns the full directory of HK exchange participants, each with their broker ID(s) and firm name. Some firms have multiple broker IDs listed together in a single `broker_id` string. + +## Notes + +HK market only. Use in conjunction with `longbridge brokers` to identify which firms are placing orders at each price level. The `broker_id` values here correspond directly to the IDs returned by the `brokers` command. diff --git a/docs/en/docs/cli/market-data/quote.md b/docs/en/docs/cli/market-data/quote.md new file mode 100644 index 00000000..9a6eb568 --- /dev/null +++ b/docs/en/docs/cli/market-data/quote.md @@ -0,0 +1,58 @@ +--- +title: 'quote' +sidebar_label: 'quote' +sidebar_position: 1 +--- + +# longbridge quote + +Get real-time quotes for one or more symbols — price, volume, change from previous close, and extended-hours data for US stocks. + +## Basic Usage + +```bash +longbridge quote TSLA.US NVDA.US +``` + +``` +| Symbol | Last | Prev Close | Open | High | Low | Volume | Turnover | Status | +|---------|---------|------------|---------|---------|---------|-----------|-----------------|--------| +| TSLA.US | 345.620 | 343.250 | 343.150 | 348.880 | 337.250 | 62164016 | 21375312140.000 | Normal | +| NVDA.US | 183.910 | 182.080 | 181.840 | 184.080 | 180.620 | 116428523 | 21303315176.000 | Normal | + +Extended Hours: +| Symbol | Session | Last | High | Low | Volume | Prev Close | Time | +|---------|---------|---------|---------|---------|---------|------------|---------------------| +| TSLA.US | Pre | 343.100 | 346.450 | 339.695 | 945393 | 343.250 | 2026-04-09 13:30:00 | +| TSLA.US | Post | 344.930 | 346.260 | 344.820 | 1348872 | 345.620 | 2026-04-09 23:59:59 | +| NVDA.US | Pre | 181.990 | 182.080 | 180.000 | 1116645 | 182.080 | 2026-04-09 13:30:00 | +| NVDA.US | Post | 183.020 | 183.950 | 182.900 | 6021581 | 183.910 | 2026-04-09 23:59:58 | +``` + +## Examples + +### Check a single stock + +```bash +longbridge quote TSLA.US +``` + +Displays the latest price, open, high, low, volume, turnover, and previous close for TSLA. + +### Compare multiple symbols across markets + +```bash +longbridge quote TSLA.US NVDA.US 700.HK +longbridge quote TSLA.US NVDA.US 700.HK --format json +``` + +Pass multiple symbols in one call to compare quotes side by side. Symbols from different markets (US, HK, CN) are all supported. US stocks include `pre_market_quote` and `post_market_quote` fields when extended-hours data is available. + +### Get pre-market and after-hours data + +```bash +# pre_market_quote and post_market_quote fields appear in US stock output +longbridge quote TSLA.US --format json +``` + +For US stocks, JSON output includes `pre_market_quote` and `post_market_quote` objects when extended-hours data is available. These fields are `null` during regular US market hours. diff --git a/docs/en/docs/cli/market-data/security-list.md b/docs/en/docs/cli/market-data/security-list.md new file mode 100644 index 00000000..d1195fc3 --- /dev/null +++ b/docs/en/docs/cli/market-data/security-list.md @@ -0,0 +1,45 @@ +--- +title: 'security-list' +sidebar_label: 'security-list' +sidebar_position: 12 +--- + +# longbridge security-list + +List US securities that are eligible for overnight trading on Longbridge. + +## Basic Usage + +```bash +longbridge security-list +``` + +``` +| Symbol | Name | +|----------|----------------------------| +| GDS.US | GDS | +| ZK.US | ZEEKR Intelligent Tech | +| ALTM.US | Arcadium Lithium | +| HE.US | Hawaiian Electric Inds | +| WB.US | Weibo | +... +``` + +## Examples + +### View overnight-eligible US securities + +```bash +# Default (US market) +longbridge security-list +# Explicit market +longbridge security-list US +# JSON output for validating eligibility before placing trades +longbridge security-list US --format json +``` + +Returns the full list of US symbols currently eligible for overnight trading sessions on Longbridge. Use `--format json` to get a machine-readable list for automating eligibility checks. + +## Notes + +Only the US market is supported (Longbridge API limitation). This list changes as eligibility is updated — check it before submitting overnight orders rather than relying on a cached copy. diff --git a/docs/en/docs/cli/market-data/static.md b/docs/en/docs/cli/market-data/static.md new file mode 100644 index 00000000..b877ac0a --- /dev/null +++ b/docs/en/docs/cli/market-data/static.md @@ -0,0 +1,40 @@ +--- +title: 'static' +sidebar_label: 'static' +sidebar_position: 7 +--- + +# longbridge static + +Get static reference data for any symbol — name, exchange, currency, lot size, shares outstanding, EPS, BPS, and dividend yield. + +## Basic Usage + +```bash +longbridge static TSLA.US +``` + +``` +| Symbol | Name | Exchange | Currency | Lot Size | Total Shares | Circ. Shares | EPS | EPS TTM | BPS | Dividend | +|---------|-------------|----------|----------|----------|--------------|--------------|--------|---------|--------|----------| +| TSLA.US | Tesla, Inc. | NASD | USD | 1 | 3752431984 | 2812676349 | 1.0111 | 1.0111 | 21.889 | 0 | +``` + +## Examples + +### Look up multiple symbols at once + +```bash +longbridge static NVDA.US TSLA.US +longbridge static NVDA.US TSLA.US --format json +``` + +Returns reference data for all requested symbols in one call. Useful for quick comparison of fundamental attributes. + +### Verify a symbol before trading + +```bash +longbridge static 700.HK +``` + +Confirms the symbol is valid and shows its exchange, currency, lot size, and current share count — handy before placing a trade. diff --git a/docs/en/docs/cli/market-data/subscriptions.md b/docs/en/docs/cli/market-data/subscriptions.md new file mode 100644 index 00000000..fbe7ff1d --- /dev/null +++ b/docs/en/docs/cli/market-data/subscriptions.md @@ -0,0 +1,38 @@ +--- +title: 'subscriptions' +sidebar_label: 'subscriptions' +sidebar_position: 14 +--- + +# longbridge subscriptions + +List your current active real-time quote subscriptions. + +## Basic Usage + +```bash +longbridge subscriptions +``` + +## Examples + +### Check active subscriptions + +```bash +longbridge subscriptions +``` + +Returns all symbols you are currently subscribed to for real-time quote streaming, along with the subscription types (e.g. quote, depth, trades). + +### Debug missing push notifications + +```bash +# Check what symbols are subscribed in the current session +longbridge subscriptions +``` + +If a real-time quote feed goes silent, run `subscriptions` to confirm the symbol is still active. Subscriptions are session-scoped — they reset each time you start a new session. + +## Notes + +Returns an empty list if you have no active subscriptions. Subscriptions are created through the TUI (or programmatically via the OpenAPI SDK). They are session-scoped and reset when you log out or the session expires. diff --git a/docs/en/docs/cli/market-data/trades.md b/docs/en/docs/cli/market-data/trades.md new file mode 100644 index 00000000..749095da --- /dev/null +++ b/docs/en/docs/cli/market-data/trades.md @@ -0,0 +1,53 @@ +--- +title: 'trades' +sidebar_label: 'trades' +sidebar_position: 4 +--- + +# longbridge trades + +Fetch recent tick-by-tick trade records for a symbol, including price, volume, time, and trade direction. + +## Basic Usage + +```bash +longbridge trades TSLA.US +``` + +``` +| Time | Price | Volume | Direction | Type | +|---------------------|---------|--------|-----------|------| +| 2026-04-09 23:59:43 | 344.940 | 5 | Down | I | +| 2026-04-09 23:59:43 | 344.940 | 40 | Down | | +| 2026-04-09 23:59:44 | 344.980 | 40 | Up | | +| 2026-04-09 23:59:44 | 344.980 | 5 | Up | I | +| 2026-04-09 23:59:45 | 344.970 | 1 | Down | I | +| 2026-04-09 23:59:52 | 344.975 | 100 | Neutral | | +``` + +## Examples + +### View last 20 trades + +```bash +longbridge trades TSLA.US +``` + +Returns the 20 most recent trades for TSLA, showing price, volume, timestamp, and direction for each tick. + +### Get more trades with --count + +```bash +longbridge trades TSLA.US --count 50 +``` + +Use `--count` to fetch up to 50 (or more) recent trades in a single call. + +### Read buy/sell pressure from trade direction + +```bash +# The direction field shows Up, Down, or Neutral relative to the prior trade +longbridge trades TSLA.US --count 50 --format json +``` + +Each entry includes a `direction` field indicating whether the trade printed above, below, or at the previous price — useful for gauging short-term momentum. diff --git a/docs/en/docs/cli/market-data/trading.md b/docs/en/docs/cli/market-data/trading.md new file mode 100644 index 00000000..6c81793e --- /dev/null +++ b/docs/en/docs/cli/market-data/trading.md @@ -0,0 +1,78 @@ +--- +title: 'trading' +sidebar_label: 'trading' +sidebar_position: 11 +--- + +# longbridge trading + +Look up trading session schedules and trading day calendars for any market. + +## Basic Usage + +```bash +longbridge trading session +``` + +``` +| Market | Session | Open | Close | +|--------|----------|----------|----------| +| US | Pre | 04:00:00 | 09:30:00 | +| US | Intraday | 09:30:00 | 16:00:00 | +| US | Post | 16:00:00 | 20:00:00 | +| HK | Intraday | 09:30:00 | 12:00:00 | +| HK | Intraday | 13:00:00 | 16:00:00 | +``` + +## Examples + +### View trading hours for all markets + +```bash +longbridge trading session --format json +``` + +```json +[ + { + "market": "US", + "sessions": [ + { "close": "9:30:00.0", "open": "4:00:00.0", "session": "Pre" }, + { "close": "16:00:00.0", "open": "9:30:00.0", "session": "Intraday" }, + { "close": "20:00:00.0", "open": "16:00:00.0", "session": "Post" } + ] + }, + { + "market": "HK", + "sessions": [ + { "close": "12:00:00.0", "open": "9:30:00.0", "session": "Intraday" }, + { "close": "16:00:00.0", "open": "13:00:00.0", "session": "Intraday" } + ] + } +] +``` + +The US market has three sessions (Pre, Intraday, Post). HK has two Intraday blocks separated by a lunch break. + +### Get trading calendar for a date range + +```bash +longbridge trading days HK --start 2026-04-01 --end 2026-04-10 --format json +``` + +```json +{ + "half_trading_days": [], + "trading_days": ["2026-04-01", "2026-04-02", "2026-04-08", "2026-04-09", "2026-04-10"] +} +``` + +Returns the list of full trading days and any half-trading days within the range. Public holidays are excluded automatically. + +### Check if today is a trading day + +```bash +longbridge trading days US +``` + +Omitting `--start` and `--end` returns today's trading status. If today is a trading day, it appears in the `trading_days` list. diff --git a/docs/en/docs/cli/orders/_category_.json b/docs/en/docs/cli/orders/_category_.json new file mode 100644 index 00000000..0fbc898f --- /dev/null +++ b/docs/en/docs/cli/orders/_category_.json @@ -0,0 +1 @@ +{ "label": "Orders & Trading", "icon": "arrow-right-left", "position": 8, "collapsed": true } diff --git a/docs/en/docs/cli/orders/exchange-rate.md b/docs/en/docs/cli/orders/exchange-rate.md new file mode 100644 index 00000000..5db61ac4 --- /dev/null +++ b/docs/en/docs/cli/orders/exchange-rate.md @@ -0,0 +1,39 @@ +--- +title: 'exchange-rate' +sidebar_label: 'exchange-rate' +sidebar_position: 4 +--- + +# longbridge exchange-rate + +Get current foreign exchange rates for all currency pairs used in your Longbridge account. + +## Basic Usage + +```bash +longbridge exchange-rate +``` + +``` +| pair | average_rate | bid_rate | offer_rate | +|-----------|--------------|----------|------------| +| HKD → CNH | 1.1465 | 1.1465 | 1.1465 | +| HKD → HKD | 1 | 1 | 1 | +| HKD → USD | 7.7925 | 7.7925 | 7.7925 | +| HKD → CNY | 1.1465 | 1.1465 | 1.1465 | +``` + +## Examples + +### View all exchange rates + +```bash +longbridge exchange-rate +longbridge exchange-rate --format json +``` + +Displays bid, offer, and average rates for all currency pairs available in your account (e.g., HKD/USD, HKD/CNH). All rates are expressed with HKD as the base currency. + +## Requirements + +No login is required. This command is available without authentication. diff --git a/docs/en/docs/cli/orders/margin-ratio.md b/docs/en/docs/cli/orders/margin-ratio.md new file mode 100644 index 00000000..bcf0081b --- /dev/null +++ b/docs/en/docs/cli/orders/margin-ratio.md @@ -0,0 +1,48 @@ +--- +title: 'margin-ratio' +sidebar_label: 'margin-ratio' +sidebar_position: 2 +--- + +# longbridge margin-ratio + +Look up the margin requirements for a symbol — initial, maintenance, and forced liquidation ratios. + +## Basic Usage + +```bash +longbridge margin-ratio TSLA.US +``` + +``` +| Field | Value | +|--------------------------|---------| +| Symbol | TSLA.US | +| Initial Margin Ratio | 0.35 | +| Maintenance Margin Ratio | 0.33 | +| Forced Liquidation Ratio | 0.25 | +``` + +## Examples + +### Check margin requirements before buying on margin + +```bash +longbridge margin-ratio TSLA.US +# Output as JSON for scripting +longbridge margin-ratio TSLA.US --format json +``` + +Displays the initial margin ratio, maintenance margin ratio, and forced liquidation ratio for the symbol. Use this before placing a margin buy to understand the capital requirements. + +### Compare multiple symbols + +```bash +longbridge margin-ratio TSLA.US NVDA.US +``` + +Pass multiple symbols to compare their margin requirements side by side. + +## Requirements + +OAuth trade or account permission is required to query margin ratios. See [Trade Permissions](/docs/trade/) for setup details. diff --git a/docs/en/docs/cli/orders/max-qty.md b/docs/en/docs/cli/orders/max-qty.md new file mode 100644 index 00000000..23041dc4 --- /dev/null +++ b/docs/en/docs/cli/orders/max-qty.md @@ -0,0 +1,47 @@ +--- +title: 'max-qty' +sidebar_label: 'max-qty' +sidebar_position: 3 +--- + +# longbridge max-qty + +Estimate the maximum quantity you can buy or sell given your current account balance, at a specified price. + +## Basic Usage + +```bash +longbridge max-qty TSLA.US --side buy --price 340.00 +``` + +``` +| Field | Value | +|----------------|---------| +| Symbol | TSLA.US | +| Cash Max Qty | 0 | +| Margin Max Qty | 896 | +``` + +## Examples + +### Max buy quantity at a price + +```bash +longbridge max-qty TSLA.US --side buy --price 340.00 +# Output as JSON for scripting +longbridge max-qty TSLA.US --side buy --price 340.00 --format json +``` + +Returns the maximum number of shares you can purchase at the given price, broken down by cash and margin buying power. + +### Max sell quantity + +```bash +longbridge max-qty TSLA.US --side sell +``` + +Returns the maximum number of shares you can sell, based on your current holdings. + +## Requirements + +OAuth trade or account permission is required to query maximum order quantities. See [Trade Permissions](/docs/trade/) for setup details. diff --git a/docs/en/docs/cli/orders/order.md b/docs/en/docs/cli/orders/order.md new file mode 100644 index 00000000..599304f1 --- /dev/null +++ b/docs/en/docs/cli/orders/order.md @@ -0,0 +1,100 @@ +--- +title: 'order' +sidebar_label: 'order' +sidebar_position: 1 +--- + +# longbridge order + +View your orders and trade executions, or submit buy/sell orders directly from the terminal. + +## Basic Usage + +```bash +longbridge order +``` + +``` +| Order ID | Symbol | Side | Order Type | Status | Qty | Price | Exec Qty | Exec Price | Created At | +|--------------------|---------|------|------------|---------------|-----|--------|----------|------------|---------------------| +| 701276261045858304 | TSLA.US | Buy | LO | Filled | 10 | 340.00 | 10 | 339.85 | 2026-04-10 09:32:14 | +| 701276261045858305 | NVDA.US | Sell | LO | PartialFilled | 20 | 185.00 | 12 | 185.00 | 2026-04-10 09:45:01 | +| 701276261045858306 | AAPL.US | Buy | MO | New | 5 | - | 0 | - | 2026-04-10 10:01:33 | +``` + +## Examples + +### View today's orders + +```bash +longbridge order +``` + +Lists all orders placed today with their status, symbol, quantity, price, and order ID. + +### Historical orders for a symbol + +```bash +longbridge order --history --start 2026-01-01 --symbol TSLA.US +``` + +Fetches historical orders filtered by symbol and date range. Use `--start` and `--end` to set the date window. + +### Submit a limit buy order + +```bash +longbridge order buy TSLA.US 10 --price 340.00 +``` + +Places a limit buy order for 10 shares of TSLA at $340.00. The command prompts for confirmation before submitting. + +### Submit a limit sell order + +```bash +longbridge order sell TSLA.US 5 --price 360.00 +``` + +Places a limit sell order for 5 shares of TSLA at $360.00. The command prompts for confirmation before submitting. + +### View trade executions + +```bash +longbridge order executions +``` + +Lists all filled trade executions for the current day, including execution price, quantity, and time. + +### View order details + +```bash +# Fetch full detail for a specific order +longbridge order detail 701276261045858304 +``` + +Returns execution details, timestamps, and fill information for the order. + +### Cancel a pending order + +```bash +# Cancel prompts for confirmation before submitting +longbridge order cancel 701276261045858304 +``` + +Only orders in cancellable states (New, PartialFilled, etc.) are accepted. Use `-y` to skip the confirmation prompt in scripts. + +### Modify an open order + +```bash +# Adjust quantity or price on a pending order +longbridge order replace 701276261045858304 --qty 5 --price 350.00 +``` + +`--qty` is required. Omit `--price` to keep the current limit price. Use `-y` to skip the confirmation prompt in scripts. + +## Requirements + +OAuth trade permission is required to place, cancel, or replace orders. See the [trade permission setup](/docs/trade/) guide to enable trading access. + +## Notes + +`buy` and `sell` always prompt for confirmation before submitting. Use `-y` with `cancel` and `replace` to skip confirmation in scripting contexts. diff --git a/docs/en/docs/cli/release-notes.md b/docs/en/docs/cli/release-notes.md new file mode 100644 index 00000000..ee22a1ae --- /dev/null +++ b/docs/en/docs/cli/release-notes.md @@ -0,0 +1,45 @@ +--- +title: 'Release Notes' +sidebar_label: 'Release Notes' +sidebar_position: 100 +--- + +# Release Notes + +### [v0.15.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.15.0) + +- **New: `portfolio` command** — total P/L, asset distribution by market (US/HK/CN/SG/Cash), holdings, and cash balances +- **New: `investors` command** — SEC 13F-based active fund manager rankings; view any investor's holdings by CIK with live prices +- **New: `insider-trades`** — SEC Form 4 insider transaction history for any symbol +- **New: `watchlist pin/unpin`** — pin securities to the top of a watchlist group +- **Enhanced: `assets`** — renamed from `balance`; now shows full asset overview: net assets, buying power, margin, risk level, and per-currency cash breakdown + +### [v0.14.2](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.2) + +- **New: `--lang` global flag** — set content language (`zh-CN`, `zh-HK`, `en`) for all commands; falls back to system `LANG` env var then `en` + +### [v0.14.1](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.1) + +- **New: CN region login** — `longbridge login` now supports China region routing +- **New: `-v` flag** — show version without entering the full command + +### [v0.14.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.0) + +- **New: Device auth login** — `longbridge login` now uses OAuth device flow; displays a URL and code to authorize on any device, works in SSH and headless environments; `--headless` flag removed +- **New: Order enhancements** — trailing stop and AO order types; `--expire-date`, `--outside-rth`, `--remark` added to order commands +- **Fix: Linux segfault** — prebuilt Linux binary now uses musl to fix crash on some distributions + +### [v0.13.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.13.0) + +- **New: Fundamentals & analysis commands** — `financial-report`, `valuation`, `forecast-eps`, `consensus`, `institution-rating`, `shareholder`, `fund-holder`, `dividend`, `finance-calendar`, `exchange-rate` +- **Breaking: command restructure** — 19 flat commands moved into subcommand trees (e.g. `news-detail` → `news detail`, `kline-history` → `kline history`, `warrant-list` → `warrant list`) +- **CN region support** — set `LONGBRIDGE_REGION=cn` to route through the China endpoint + +### [v0.12.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.12.0) + +- **New: `statement` commands** — list and export daily/monthly account statements +- **TUI** — fixed `q` quit; added news list and detail views inside watchlist + +--- + +Full changelog: [github.com/longbridge/longbridge-terminal/releases](https://github.com/longbridge/longbridge-terminal/releases) diff --git a/docs/en/docs/cli/research/_category_.json b/docs/en/docs/cli/research/_category_.json new file mode 100644 index 00000000..c1a834be --- /dev/null +++ b/docs/en/docs/cli/research/_category_.json @@ -0,0 +1 @@ +{ "label": "Research", "icon": "search", "position": 6, "collapsed": true } diff --git a/docs/en/docs/cli/research/insider-trades.md b/docs/en/docs/cli/research/insider-trades.md new file mode 100644 index 00000000..74b50533 --- /dev/null +++ b/docs/en/docs/cli/research/insider-trades.md @@ -0,0 +1,49 @@ +--- +title: 'insider-trades' +sidebar_label: 'insider-trades' +sidebar_position: 2 +--- + +# longbridge insider-trades + +View [SEC Form 4](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40) insider transaction history for any US-listed stock — purchases, sales, and option exercises by company insiders. + +## Basic Usage + +```bash +longbridge insider-trades TSLA.US +``` + +``` +| date | filer | title | type | shares | price | value | owned_after | +|------------|--------------|---------------|----------|--------|---------|----------|-------------| +| 2026-03-31 | Zhu Xiaotong | SVP | EXERCISE | 20.00K | $20.57 | $411.40K | 20.00K | +| 2025-09-11 | Zhu Xiaotong | SVP, APAC and | SELL | 20.00K | $363.75 | $7.28M | 47.60K | +| 2025-06-12 | Zhu Xiaotong | SVP, APAC | EXERCISE | 15.00K | $20.57 | $308.55K | 82.60K | +| 2025-06-12 | Zhu Xiaotong | SVP, APAC | SELL | 15.00K | $323.81 | $4.86M | 67.60K | +``` + +## Examples + +### Check insider activity + +```bash +longbridge insider-trades TSLA.US +longbridge insider-trades TSLA.US --format json +``` + +Lists recent insider transactions including the insider's name, title, transaction date, type, share count, and price. + +### Expand the filing history + +```bash +# Fetch more filings to cover a wider date range +longbridge insider-trades TSLA.US --count 100 +longbridge insider-trades AAPL.US --count 100 --format json +``` + +Use `--count` to retrieve more Form 4 filings and cover a broader time window. Useful for tracking insider activity around earnings announcements or major corporate events. + +## Notes + +US market only. Data sourced from [SEC EDGAR Form 4 filings](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40). diff --git a/docs/en/docs/cli/research/investors.md b/docs/en/docs/cli/research/investors.md new file mode 100644 index 00000000..6c6b0f87 --- /dev/null +++ b/docs/en/docs/cli/research/investors.md @@ -0,0 +1,56 @@ +--- +title: 'investors' +sidebar_label: 'investors' +sidebar_position: 3 +--- + +# longbridge investors + +Browse active institutional fund managers ranked by AUM (from [SEC 13F filings](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=13F&dateb=&owner=include&count=40)), and drill into any manager's current holdings. + +## Basic Usage + +```bash +longbridge investors +``` + +``` +| # | name | AUM | period | cik | +|----|-----------------------------------|----------|-------------|------------| +| 1 | Capital International Investors | $637.97B | 31-DEC-2025 | 0001562230 | +| 2 | Capital Research Global Investors | $541.73B | 31-DEC-2025 | 0001422848 | +| 3 | CTC LLC | $404.44B | 31-DEC-2025 | 0001445893 | +| 4 | BERKSHIRE HATHAWAY INC | $274.16B | 31-DEC-2025 | 0001067983 | +| 5 | DODGE & COX | $185.26B | 31-DEC-2025 | 0000200217 | +... +``` + +## Examples + +### Browse top fund managers + +Lists the largest institutional investors ranked by AUM, with their CIK identifier, name, reported AUM, and the period of the latest [13F filing](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=13F&dateb=&owner=include&count=40). + +### View a fund manager's holdings + +```bash +# Use the CIK from the investors list to drill into holdings +longbridge investors 0001067983 +longbridge investors 0001067983 --format json +``` + +``` +BERKSHIRE HATHAWAY INC (period: 2025-12-31) +Portfolio: 42 positions, total value ~$274.16B + +| company | value | shares | weight | +|-----------------------|---------|---------|--------| +| APPLE INC | $61.96B | 227.92M | 22.6% | +| AMERICAN EXPRESS CO | $56.09B | 151.61M | 20.5% | +| BANK AMERICA CORP | $28.45B | 517.30M | 10.4% | +| COCA COLA CO | $27.96B | 400.00M | 10.2% | +| CHEVRON CORP NEW | $19.84B | 130.16M | 7.2% | +... +``` + +Pass a CIK to see the full list of equity positions reported by that fund manager. CIK `0001067983` is Berkshire Hathaway. diff --git a/docs/en/docs/cli/research/shareholder.md b/docs/en/docs/cli/research/shareholder.md new file mode 100644 index 00000000..5080c78e --- /dev/null +++ b/docs/en/docs/cli/research/shareholder.md @@ -0,0 +1,36 @@ +--- +title: 'shareholder' +sidebar_label: 'shareholder' +sidebar_position: 1 +--- + +# longbridge shareholder + +View the top shareholders of a company — institutional and individual — with ownership percentages and recent share count changes. + +## Basic Usage + +```bash +longbridge shareholder TSLA.US +``` + +``` +| shareholder | symbol | % shares | chg shares | report_date | +|------------------------------------|--------|----------|------------|-------------| +| Elon R. Musk | - | 24.86% | +423.53M | 2025-12-30 | +| The Vanguard Group, Inc. | - | 6.90% | +6.54M | 2025-12-31 | +| BlackRock, Inc. | BLK.US | 5.57% | +2.81M | 2025-12-31 | +| State Street Global Advisors, Inc. | - | 3.06% | +1.08M | 2025-12-31 | +| Geode Capital Management, LLC | - | 1.75% | +375.95K | 2025-12-31 | +``` + +## Examples + +### Check top shareholders + +```bash +longbridge shareholder TSLA.US +longbridge shareholder TSLA.US --format json +``` + +Lists the largest shareholders by ownership percentage, including both institutional investors and individual insiders. diff --git a/docs/en/docs/cli/tui.md b/docs/en/docs/cli/tui.md new file mode 100644 index 00000000..45b8fadb --- /dev/null +++ b/docs/en/docs/cli/tui.md @@ -0,0 +1,43 @@ +--- +title: 'tui' +sidebar_label: 'TUI' +sidebar_position: 99 +--- + +# longbridge tui + +Launch the interactive full-screen terminal UI — a real-time trading dashboard with watchlist +management, live candlestick charts, portfolio view, and stock search. Vim-style keybindings. + +## Basic Usage + +```bash +longbridge tui +``` + + + longbridge tui demo + + +## Examples + +### Monitor a watchlist in real time + +The TUI opens your watchlist and shows live price ticks, change percentages, and volume. +Navigate between stocks with `j`/`k` or arrow keys. + +### View candlestick charts + +Press `Enter` on any symbol to open the stock detail view with a live K-line chart. +Switch between timeframes with `1m`, `5m`, `1h`, `1d` keybindings. + +### Search and add symbols + +Press `/` to open the search overlay. Type a symbol name or code to find and add it to +your watchlist. + +## Notes + +- Requires a valid `longbridge login` session +- The TUI shares the same token as CLI commands +- Press `q` or `Ctrl+C` to quit diff --git a/docs/en/docs/cli/watchlist/_category_.json b/docs/en/docs/cli/watchlist/_category_.json new file mode 100644 index 00000000..c2486e42 --- /dev/null +++ b/docs/en/docs/cli/watchlist/_category_.json @@ -0,0 +1 @@ +{ "label": "Watchlist", "icon": "star", "position": 9, "collapsed": true } diff --git a/docs/en/docs/cli/watchlist/watchlist.md b/docs/en/docs/cli/watchlist/watchlist.md new file mode 100644 index 00000000..5c80b15f --- /dev/null +++ b/docs/en/docs/cli/watchlist/watchlist.md @@ -0,0 +1,102 @@ +--- +title: 'watchlist' +sidebar_label: 'watchlist' +sidebar_position: 1 +--- + +# longbridge watchlist + +View and manage your Longbridge watchlists — list groups, add or remove symbols, create new groups, and pin securities to the top. + +## Basic Usage + +```bash +longbridge watchlist +``` + +``` +Group: all (ID: 2630) +| Symbol | Name | Market | Pinned | +|------------|------------------------------------|--------|--------| +| SPY.US | SPDR S&P 500 | US | yes | +| QQQ.US | Invesco QQQ Trust | US | yes | +| TSLA.US | Tesla | US | | +| AAPL.US | Apple | US | | +| QQQI.US | NEOS Nasdaq-100(R) High Income ETF | US | | +``` + +## Examples + +### View all watchlist groups and their securities + +```bash +longbridge watchlist +``` + +```json +[ + { + "id": 2630, + "name": "all", + "securities": [ + { "is_pinned": true, "market": "US", "name": "SPDR S&P 500", "symbol": "SPY.US" }, + { "is_pinned": true, "market": "US", "name": "Invesco QQQ Trust", "symbol": "QQQ.US" }, + { "is_pinned": false, "market": "US", "name": "Tesla", "symbol": "TSLA.US" } + ] + } +] +``` + +Lists all watchlist groups with their IDs, names, and securities. Group IDs are needed for `update`, `pin`, and `delete` subcommands. + +### Add symbols to a group + +```bash +longbridge watchlist update 2630 --add NVDA.US --add AAPL.US +``` + +Adds one or more symbols to an existing group. Run `longbridge watchlist` first to find group IDs. + +### Remove symbols from a group + +```bash +longbridge watchlist update 2630 --remove NVDA.US --remove AAPL.US +``` + +Removes one or more symbols from an existing group. Run `longbridge watchlist` first to confirm the group ID and current securities. + +### Create a new watchlist group + +```bash +longbridge watchlist create "Tech Stocks" +``` + +Creates a new empty watchlist group with the given name. Use `update` afterward to add securities. + +### Rename a group + +```bash +longbridge watchlist update 2630 --name "New Name" +``` + +Renames an existing watchlist group. Run `longbridge watchlist` first to find the group ID. + +### Pin a security to the top + +```bash +longbridge watchlist pin 2630 TSLA.US +``` + +Pins a security to the top of a watchlist group. Pinned securities appear first and have `is_pinned: true` in the output. Run the command again on a pinned security to unpin it. + +### Remove a group + +```bash +longbridge watchlist delete 2630 +``` + +Permanently deletes a watchlist group and all its securities. Run `longbridge watchlist` first to confirm the group ID before deleting. + +## Requirements + +A valid OAuth login is required. Run `longbridge login` if you have not yet authenticated. diff --git a/docs/en/docs/content/_category_.json b/docs/en/docs/content/_category_.json index 778ccdb4..7e9e7313 100644 --- a/docs/en/docs/content/_category_.json +++ b/docs/en/docs/content/_category_.json @@ -1 +1,8 @@ -{ "label": "Community", "collapsible": true, "collapsed": true, "link": null, "position": 4.5 } +{ + "label": "Community", + "collapsible": true, + "collapsed": true, + "link": null, + "position": 4.5, + "icon": "newspaper" +} diff --git a/docs/en/docs/content/create_topic.md b/docs/en/docs/content/create_topic.md index b006061e..35bf1516 100644 --- a/docs/en/docs/content/create_topic.md +++ b/docs/en/docs/content/create_topic.md @@ -62,7 +62,7 @@ longbridge topic create AAPL.US "Apple WWDC preview" -```bash + # Short post — plain text (default). Markdown is NOT rendered. longbridge topic create --body "Bullish on 700.HK today" @@ -77,7 +77,7 @@ longbridge topic create --title "Q4 Earnings Preview" --body "$(cat analysis.md) # JSON output longbridge topic create --body "Test post" --format json -``` + @@ -354,28 +354,28 @@ func main() { -| Name | Type | Required | Description | -| ------------------- | -------- | -------- | --------------------------------------------------- | -| item | object | true | Newly created topic details | -| ∟ id | string | true | Topic ID | -| ∟ title | string | false | Topic title | -| ∟ description | string | false | Plain-text summary (auto-generated from body) | -| ∟ body | string | false | Full body text (Markdown for `article`) | -| ∟ topic_type | string | false | Topic type. One of `article`, `post` | -| ∟ tickers | string[] | false | Associated security symbols | -| ∟ hashtags | string[] | false | Associated hashtag names | -| ∟ images | object[] | false | Image list | -| ∟∟ url | string | false | Original image URL | -| ∟∟ sm | string | false | Small thumbnail URL | -| ∟∟ lg | string | false | Large thumbnail URL | -| ∟ likes_count | int32 | false | Number of likes | -| ∟ comments_count | int32 | false | Number of replies | -| ∟ views_count | int32 | false | Number of views | -| ∟ shares_count | int32 | false | Number of shares | -| ∟ detail_url | string | false | Direct URL to the topic | -| ∟ author | object | false | Author information | -| ∟∟ member_id | string | false | Author member ID | -| ∟∟ name | string | false | Author display name | -| ∟∟ avatar | string | false | Author avatar URL | -| ∟ created_at | string | true | Unix timestamp (seconds) when the topic was created | -| ∟ updated_at | string | false | Unix timestamp (seconds) of last update | +| Name | Type | Required | Description | +| ---------------- | -------- | -------- | --------------------------------------------------- | +| item | object | true | Newly created topic details | +| ∟ id | string | true | Topic ID | +| ∟ title | string | false | Topic title | +| ∟ description | string | false | Plain-text summary (auto-generated from body) | +| ∟ body | string | false | Full body text (Markdown for `article`) | +| ∟ topic_type | string | false | Topic type. One of `article`, `post` | +| ∟ tickers | string[] | false | Associated security symbols | +| ∟ hashtags | string[] | false | Associated hashtag names | +| ∟ images | object[] | false | Image list | +| ∟∟ url | string | false | Original image URL | +| ∟∟ sm | string | false | Small thumbnail URL | +| ∟∟ lg | string | false | Large thumbnail URL | +| ∟ likes_count | int32 | false | Number of likes | +| ∟ comments_count | int32 | false | Number of replies | +| ∟ views_count | int32 | false | Number of views | +| ∟ shares_count | int32 | false | Number of shares | +| ∟ detail_url | string | false | Direct URL to the topic | +| ∟ author | object | false | Author information | +| ∟∟ member_id | string | false | Author member ID | +| ∟∟ name | string | false | Author display name | +| ∟∟ avatar | string | false | Author avatar URL | +| ∟ created_at | string | true | Unix timestamp (seconds) when the topic was created | +| ∟ updated_at | string | false | Unix timestamp (seconds) of last update | diff --git a/docs/en/docs/content/create_topic_reply.md b/docs/en/docs/content/create_topic_reply.md index d51d2058..b3460552 100644 --- a/docs/en/docs/content/create_topic_reply.md +++ b/docs/en/docs/content/create_topic_reply.md @@ -71,13 +71,13 @@ longbridge topic create-reply 6993508780031016960 --body "Great analysis!" -```bash + # Top-level reply longbridge topic create-reply 6993508780031016960 --body "Great analysis!" # Nested reply longbridge topic create-reply 6993508780031016960 --body "I agree." --reply-to 7001234567890123456 -``` + diff --git a/docs/en/docs/content/my_topics.md b/docs/en/docs/content/my_topics.md index 89271e68..c8eadadc 100644 --- a/docs/en/docs/content/my_topics.md +++ b/docs/en/docs/content/my_topics.md @@ -40,13 +40,13 @@ longbridge topic mine -```bash + longbridge topic mine # All types (default: 50 per page) longbridge topic mine --type article # Articles only longbridge topic mine --type post --size 10 # Short posts, 10 per page longbridge topic mine --page 2 # Page 2 longbridge topic mine --format json # JSON output for scripting -``` + diff --git a/docs/en/docs/content/security_news.md b/docs/en/docs/content/security_news.md index cb4d06ce..81e81cf2 100644 --- a/docs/en/docs/content/security_news.md +++ b/docs/en/docs/content/security_news.md @@ -34,8 +34,8 @@ longbridge news NVDA.US ### Path Parameters -| Name | Type | Required | Description | -| ------ | ------ | -------- | --------------------------------------------------- | +| Name | Type | Required | Description | +| ------ | ------ | -------- | -------------------------------------------------------- | | symbol | string | YES | Stock symbol, use `ticker.region` format, e.g. `AAPL.US` | ### Request Example @@ -80,10 +80,12 @@ if __name__ == "__main__": const { Config, ContentContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = ContentContext.new(config) - const resp = await ctx.news("AAPL.US") + const resp = await ctx.news('AAPL.US') console.log(resp) } main().catch(console.error) @@ -258,14 +260,14 @@ func main() { -| Name | Type | Required | Description | -| ------------------ | --------- | -------- | ------------------------------------------ | -| items | object[] | true | News list | -| ∟ id | string | true | News ID | -| ∟ title | string | true | Title | -| ∟ description | string | true | Summary/description | -| ∟ url | string | true | Detail page URL | -| ∟ published_at | string | true | Published time, Unix timestamp (seconds) | -| ∟ comments_count | int32 | true | Comment count | -| ∟ likes_count | int32 | true | Like count | -| ∟ shares_count | int32 | true | Share count | +| Name | Type | Required | Description | +| ---------------- | -------- | -------- | ---------------------------------------- | +| items | object[] | true | News list | +| ∟ id | string | true | News ID | +| ∟ title | string | true | Title | +| ∟ description | string | true | Summary/description | +| ∟ url | string | true | Detail page URL | +| ∟ published_at | string | true | Published time, Unix timestamp (seconds) | +| ∟ comments_count | int32 | true | Comment count | +| ∟ likes_count | int32 | true | Like count | +| ∟ shares_count | int32 | true | Share count | diff --git a/docs/en/docs/content/security_topics.md b/docs/en/docs/content/security_topics.md index 1cf41405..aec286bd 100644 --- a/docs/en/docs/content/security_topics.md +++ b/docs/en/docs/content/security_topics.md @@ -34,8 +34,8 @@ longbridge topics NVDA.US ### Path Parameters -| Name | Type | Required | Description | -| ------ | ------ | -------- | --------------------------------------------------- | +| Name | Type | Required | Description | +| ------ | ------ | -------- | -------------------------------------------------------- | | symbol | string | YES | Stock symbol, use `ticker.region` format, e.g. `AAPL.US` | ### Request Example @@ -80,10 +80,12 @@ if __name__ == "__main__": const { Config, ContentContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = ContentContext.new(config) - const resp = await ctx.topics("AAPL.US") + const resp = await ctx.topics('AAPL.US') console.log(resp) } main().catch(console.error) @@ -247,10 +249,10 @@ func main() { ### Response Status -| Status | Description | Schema | -| ------ | -------------- | --------------------------------------------- | -| 200 | Success | [topics_response](#schematopics_response) | -| 500 | Internal error | None | +| Status | Description | Schema | +| ------ | -------------- | ----------------------------------------- | +| 200 | Success | [topics_response](#schematopics_response) | +| 500 | Internal error | None | ## Schemas @@ -258,14 +260,14 @@ func main() { -| Name | Type | Required | Description | -| ---------------- | --------- | -------- | ---------------------------------------- | -| items | object[] | true | Topic list | -| ∟ id | string | true | Topic ID | -| ∟ title | string | true | Title | -| ∟ description | string | true | Summary/description | -| ∟ url | string | true | Detail page URL | -| ∟ published_at | string | true | Published time, Unix timestamp (seconds) | -| ∟ comments_count | int32 | true | Comment count | -| ∟ likes_count | int32 | true | Like count | -| ∟ shares_count | int32 | true | Share count | +| Name | Type | Required | Description | +| ---------------- | -------- | -------- | ---------------------------------------- | +| items | object[] | true | Topic list | +| ∟ id | string | true | Topic ID | +| ∟ title | string | true | Title | +| ∟ description | string | true | Summary/description | +| ∟ url | string | true | Detail page URL | +| ∟ published_at | string | true | Published time, Unix timestamp (seconds) | +| ∟ comments_count | int32 | true | Comment count | +| ∟ likes_count | int32 | true | Like count | +| ∟ shares_count | int32 | true | Share count | diff --git a/docs/en/docs/content/topic_detail.md b/docs/en/docs/content/topic_detail.md index 5156eb66..ee7cae41 100644 --- a/docs/en/docs/content/topic_detail.md +++ b/docs/en/docs/content/topic_detail.md @@ -38,9 +38,9 @@ longbridge topic detail 6993508780031016960 -```bash + longbridge topic detail 6993508780031016960 -``` + diff --git a/docs/en/docs/content/topic_replies.md b/docs/en/docs/content/topic_replies.md index 4324580a..0ea41983 100644 --- a/docs/en/docs/content/topic_replies.md +++ b/docs/en/docs/content/topic_replies.md @@ -32,26 +32,26 @@ longbridge topic replies 6993508780031016960 --page 2 --size 20 ### Path Parameters -| Name | Type | Required | Description | -| --------- | ------ | -------- | -------------------------------------------------------- | -| topic_id | string | YES | Topic ID (e.g. `6993508780031016960`) | +| Name | Type | Required | Description | +| -------- | ------ | -------- | ------------------------------------- | +| topic_id | string | YES | Topic ID (e.g. `6993508780031016960`) | ### Query Parameters -| Name | Type | Required | Description | -| ----- | ----- | -------- | ---------------------------------------------- | -| page | int32 | NO | Page number (1-based). Defaults to `1`. | -| size | int32 | NO | Items per page, range 1–50. Defaults to `20`. | +| Name | Type | Required | Description | +| ---- | ----- | -------- | --------------------------------------------- | +| page | int32 | NO | Page number (1-based). Defaults to `1`. | +| size | int32 | NO | Items per page, range 1–50. Defaults to `20`. | ### Request Example -```bash + longbridge topic replies 6993508780031016960 longbridge topic replies 6993508780031016960 --page 2 --size 20 -``` + @@ -201,10 +201,10 @@ async fn main() -> Result<(), Box> { ### Response Status -| Status | Description | Schema | -| ------ | -------------- | --------------------------------------------------------------- | -| 200 | Success | [topic_replies_response](#schematopic_replies_response) | -| 500 | Internal error | None | +| Status | Description | Schema | +| ------ | -------------- | ------------------------------------------------------- | +| 200 | Success | [topic_replies_response](#schematopic_replies_response) | +| 500 | Internal error | None | ## Schemas @@ -212,21 +212,21 @@ async fn main() -> Result<(), Box> { -| Name | Type | Required | Description | -| ------------------- | -------- | -------- | ------------------------------------------------------------------------- | -| items | object[] | true | List of replies | -| ∟ id | string | true | Reply ID | -| ∟ topic_id | string | true | Parent topic ID | -| ∟ body | string | false | Reply body (plain text) | -| ∟ reply_to_id | string | false | Parent reply ID; `"0"` = top-level reply | -| ∟ author | object | false | Author info | -| ∟∟ member_id | string | false | Author member ID | -| ∟∟ name | string | false | Author display name | -| ∟∟ avatar | string | false | Author avatar URL | -| ∟ images | object[] | false | Attached images | -| ∟∟ url | string | false | Original image URL | -| ∟∟ sm | string | false | Small thumbnail URL | -| ∟∟ lg | string | false | Large image URL | -| ∟ likes_count | int32 | false | Likes count | -| ∟ comments_count | int32 | false | Nested replies count | -| ∟ created_at | string | true | Creation time as Unix timestamp (seconds) | +| Name | Type | Required | Description | +| ---------------- | -------- | -------- | ----------------------------------------- | +| items | object[] | true | List of replies | +| ∟ id | string | true | Reply ID | +| ∟ topic_id | string | true | Parent topic ID | +| ∟ body | string | false | Reply body (plain text) | +| ∟ reply_to_id | string | false | Parent reply ID; `"0"` = top-level reply | +| ∟ author | object | false | Author info | +| ∟∟ member_id | string | false | Author member ID | +| ∟∟ name | string | false | Author display name | +| ∟∟ avatar | string | false | Author avatar URL | +| ∟ images | object[] | false | Attached images | +| ∟∟ url | string | false | Original image URL | +| ∟∟ sm | string | false | Small thumbnail URL | +| ∟∟ lg | string | false | Large image URL | +| ∟ likes_count | int32 | false | Likes count | +| ∟ comments_count | int32 | false | Nested replies count | +| ∟ created_at | string | true | Creation time as Unix timestamp (seconds) | diff --git a/docs/en/docs/getting-started.md b/docs/en/docs/getting-started.md index 3b5df6eb..435f9c4c 100644 --- a/docs/en/docs/getting-started.md +++ b/docs/en/docs/getting-started.md @@ -102,9 +102,9 @@ iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex ### Login -```bash + longbridge login -``` + The browser opens the authorization page automatically. The token is saved after approval — no need to repeat. diff --git a/docs/en/docs/qa/_category_.json b/docs/en/docs/qa/_category_.json index 5fbb875c..7b212186 100644 --- a/docs/en/docs/qa/_category_.json +++ b/docs/en/docs/qa/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": true, "link": null, - "position": 6.5 + "position": 6.5, + "icon": "book-open" } diff --git a/docs/en/docs/qa/general.md b/docs/en/docs/qa/general.md index d75271f7..55288897 100644 --- a/docs/en/docs/qa/general.md +++ b/docs/en/docs/qa/general.md @@ -49,10 +49,10 @@ The platform offers two ways to access stock data without writing any code: Install the [Longbridge CLI](/docs/cli) and query market data with simple commands — no programming required: -```bash + longbridge quote AAPL.US TSLA.US longbridge static NVDA.US -``` + **MCP (AI Tool Integration)** diff --git a/docs/en/docs/quote/_category_.json b/docs/en/docs/quote/_category_.json index 570c76a4..c7cfd1c6 100644 --- a/docs/en/docs/quote/_category_.json +++ b/docs/en/docs/quote/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": true, "link": null, - "position": 3 + "position": 3, + "icon": "bar-chart-2" } diff --git a/docs/en/docs/quote/individual/watchlist_create_group.md b/docs/en/docs/quote/individual/watchlist_create_group.md index 51433c23..79ad4506 100644 --- a/docs/en/docs/quote/individual/watchlist_create_group.md +++ b/docs/en/docs/quote/individual/watchlist_create_group.md @@ -78,10 +78,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.createWatchlistGroup("My Group", ["700.HK", "AAPL.US"]) + const resp = await ctx.createWatchlistGroup('My Group', ['700.HK', 'AAPL.US']) console.log(resp) } main().catch(console.error) @@ -215,7 +217,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/quote/individual/watchlist_delete_group.md b/docs/en/docs/quote/individual/watchlist_delete_group.md index c649f17b..1664293f 100644 --- a/docs/en/docs/quote/individual/watchlist_delete_group.md +++ b/docs/en/docs/quote/individual/watchlist_delete_group.md @@ -74,11 +74,13 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) await ctx.deleteWatchlistGroup(1) - console.log("deleted") + console.log('deleted') } main().catch(console.error) ``` @@ -211,7 +213,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/quote/individual/watchlist_groups.md b/docs/en/docs/quote/individual/watchlist_groups.md index 6816bd0b..062938fe 100644 --- a/docs/en/docs/quote/individual/watchlist_groups.md +++ b/docs/en/docs/quote/individual/watchlist_groups.md @@ -67,7 +67,9 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) const resp = await ctx.watchlist() @@ -206,7 +208,6 @@ func main() { - ## Response ### Response Headers @@ -256,15 +257,15 @@ func main() { -| Name | Type | Required | Description | -| ---------------- | -------- | -------- | ------------- | -| groups | object[] | false | Groups | -| ∟ id | integer | true | Group ID | -| ∟ name | string | true | Name | -| ∟ securities | object[] | true | Security | -| ∟∟ symbol | string | true | Symbol | -| ∟∟ market | string | true | Market | -| ∟∟ name | string | true | Name | -| ∟∟ watched_price | string | true | Watched price | -| ∟∟ watched_at | integer | true | Watched time | +| Name | Type | Required | Description | +| ---------------- | -------- | -------- | ------------------------------ | +| groups | object[] | false | Groups | +| ∟ id | integer | true | Group ID | +| ∟ name | string | true | Name | +| ∟ securities | object[] | true | Security | +| ∟∟ symbol | string | true | Symbol | +| ∟∟ market | string | true | Market | +| ∟∟ name | string | true | Name | +| ∟∟ watched_price | string | true | Watched price | +| ∟∟ watched_at | integer | true | Watched time | | ∟∟ is_pinned | boolean | true | Whether the security is pinned | diff --git a/docs/en/docs/quote/individual/watchlist_update_group.md b/docs/en/docs/quote/individual/watchlist_update_group.md index 3eb3968b..299dc21f 100644 --- a/docs/en/docs/quote/individual/watchlist_update_group.md +++ b/docs/en/docs/quote/individual/watchlist_update_group.md @@ -80,11 +80,13 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - await ctx.updateWatchlistGroup(1, "New Name", ["700.HK"]) - console.log("updated") + await ctx.updateWatchlistGroup(1, 'New Name', ['700.HK']) + console.log('updated') } main().catch(console.error) ``` @@ -217,7 +219,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/quote/pull/broker-ids.md b/docs/en/docs/quote/pull/broker-ids.md index c404e913..47c690f4 100644 --- a/docs/en/docs/quote/pull/broker-ids.md +++ b/docs/en/docs/quote/pull/broker-ids.md @@ -62,8 +62,8 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) diff --git a/docs/en/docs/quote/pull/brokers.md b/docs/en/docs/quote/pull/brokers.md index 3925e65c..70a7c243 100644 --- a/docs/en/docs/quote/pull/brokers.md +++ b/docs/en/docs/quote/pull/brokers.md @@ -78,12 +78,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.brokers("700.HK") + const resp = await ctx.brokers('700.HK') console.log(resp.toString()) } main().catch(console.error) diff --git a/docs/en/docs/quote/pull/calc-index.md b/docs/en/docs/quote/pull/calc-index.md index 028aacf4..5f8e67ff 100644 --- a/docs/en/docs/quote/pull/calc-index.md +++ b/docs/en/docs/quote/pull/calc-index.md @@ -82,12 +82,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, CalcIndex } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.calcIndexes(["700.HK", "AAPL.US"], [CalcIndex.LastDone, CalcIndex.ChangeRate]) + const resp = await ctx.calcIndexes(['700.HK', 'AAPL.US'], [CalcIndex.LastDone, CalcIndex.ChangeRate]) console.log(resp) } main().catch(console.error) diff --git a/docs/en/docs/quote/pull/candlestick.md b/docs/en/docs/quote/pull/candlestick.md index 63b495c3..68582eab 100644 --- a/docs/en/docs/quote/pull/candlestick.md +++ b/docs/en/docs/quote/pull/candlestick.md @@ -32,12 +32,12 @@ longbridge kline NVDA.US --period day --count 20 ### Parameters -| Name | Type | Required | Description | -| ------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------- | -| symbol | string | Yes | Security code, in `ticker.region` format, for example:`700.HK` | -| period | int32 | Yes | Candlestick period, for example: `1000`, see [Period](../objects#period---candlestick-period) | -| count | int32 | Yes | Count of cancdlestick, for example: `100`

**Check rules:**
maximum count is `1000` | -| adjust_type | int32 | Yes | Adjustment type, for example: `0`, see [AdjustType](../objects#adjusttype---candlestick-adjustment-type) | +| Name | Type | Required | Description | +| ------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| symbol | string | Yes | Security code, in `ticker.region` format, for example:`700.HK` | +| period | int32 | Yes | Candlestick period, for example: `1000`, see [Period](../objects#period---candlestick-period) | +| count | int32 | Yes | Count of cancdlestick, for example: `100`

**Check rules:**
maximum count is `1000` | +| adjust_type | int32 | Yes | Adjustment type, for example: `0`, see [AdjustType](../objects#adjusttype---candlestick-adjustment-type) | | trade_session | int32 | No | Trading session, 0: intraday, 100: All (pre, intraday, post, overnight)

Note: Overnight data requires purchasing the "LV1 Real-time Quote (OpenAPI)" quote card. US stocks only. | ### Protobuf @@ -102,10 +102,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, Period, AdjustType, TradeSessions } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.candlesticks("700.HK", Period.Day, 10, AdjustType.NoAdjust, TradeSessions.Intraday) + const resp = await ctx.candlesticks('700.HK', Period.Day, 10, AdjustType.NoAdjust, TradeSessions.Intraday) console.log(resp) } main().catch(console.error) @@ -239,7 +241,6 @@ func main() { - ## Response ### Response Properties diff --git a/docs/en/docs/quote/pull/capital-distribution.md b/docs/en/docs/quote/pull/capital-distribution.md index fb5a13b1..5a937bb2 100644 --- a/docs/en/docs/quote/pull/capital-distribution.md +++ b/docs/en/docs/quote/pull/capital-distribution.md @@ -80,12 +80,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.capitalDistribution("700.HK") + const resp = await ctx.capitalDistribution('700.HK') console.log(resp) } main().catch(console.error) diff --git a/docs/en/docs/quote/pull/capital-flow-intraday.md b/docs/en/docs/quote/pull/capital-flow-intraday.md index d478abb5..65b57a58 100644 --- a/docs/en/docs/quote/pull/capital-flow-intraday.md +++ b/docs/en/docs/quote/pull/capital-flow-intraday.md @@ -80,12 +80,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.capitalFlow("700.HK") + const resp = await ctx.capitalFlow('700.HK') console.log(resp) } main().catch(console.error) diff --git a/docs/en/docs/quote/pull/depth.md b/docs/en/docs/quote/pull/depth.md index fbd27922..60346dde 100644 --- a/docs/en/docs/quote/pull/depth.md +++ b/docs/en/docs/quote/pull/depth.md @@ -82,12 +82,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.depth("700.HK") + const resp = await ctx.depth('700.HK') console.log(resp.toString()) } main().catch(console.error) diff --git a/docs/en/docs/quote/pull/filings.md b/docs/en/docs/quote/pull/filings.md index 7f331fe6..e6bc7a89 100644 --- a/docs/en/docs/quote/pull/filings.md +++ b/docs/en/docs/quote/pull/filings.md @@ -34,8 +34,8 @@ longbridge filing list NVDA.US ### Query Parameters -| Name | Type | Required | Description | -| ------ | ------ | -------- | --------------------------------------------------- | +| Name | Type | Required | Description | +| ------ | ------ | -------- | -------------------------------------------------------- | | symbol | string | YES | Stock symbol, use `ticker.region` format, e.g. `AAPL.US` | ### Request Example @@ -80,10 +80,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.filings("AAPL.US") + const resp = await ctx.filings('AAPL.US') console.log(resp) } main().catch(console.error) @@ -259,12 +261,12 @@ func main() { -| Name | Type | Required | Description | -| ---------------- | --------- | -------- | -------------------------------------- | -| items | object[] | true | Filings list | -| ∟ id | string | true | Filing ID | -| ∟ title | string | true | Title | -| ∟ description | string | true | Summary | -| ∟ file_name | string | true | File name | -| ∟ file_urls | string[] | true | List of file URLs | -| ∟ publish_at | string | true | Publish time, Unix timestamp (seconds) | +| Name | Type | Required | Description | +| ------------- | -------- | -------- | -------------------------------------- | +| items | object[] | true | Filings list | +| ∟ id | string | true | Filing ID | +| ∟ title | string | true | Title | +| ∟ description | string | true | Summary | +| ∟ file_name | string | true | File name | +| ∟ file_urls | string[] | true | List of file URLs | +| ∟ publish_at | string | true | Publish time, Unix timestamp (seconds) | diff --git a/docs/en/docs/quote/pull/history-candlestick.md b/docs/en/docs/quote/pull/history-candlestick.md index 28db853b..1c0787de 100644 --- a/docs/en/docs/quote/pull/history-candlestick.md +++ b/docs/en/docs/quote/pull/history-candlestick.md @@ -42,7 +42,7 @@ longbridge kline history NVDA.US --start 2025-01-01 --end 2025-12-31 | ∟ date | string | No | Query date, in `YYYYMMDD` format, for example: 20231016. Default value: latest trading day of the underlying market. | | ∟ minute | string | No | Query time, in `HHMM` format, for example: 09:35, only valid when querying minute-level data | | ∟ count | int32 | No | Count of cancdlestick, valid range:`[1,1000]`. Default value: `10` | -| trade_session | int32 | No | Trading session, 0: intraday, 100: All (pre, intraday, post, overnight)

Note: Overnight data requires purchasing the "LV1 Real-time Quote (OpenAPI)" quote card. US stocks only. | +| trade_session | int32 | No | Trading session, 0: intraday, 100: All (pre, intraday, post, overnight)

Note: Overnight data requires purchasing the "LV1 Real-time Quote (OpenAPI)" quote card. US stocks only. | ### Protobuf @@ -129,14 +129,34 @@ if __name__ == "__main__": ```javascript -const { Config, QuoteContext, OAuth, Period, AdjustType, TradeSessions, NaiveDatetime, NaiveDate, Time } = require('longbridge') +const { + Config, + QuoteContext, + OAuth, + Period, + AdjustType, + TradeSessions, + NaiveDatetime, + NaiveDate, + Time, +} = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) const datetime = new NaiveDatetime(new NaiveDate(2023, 1, 1), new Time(0, 0, 0)) - const resp = await ctx.historyCandlesticksByOffset("700.HK", Period.Day, AdjustType.NoAdjust, true, datetime, 10, TradeSessions.Intraday) + const resp = await ctx.historyCandlesticksByOffset( + '700.HK', + Period.Day, + AdjustType.NoAdjust, + true, + datetime, + 10, + TradeSessions.Intraday + ) console.log(resp) } main().catch(console.error) @@ -274,7 +294,6 @@ func main() { - ## Response ### Response Properties diff --git a/docs/en/docs/quote/pull/history-market-temp.md b/docs/en/docs/quote/pull/history-market-temp.md index deb8ffc2..88a736da 100644 --- a/docs/en/docs/quote/pull/history-market-temp.md +++ b/docs/en/docs/quote/pull/history-market-temp.md @@ -29,7 +29,7 @@ longbridge market-temp CN --history --start 2025-01-01 --end 2025-06-30 ### Parameters | Name | Type | Required | Description | -|------------|--------|----------|---------------------------------------------| +| ---------- | ------ | -------- | ------------------------------------------- | | market | string | YES | Market, currently supports US, HK, SG, CN | | start_date | string | YES | Start date, minimum to 2016, e.g.: 20240101 | | end_date | string | YES | End date, e.g.: 20250101 | @@ -76,7 +76,9 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, Market, NaiveDate } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) const resp = await ctx.historyMarketTemperature(Market.US, new NaiveDate(2024, 1, 1), new NaiveDate(2024, 1, 31)) @@ -212,7 +214,6 @@ func main() { - ## Response ### Response Headers @@ -247,7 +248,7 @@ func main() { #### Response Status | Status | Description | Schema | -|--------|-----------------|--------------------------------------------------------------------------| +| ------ | --------------- | ------------------------------------------------------------------------ | | 200 | Success | [HistoryMarketTemperatureResponse](#history_market_temperature_response) | | 400 | Parameter Error | None | @@ -261,7 +262,7 @@ func main() { | Name | Type | Required | Description | -|--------------|----------|----------|-----------------------------------------------------------------| +| ------------ | -------- | -------- | --------------------------------------------------------------- | | list | object[] | true | List | | ∟timestamp | integer | true | Timestamp | | ∟temperature | integer | true | Temperature | @@ -272,5 +273,5 @@ func main() { ## Error Codes | Business Error Code | Description | Troubleshooting Suggestions | -|---------------------|-----------------------|-------------------------------------------| +| ------------------- | --------------------- | ----------------------------------------- | | 2601500 | Server Internal Error | Please retry or contact technical support | diff --git a/docs/en/docs/quote/pull/intraday.md b/docs/en/docs/quote/pull/intraday.md index d0ab1cb3..3bdd6c6d 100644 --- a/docs/en/docs/quote/pull/intraday.md +++ b/docs/en/docs/quote/pull/intraday.md @@ -82,12 +82,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, TradeSessions } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.intraday("700.HK", TradeSessions.Intraday) + const resp = await ctx.intraday('700.HK', TradeSessions.Intraday) console.log(resp) } main().catch(console.error) diff --git a/docs/en/docs/quote/pull/issuer.md b/docs/en/docs/quote/pull/issuer.md index 1f452fab..00105ed3 100644 --- a/docs/en/docs/quote/pull/issuer.md +++ b/docs/en/docs/quote/pull/issuer.md @@ -64,8 +64,8 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) diff --git a/docs/en/docs/quote/pull/market-temp.md b/docs/en/docs/quote/pull/market-temp.md index 07b9b81e..04489206 100644 --- a/docs/en/docs/quote/pull/market-temp.md +++ b/docs/en/docs/quote/pull/market-temp.md @@ -72,8 +72,8 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, Market } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) diff --git a/docs/en/docs/quote/pull/option-quote.md b/docs/en/docs/quote/pull/option-quote.md index 4bb11db0..8fdd2103 100644 --- a/docs/en/docs/quote/pull/option-quote.md +++ b/docs/en/docs/quote/pull/option-quote.md @@ -78,12 +78,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.optionQuote(["AAPL230317P160000.US"]) + const resp = await ctx.optionQuote(['AAPL230317P160000.US']) for (const obj of resp) { console.log(obj.toString()) } diff --git a/docs/en/docs/quote/pull/optionchain-date-strike.md b/docs/en/docs/quote/pull/optionchain-date-strike.md index 3a8c2810..dd379093 100644 --- a/docs/en/docs/quote/pull/optionchain-date-strike.md +++ b/docs/en/docs/quote/pull/optionchain-date-strike.md @@ -84,12 +84,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, NaiveDate } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.optionChainInfoByDate("AAPL.US", new NaiveDate(2023, 1, 20)) + const resp = await ctx.optionChainInfoByDate('AAPL.US', new NaiveDate(2023, 1, 20)) console.log(resp) } main().catch(console.error) diff --git a/docs/en/docs/quote/pull/optionchain_date.md b/docs/en/docs/quote/pull/optionchain_date.md index 77893c92..48f705c0 100644 --- a/docs/en/docs/quote/pull/optionchain_date.md +++ b/docs/en/docs/quote/pull/optionchain_date.md @@ -80,12 +80,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.optionChainExpiryDateList("AAPL.US") + const resp = await ctx.optionChainExpiryDateList('AAPL.US') console.log(resp) } main().catch(console.error) diff --git a/docs/en/docs/quote/pull/quote.md b/docs/en/docs/quote/pull/quote.md index 95dc9b6b..e2648ec1 100644 --- a/docs/en/docs/quote/pull/quote.md +++ b/docs/en/docs/quote/pull/quote.md @@ -80,12 +80,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.quote(["700.HK", "AAPL.US", "TSLA.US", "NFLX.US"]) + const resp = await ctx.quote(['700.HK', 'AAPL.US', 'TSLA.US', 'NFLX.US']) for (const obj of resp) { console.log(obj.toString()) } @@ -237,43 +237,43 @@ func main() { ### Response Properties -| Name | Type | Description | -| ------------------- | -------- | ------------------------------------------------------------------------------------ | -| secu_quote | object[] | Securities quote | -| ∟ symbol | string | Security code | -| ∟ last_done | string | Latest price | -| ∟ prev_close | string | Yesterday's close | -| ∟ open | string | Open | -| ∟ high | string | High | -| ∟ low | string | Low | -| ∟ timestamp | int64 | Time of latest price | -| ∟ volume | int64 | Volume | -| ∟ turnover | string | Turnover | -| ∟ trade_status | int32 | Security trading status, see [TradeStatus](../objects#tradestatus---security-status) | -| ∟ pre_market_quote | object | Quote of US pre market | -| ∟∟ last_done | string | Latest price | -| ∟∟ timestamp | int64 | Time of latest price | -| ∟∟ volume | int64 | Volume | -| ∟∟ turnover | string | Turnover | -| ∟∟ high | string | High | -| ∟∟ low | string | Low | -| ∟∟ prev_close | string | Close of the last trade session | -| ∟ post_market_quote | object | Quote of US post market | -| ∟∟ last_done | string | Latest price | -| ∟∟ timestamp | int64 | Time of latest price | -| ∟∟ volume | int64 | Volume | -| ∟∟ turnover | string | Turnover | -| ∟∟ high | string | High | -| ∟∟ low | string | Low | -| ∟∟ prev_close | string | Close of the last trade session | +| Name | Type | Description | +| ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| secu_quote | object[] | Securities quote | +| ∟ symbol | string | Security code | +| ∟ last_done | string | Latest price | +| ∟ prev_close | string | Yesterday's close | +| ∟ open | string | Open | +| ∟ high | string | High | +| ∟ low | string | Low | +| ∟ timestamp | int64 | Time of latest price | +| ∟ volume | int64 | Volume | +| ∟ turnover | string | Turnover | +| ∟ trade_status | int32 | Security trading status, see [TradeStatus](../objects#tradestatus---security-status) | +| ∟ pre_market_quote | object | Quote of US pre market | +| ∟∟ last_done | string | Latest price | +| ∟∟ timestamp | int64 | Time of latest price | +| ∟∟ volume | int64 | Volume | +| ∟∟ turnover | string | Turnover | +| ∟∟ high | string | High | +| ∟∟ low | string | Low | +| ∟∟ prev_close | string | Close of the last trade session | +| ∟ post_market_quote | object | Quote of US post market | +| ∟∟ last_done | string | Latest price | +| ∟∟ timestamp | int64 | Time of latest price | +| ∟∟ volume | int64 | Volume | +| ∟∟ turnover | string | Turnover | +| ∟∟ high | string | High | +| ∟∟ low | string | Low | +| ∟∟ prev_close | string | Close of the last trade session | | ∟ over_night_quote | object | Quote of US overnight market

Note: Requires purchasing the "LV1 Real-time Quote (OpenAPI)" quote card in the Longbridge App and enabling the `enable_overnight` parameter. Returns null otherwise. | -| ∟∟ last_done | string | Latest price | -| ∟∟ timestamp | int64 | Time of latest price | -| ∟∟ volume | int64 | Volume | -| ∟∟ turnover | string | Turnover | -| ∟∟ high | string | High | -| ∟∟ low | string | Low | -| ∟∟ prev_close | string | Close of the last trade session | +| ∟∟ last_done | string | Latest price | +| ∟∟ timestamp | int64 | Time of latest price | +| ∟∟ volume | int64 | Volume | +| ∟∟ turnover | string | Turnover | +| ∟∟ high | string | High | +| ∟∟ low | string | Low | +| ∟∟ prev_close | string | Close of the last trade session | ### Protobuf diff --git a/docs/en/docs/quote/pull/static.md b/docs/en/docs/quote/pull/static.md index e5f24b05..fcbcdf89 100644 --- a/docs/en/docs/quote/pull/static.md +++ b/docs/en/docs/quote/pull/static.md @@ -80,12 +80,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.staticInfo(["700.HK", "AAPL.US", "TSLA.US", "NFLX.US"]) + const resp = await ctx.staticInfo(['700.HK', 'AAPL.US', 'TSLA.US', 'NFLX.US']) for (const obj of resp) { console.log(obj.toString()) } diff --git a/docs/en/docs/quote/pull/trade-day.md b/docs/en/docs/quote/pull/trade-day.md index dffdd603..c8645f4b 100644 --- a/docs/en/docs/quote/pull/trade-day.md +++ b/docs/en/docs/quote/pull/trade-day.md @@ -88,8 +88,8 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, Market, NaiveDate } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) diff --git a/docs/en/docs/quote/pull/trade-session.md b/docs/en/docs/quote/pull/trade-session.md index bbfbc252..ddff986e 100644 --- a/docs/en/docs/quote/pull/trade-session.md +++ b/docs/en/docs/quote/pull/trade-session.md @@ -64,8 +64,8 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) diff --git a/docs/en/docs/quote/pull/trade.md b/docs/en/docs/quote/pull/trade.md index 4848f8a3..bb3a53a2 100644 --- a/docs/en/docs/quote/pull/trade.md +++ b/docs/en/docs/quote/pull/trade.md @@ -84,12 +84,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.trades("700.HK", 10) + const resp = await ctx.trades('700.HK', 10) for (const obj of resp) { console.log(obj.toString()) } diff --git a/docs/en/docs/quote/pull/warrant-filter.md b/docs/en/docs/quote/pull/warrant-filter.md index ccad947b..99aacbd2 100644 --- a/docs/en/docs/quote/pull/warrant-filter.md +++ b/docs/en/docs/quote/pull/warrant-filter.md @@ -107,10 +107,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, WarrantSortBy, SortOrderType } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.warrantList("700.HK", WarrantSortBy.LastDone, SortOrderType.Ascending) + const resp = await ctx.warrantList('700.HK', WarrantSortBy.LastDone, SortOrderType.Ascending) console.log(resp) } main().catch(console.error) @@ -246,7 +248,6 @@ func main() { - ## Response ### Response Properties diff --git a/docs/en/docs/quote/pull/warrant-quote.md b/docs/en/docs/quote/pull/warrant-quote.md index c321c13c..fc23cd24 100644 --- a/docs/en/docs/quote/pull/warrant-quote.md +++ b/docs/en/docs/quote/pull/warrant-quote.md @@ -80,12 +80,12 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) - const resp = await ctx.warrantQuote(["21125.HK"]) + const resp = await ctx.warrantQuote(['21125.HK']) for (const obj of resp) { console.log(obj.toString()) } diff --git a/docs/en/docs/quote/security/security.md b/docs/en/docs/quote/security/security.md index 4b9b483a..1f71b902 100644 --- a/docs/en/docs/quote/security/security.md +++ b/docs/en/docs/quote/security/security.md @@ -76,7 +76,9 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth, SecurityListCategory } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) const resp = await ctx.securityList(SecurityListCategory.Overnight) @@ -213,7 +215,6 @@ func main() { - ### Response #### Response Headers diff --git a/docs/en/docs/quote/subscribe/subsciption.md b/docs/en/docs/quote/subscribe/subsciption.md index 3985f40d..6d90700c 100644 --- a/docs/en/docs/quote/subscribe/subsciption.md +++ b/docs/en/docs/quote/subscribe/subsciption.md @@ -72,7 +72,9 @@ if __name__ == "__main__": const { Config, QuoteContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = QuoteContext.new(config) const resp = await ctx.subscriptions() @@ -211,7 +213,6 @@ func main() { - ## Response ### Response Properties diff --git a/docs/en/docs/socket/_category_.json b/docs/en/docs/socket/_category_.json index f7859e03..f3fc4c62 100644 --- a/docs/en/docs/socket/_category_.json +++ b/docs/en/docs/socket/_category_.json @@ -3,5 +3,6 @@ "label": "Socket Feed", "collapsible": true, "collapsed": true, - "link": null + "link": null, + "icon": "zap" } diff --git a/docs/en/docs/trade/_category_.json b/docs/en/docs/trade/_category_.json index 532733ba..985a5b25 100644 --- a/docs/en/docs/trade/_category_.json +++ b/docs/en/docs/trade/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": true, "position": 4, - "link": null + "link": null, + "icon": "trending-up" } diff --git a/docs/en/docs/trade/asset/account.md b/docs/en/docs/trade/asset/account.md index cac7645d..687f8d64 100644 --- a/docs/en/docs/trade/asset/account.md +++ b/docs/en/docs/trade/asset/account.md @@ -75,8 +75,8 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { - console.log("Open this URL to authorize: " + url) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) diff --git a/docs/en/docs/trade/asset/cashflow.md b/docs/en/docs/trade/asset/cashflow.md index 46fe2f28..7f1d3e24 100644 --- a/docs/en/docs/trade/asset/cashflow.md +++ b/docs/en/docs/trade/asset/cashflow.md @@ -88,7 +88,9 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) const resp = await ctx.cashFlow({ startAt: new Date(2022, 4, 9), endAt: new Date(2022, 4, 12) }) @@ -238,7 +240,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/asset/fund.md b/docs/en/docs/trade/asset/fund.md index e5640304..34f35c6e 100644 --- a/docs/en/docs/trade/asset/fund.md +++ b/docs/en/docs/trade/asset/fund.md @@ -75,7 +75,9 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) const resp = await ctx.fundPositions() @@ -212,7 +214,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/asset/margin_ratio.md b/docs/en/docs/trade/asset/margin_ratio.md index a910648e..da45d632 100644 --- a/docs/en/docs/trade/asset/margin_ratio.md +++ b/docs/en/docs/trade/asset/margin_ratio.md @@ -77,10 +77,12 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - const resp = await ctx.marginRatio("700.HK") + const resp = await ctx.marginRatio('700.HK') console.log(resp) } main().catch(console.error) @@ -214,7 +216,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/asset/stock.md b/docs/en/docs/trade/asset/stock.md index 7f9e38cc..ded832b6 100644 --- a/docs/en/docs/trade/asset/stock.md +++ b/docs/en/docs/trade/asset/stock.md @@ -75,7 +75,9 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) const resp = await ctx.stockPositions() @@ -212,7 +214,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/execution/history_executions.md b/docs/en/docs/trade/execution/history_executions.md index 204b6f23..b739e503 100644 --- a/docs/en/docs/trade/execution/history_executions.md +++ b/docs/en/docs/trade/execution/history_executions.md @@ -88,7 +88,9 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) const resp = await ctx.historyExecutions({}) @@ -234,7 +236,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/execution/today_executions.md b/docs/en/docs/trade/execution/today_executions.md index d7ab9db3..3e111d41 100644 --- a/docs/en/docs/trade/execution/today_executions.md +++ b/docs/en/docs/trade/execution/today_executions.md @@ -77,7 +77,9 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) const resp = await ctx.todayExecutions({}) @@ -216,7 +218,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/order/estimate_available_buy_limit.md b/docs/en/docs/trade/order/estimate_available_buy_limit.md index 5bf74d8e..2e8fe4cb 100644 --- a/docs/en/docs/trade/order/estimate_available_buy_limit.md +++ b/docs/en/docs/trade/order/estimate_available_buy_limit.md @@ -89,10 +89,18 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth, OrderType, OrderSide, Decimal } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - const resp = await ctx.estimateMaxPurchaseQuantity({ symbol: "700.HK", orderType: OrderType.LO, side: OrderSide.Buy, price: new Decimal("400"), fractionalShares: false }) + const resp = await ctx.estimateMaxPurchaseQuantity({ + symbol: '700.HK', + orderType: OrderType.LO, + side: OrderSide.Buy, + price: new Decimal('400'), + fractionalShares: false, + }) console.log(resp) } main().catch(console.error) @@ -238,7 +246,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/order/history_orders.md b/docs/en/docs/trade/order/history_orders.md index 27112576..f8f362e0 100644 --- a/docs/en/docs/trade/order/history_orders.md +++ b/docs/en/docs/trade/order/history_orders.md @@ -97,7 +97,9 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) const resp = await ctx.historyOrders({}) @@ -237,7 +239,6 @@ func main() { - ## Response ### Response Headers @@ -335,6 +336,6 @@ func main() { | ∟ currency | string | true | Currency | | ∟ outside_rth | string | true | Enable or disable outside regular trading hours
Default is `UnknownOutsideRth` when the order is not a US stock

**Enum Value:**
`RTH_ONLY` - Regular trading hour only
`ANY_TIME` - Any time
`OVERNIGHT` - Overnight" | | ∟ remark | string | true | Remark | -| ∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level | -| ∟ monitor_price | string | true | Monitoring price | -| ∟ trigger_count | int32 | true | Number of triggers | +| ∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level | +| ∟ monitor_price | string | true | Monitoring price | +| ∟ trigger_count | int32 | true | Number of triggers | diff --git a/docs/en/docs/trade/order/order_detail.md b/docs/en/docs/trade/order/order_detail.md index cf7d964e..70d4f808 100644 --- a/docs/en/docs/trade/order/order_detail.md +++ b/docs/en/docs/trade/order/order_detail.md @@ -81,10 +81,12 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - const resp = await ctx.orderDetail("701276261045858304") + const resp = await ctx.orderDetail('701276261045858304') console.log(resp) } main().catch(console.error) @@ -218,7 +220,6 @@ func main() { - ## Response ### Response Headers @@ -379,6 +380,6 @@ Order Information | ∟∟∟ name | string | true | Charge name | | ∟∟∟ amount | string | true | Charge amount | | ∟∟∟ currency | string | true | Charge currency | -| ∟∟∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level | -| ∟∟∟ monitor_price | string | true | Monitoring price | -| ∟∟∟ trigger_count | int32 | true | Number of triggers | +| ∟∟∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level | +| ∟∟∟ monitor_price | string | true | Monitoring price | +| ∟∟∟ trigger_count | int32 | true | Number of triggers | diff --git a/docs/en/docs/trade/order/replace.md b/docs/en/docs/trade/order/replace.md index 4e88fa8c..06194ae1 100644 --- a/docs/en/docs/trade/order/replace.md +++ b/docs/en/docs/trade/order/replace.md @@ -31,19 +31,19 @@ longbridge replace 693664675163312128 --qty 200 --price 255.00 > Content-Type: application/json; charset=utf-8 -| Name | Type | Required | Description | -| ---------------- | ------ | -------- | ---------------------------------------------------------------------------------------------- | -| order_id | string | YES | Order ID | -| quantity | string | YES | Replaced quantity, example: `100` | -| price | string | NO | Replaced price, example: `388.5`

`LO` / `ELO` / `ALO` / `ODD` / `LIT` Order Required | -| trigger_price | string | NO | Trigger price, example: `388.5`

`LIT` / `MIT` Order Required | -| limit_offset | string | NO | Limit offset amount

`TSLPAMT` / `TSLPPCT` Order Required when`limit_depth_level` is set to 0 | -| trailing_amount | string | NO | Trailing amount

`TSLPAMT` Order Required | -| trailing_percent | string | NO | Trailing percent

`TSLPPCT` Order Required | -| remark | string | NO | Remark (Maximum 64 characters) | -| limit_depth_level | int32 | NO | Specifies the bid/ask depth level. `TSLPAMT` / `TSLPPCT` Order Required | -| monitor_price | string | NO | Monitoring price. `TSLPAMT` / `TSLPPCT` Order Required | -| trigger_count | int32 | NO | Number of triggers. `LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` Order Required | +| Name | Type | Required | Description | +| ----------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------ | +| order_id | string | YES | Order ID | +| quantity | string | YES | Replaced quantity, example: `100` | +| price | string | NO | Replaced price, example: `388.5`

`LO` / `ELO` / `ALO` / `ODD` / `LIT` Order Required | +| trigger_price | string | NO | Trigger price, example: `388.5`

`LIT` / `MIT` Order Required | +| limit_offset | string | NO | Limit offset amount

`TSLPAMT` / `TSLPPCT` Order Required when`limit_depth_level` is set to 0 | +| trailing_amount | string | NO | Trailing amount

`TSLPAMT` Order Required | +| trailing_percent | string | NO | Trailing percent

`TSLPPCT` Order Required | +| remark | string | NO | Remark (Maximum 64 characters) | +| limit_depth_level | int32 | NO | Specifies the bid/ask depth level. `TSLPAMT` / `TSLPPCT` Order Required | +| monitor_price | string | NO | Monitoring price. `TSLPAMT` / `TSLPPCT` Order Required | +| trigger_count | int32 | NO | Number of triggers. `LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` Order Required | ### Request Example @@ -95,11 +95,13 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth, Decimal } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - await ctx.replaceOrder({ orderId: "701276261045858304", quantity: new Decimal(400), price: new Decimal(60) }) - console.log("replaced") + await ctx.replaceOrder({ orderId: '701276261045858304', quantity: new Decimal(400), price: new Decimal(60) }) + console.log('replaced') } main().catch(console.error) ``` @@ -242,7 +244,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/order/submit.md b/docs/en/docs/trade/order/submit.md index 3ec6095b..d81527e0 100644 --- a/docs/en/docs/trade/order/submit.md +++ b/docs/en/docs/trade/order/submit.md @@ -31,24 +31,24 @@ longbridge sell TSLA.US 100 --price 260.00 > Content-Type: application/json; charset=utf-8 -| Name | Type | Required | Description | -| ------------------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| symbol | string | YES | Stock symbol, use `ticker.region` format, example: `AAPL.US` | -| order_type | string | YES | [Order Type](../trade-definition#ordertype) | -| submitted_price | string | NO | Submitted price, example: `388.5`

`LO` / `ELO` / `ALO` / `ODD` / `LIT` Order Required | -| submitted_quantity | string | YES | Submitted quantity, example: `100` | -| trigger_price | string | NO | Trigger price, example: `388.5`

`LIT` / `MIT` Order Required | -| limit_offset | string | NO | Limit offset amount

`TSLPAMT` / `TSLPPCT` Order Required when`limit_depth_level` is set to 0 | -| trailing_amount | string | NO | Trailing amount

`TSLPAMT` Order Required | -| trailing_percent | string | NO | Trailing percent

`TSLPPCT` Order Required | -| expire_date | string | NO | Long term order expire date, format `YYYY-MM-DD`, example: `2022-12-05`

Required when `time_in_force` is `GTD` | -| side | string | YES | Order Side

**Enum Value:**
`Buy`
`Sell` | -| outside_rth | string | NO | Enable or disable outside regular trading hours

**Enum Value:**
`RTH_ONLY` - regular trading hour only
`ANY_TIME` - any time
`OVERNIGHT` - Overnight | -| time_in_force | string | YES | Time in force Type

**Enum Value:**
`Day` - Day Order
`GTC` - Good Til Canceled Order
`GTD` - Good Til Date Order | -| remark | string | NO | remark (Maximum 255 characters) | +| Name | Type | Required | Description | +| ------------------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| symbol | string | YES | Stock symbol, use `ticker.region` format, example: `AAPL.US` | +| order_type | string | YES | [Order Type](../trade-definition#ordertype) | +| submitted_price | string | NO | Submitted price, example: `388.5`

`LO` / `ELO` / `ALO` / `ODD` / `LIT` Order Required | +| submitted_quantity | string | YES | Submitted quantity, example: `100` | +| trigger_price | string | NO | Trigger price, example: `388.5`

`LIT` / `MIT` Order Required | +| limit_offset | string | NO | Limit offset amount

`TSLPAMT` / `TSLPPCT` Order Required when`limit_depth_level` is set to 0 | +| trailing_amount | string | NO | Trailing amount

`TSLPAMT` Order Required | +| trailing_percent | string | NO | Trailing percent

`TSLPPCT` Order Required | +| expire_date | string | NO | Long term order expire date, format `YYYY-MM-DD`, example: `2022-12-05`

Required when `time_in_force` is `GTD` | +| side | string | YES | Order Side

**Enum Value:**
`Buy`
`Sell` | +| outside_rth | string | NO | Enable or disable outside regular trading hours

**Enum Value:**
`RTH_ONLY` - regular trading hour only
`ANY_TIME` - any time
`OVERNIGHT` - Overnight | +| time_in_force | string | YES | Time in force Type

**Enum Value:**
`Day` - Day Order
`GTC` - Good Til Canceled Order
`GTD` - Good Til Date Order | +| remark | string | NO | remark (Maximum 255 characters) | | limit_depth_level | int32 | NO | Specifies the bid/ask depth level. Value range is -5 ~ 0 ~ 5.
Negative numbers indicate bid levels (e.g., -1 means best bid level 1),
positive numbers indicate ask levels (e.g., 1 means best ask level 1).
When set to 0, the `limit_offset` parameter takes effect.
Valid for `TSLPAMT` / `TSLPPCT` orders. | -| monitor_price | string | NO | Monitoring price.
Monitoring starts only after reaching this price, updating the reference price.
Valid for `TSLPAMT` / `TSLPPCT` orders. | -| trigger_count | int32 | NO | Number of triggers. Value range is 0 ~ 3.
Specifies that within 1 minute, the order will only be placed after being triggered multiple times.
Valid for `LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` orders. | +| monitor_price | string | NO | Monitoring price.
Monitoring starts only after reaching this price, updating the reference price.
Valid for `TSLPAMT` / `TSLPPCT` orders. | +| trigger_count | int32 | NO | Number of triggers. Value range is 0 ~ 3.
Specifies that within 1 minute, the order will only be placed after being triggered multiple times.
Valid for `LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` orders. | ### Request Example @@ -100,10 +100,20 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth, OrderType, OrderSide, TimeInForceType, Decimal } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - const resp = await ctx.submitOrder({ symbol: "700.HK", orderType: OrderType.LO, side: OrderSide.Buy, submittedQuantity: new Decimal(500), timeInForce: TimeInForceType.Day, submittedPrice: new Decimal(50), remark: "Hello" }) + const resp = await ctx.submitOrder({ + symbol: '700.HK', + orderType: OrderType.LO, + side: OrderSide.Buy, + submittedQuantity: new Decimal(500), + timeInForce: TimeInForceType.Day, + submittedPrice: new Decimal(50), + remark: 'Hello', + }) console.log(resp) } main().catch(console.error) @@ -252,7 +262,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/en/docs/trade/order/today_orders.md b/docs/en/docs/trade/order/today_orders.md index cca005ea..977b3a62 100644 --- a/docs/en/docs/trade/order/today_orders.md +++ b/docs/en/docs/trade/order/today_orders.md @@ -90,7 +90,9 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) const resp = await ctx.todayOrders({}) @@ -229,7 +231,6 @@ func main() { - ## Response ### Response Headers @@ -323,6 +324,6 @@ func main() { | ∟ currency | string | true | Currency | | ∟ outside_rth | string | true | Enable or disable outside regular trading hours
Default is `UnknownOutsideRth` when the order is not a US stock

**Enum Value:**
`RTH_ONLY` - Regular trading hour only
`ANY_TIME` - Any time
`OVERNIGHT` - Overnight" | | ∟ remark | string | true | Remark | -| ∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level | -| ∟ monitor_price | string | true | Monitoring price | -| ∟ trigger_count | int32 | true | Number of triggers | +| ∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level | +| ∟ monitor_price | string | true | Monitoring price | +| ∟ trigger_count | int32 | true | Number of triggers | diff --git a/docs/en/docs/trade/order/withdraw.md b/docs/en/docs/trade/order/withdraw.md index 840836b7..01a4824b 100644 --- a/docs/en/docs/trade/order/withdraw.md +++ b/docs/en/docs/trade/order/withdraw.md @@ -75,11 +75,13 @@ if __name__ == "__main__": const { Config, TradeContext, OAuth } = require('longbridge') async function main() { - const oauth = await OAuth.build("your-client-id", (_, url) => { console.log("Open this URL to authorize: " + url) }) + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - await ctx.cancelOrder("701276261045858304") - console.log("cancelled") + await ctx.cancelOrder('701276261045858304') + console.log('cancelled') } main().catch(console.error) ``` @@ -212,7 +214,6 @@ func main() { - ## Response ### Response Headers diff --git a/docs/zh-CN/docs/cli.md b/docs/zh-CN/docs/cli.md deleted file mode 100644 index db2cf6fa..00000000 --- a/docs/zh-CN/docs/cli.md +++ /dev/null @@ -1,406 +0,0 @@ ---- -sidebar_position: 2.1 -slug: /cli -sidebar_label: CLI -sidebarCollapsed: true -id: cli -sidebar_icon: terminal ---- - -# Longbridge CLI - -Longbridge CLI 是一款 AI-native 命令行工具，覆盖全部 Longbridge Developers 端点，支持实时行情、账户管理与交易操作。专为脚本自动化、AI 代理工具调用及日常终端交易工作流设计。 - -**GitHub：** [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal) - -```bash -$ longbridge static NVDA.US -+---------+--------------------+----------+----------+----------+--------------+--------------+--------------------+--------------------+-------------------+----------------+ -| Symbol | Name (EN) | Exchange | Currency | Lot Size | Total Shares | Circ. Shares | EPS | EPS TTM | BPS | Dividend Yield | -+============================================================================================================================================================================+ -| NVDA.US | NVIDIA Corporation | NASD | USD | 1 | 24300000000 | 23501828621 | 4.9410288065843621 | 4.9410288065843621 | 6.472962962962963 | 0.04 | -+---------+--------------------+----------+----------+----------+--------------+--------------+--------------------+--------------------+-------------------+----------------+ - -$ longbridge quote TSLA.US NVDA.US --format json -[ - { - "high": "403.730", - "last": "395.560", - "low": "394.420", - "open": "396.220", - "prev_close": "391.200", - "status": "Normal", - "symbol": "TSLA.US", - "turnover": "23138752546.000", - "volume": "58068343" - }, - { - "high": "188.880", - "last": "183.220", - "low": "181.410", - "open": "182.970", - "prev_close": "180.250", - "status": "Normal", - "symbol": "NVDA.US", - "turnover": "40023702698.000", - "volume": "217307380" - } -] -``` - -## 安装 - - - - -```bash -brew install --cask longbridge/tap/longbridge-terminal -``` - - - - -```bash -curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh -``` - - - - -```powershell -scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json -``` - - - - -```powershell -iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex -``` - - - - -安装完成后，`longbridge` 二进制文件位于 `/usr/local/bin`（macOS/Linux）或 `%LOCALAPPDATA%\Programs\longbridge`（Windows），Windows 下可执行文件名为 `longbridge.exe`。 - -安装完成后，完成登录并查看可用命令： - -```bash -longbridge --help # 查看所有可用命令 -longbridge login # 通过 Device Flow 认证 — 显示验证 URL 和 Code，在任意设备上完成授权 -``` - -## 认证 - -使用 OAuth 2.0 Device Auth Flow，支持本地、SSH、无头环境： - -```bash -longbridge login # 显示验证 URL 和 Code，在任意设备或浏览器上完成授权 -longbridge logout # 清除已保存的 Token -``` - -## 可用能力 - -### 行情数据 - -```bash -longbridge quote TSLA.US 700.HK # 实时行情 -longbridge depth TSLA.US # Level 2 盘口深度 -longbridge trades TSLA.US [--count 50] # 最新逐笔成交 -longbridge kline TSLA.US [--period day] [--count 100] # K 线（OHLCV） -longbridge kline history TSLA.US --start 2024-01-01 --end 2024-12-31 # 历史 K 线 -longbridge intraday TSLA.US # 当日分时数据 -longbridge static TSLA.US # 标的静态参考信息 -longbridge calc-index TSLA.US --index pe,pb,eps # 财务指标（PE、PB、EPS 等） -longbridge capital flow TSLA.US # 当日资金流入流出时序 -longbridge capital dist TSLA.US # 资金分布快照 -longbridge market-temp [HK|US|CN|SG] # 市场情绪温度指数（0–100） -``` - -### 公司公告与文件 - -```bash -longbridge filing list AAPL.US [--count 20] # 公司公告与监管文件列表（财报、公告、SEC 申报等） -longbridge filing detail AAPL.US # 文件原文（Markdown 格式）；多文件用 --file-index N 指定附件（如 8-K Exhibit） -``` - -### 基本面与分析 - -```bash -# 财务报表（利润表、资产负债表、现金流量表） -longbridge financial-report TSLA.US -# 年度利润表 -longbridge financial-report TSLA.US --kind IS --report af -# 季度资产负债表 -longbridge financial-report TSLA.US --kind BS --report qf -# 估值快照：PE、PB、PS、股息率 + 同行对比 -longbridge valuation TSLA.US -# 历史 PE 时间序列 -longbridge valuation TSLA.US --history -# PB 历史，5 年区间 -longbridge valuation TSLA.US --history --indicator pb --range 5 -# 分析师 EPS 预测共识 -longbridge forecast-eps TSLA.US -# 收入/利润/EPS 共识（含超预期/不及预期标注） -longbridge consensus TSLA.US -# 机构评级分布与目标价共识 -longbridge institution-rating TSLA.US -# 月度评级趋势与分析师准确率 -longbridge institution-rating detail TSLA.US -# 机构股东列表（含变动追踪） -longbridge shareholder AAPL.US -# 增持机构，按持股量排序 -longbridge shareholder AAPL.US --range inc --sort owned -# 持有该标的的基金和 ETF（默认前 20） -longbridge fund-holder AAPL.US -# 全部持仓机构 -longbridge fund-holder AAPL.US --count -1 -# 历史股息记录 -longbridge dividend AAPL.US -# 股息分配方案详情 -longbridge dividend detail AAPL.US -# 即将发布的财经事件 -longbridge finance-calendar financial -# 指定标的财报日历 -longbridge finance-calendar report --symbol AAPL.US --symbol TSLA.US -# 仅高重要性宏观经济事件 -longbridge finance-calendar macrodata --star 3 -# 美股即将派息事件 -longbridge finance-calendar dividend --market US -# 全市场汇率 -longbridge exchange-rate -# 按 AUM 排名的主动基金经理（SEC 13F 数据，已排除被动指数巨头） -longbridge investors -# 仅显示前 10 名 -longbridge investors --top 10 -# 查看指定投资者的持仓（SEC CIK） -longbridge investors 0001067983 -# 内部人士交易记录（SEC Form 4） -longbridge insider-trades TSLA.US -``` - -### 社区内容 - -```bash -longbridge topic mine # 我发布的全部讨论 -longbridge topic mine --type article # 仅长文 -longbridge topic mine --type post --size 10 # 短帖，每页 10 条 -longbridge topic mine --page 2 # 翻页 -longbridge topic create --body "今天看好 700.HK" # 发短帖（纯文本） -longbridge topic create --body "NVDA GTC 看点" --tickers NVDA.US # 带关联标的 -longbridge topic create --title "我的分析" --body "$(cat post.md)" --type article # 发长文（从文件读取） -``` - -### 期权与权证 - -```bash -longbridge option quote AAPL240119C190000 # 期权实时行情 -longbridge option chain AAPL.US # 期权链（所有到期日） -longbridge option chain AAPL.US --date 2024-01-19 # 指定到期日的行权价列表 -longbridge warrant quote 12345.HK # 权证实时行情 -longbridge warrant list 700.HK # 标的关联权证列表 -``` - -### 自选股 - -```bash -longbridge watchlist # 查看自选股分组 -longbridge watchlist create "My Portfolio" # 新建分组 -longbridge watchlist update --add TSLA.US --remove AAPL.US # 添加/移除标的 -longbridge watchlist delete # 删除分组 -longbridge watchlist pin TSLA.US AAPL.US # 置顶标的 -longbridge watchlist pin --remove 700.HK # 取消置顶 -``` - -### 交易 - -```bash -longbridge orders # 当日订单，加 --history 查历史 -longbridge buy TSLA.US 100 --price 250.00 # 买入（执行前需确认） -longbridge sell TSLA.US 100 --price 260.00 # 卖出（执行前需确认） -longbridge cancel # 撤单（执行前需确认） -longbridge replace --qty 200 --price 255.00 # 改单 -longbridge assets # 账户资产概览（现金、购买力、保证金、风险等级） -longbridge portfolio # 组合损益、各市场资产分布、持仓及现金明细 -longbridge positions # 股票持仓 -longbridge fund-positions # 基金持仓 -longbridge executions # 成交记录 -``` - -### 账户结单 - -```bash -longbridge statement list # 列出最近的日结单 -longbridge statement list --type monthly # 列出月结单 -longbridge statement export --file-key --section equity_holdings # 导出某个板块为 Markdown 到终端 -longbridge statement export --file-key --section stock_trades -o trades.csv # 导出为 CSV 文件 -``` - -### 标的格式 - -``` -<代码>.<市场> 例如 TSLA.US 700.HK 600519.SH -``` - -支持市场：`HK`（香港）· `US`（美国）· `CN` / `SH` / `SZ`（A 股）· `SG`（新加坡） - -## AI 集成 - -### JSON 输出 - -所有命令支持 `--format json`，输出机器可读的结构化数据，适合 AI 代理调用和管道处理： - -```bash -longbridge quote TSLA.US --format json -longbridge positions --format json | jq '.[] | {symbol, quantity}' -``` - -### 安装 AI Skill - -安装 Longbridge Skill 后，你的 AI 助手（Claude Code、Codex、Cursor 等）就能帮你调用所有 `longbridge` 命令。安装完成后，直接用自然语言提需求，AI 会自动完成数据获取、分析和下单操作。 - -安装 Skill 后可以做的事情： - -- 跨市场选股：港股、美股、A 股、新加坡，可叠加市值、PE、技术信号等条件筛选 -- 对任意股票做技术面综合诊断——均线、MACD、KDJ、RSI、支撑压力位，覆盖日线、小时线、15 分钟线及盘前盘后数据 -- 财报深度研究：实际业绩 vs 分析师预期、各业务线营收拆解、估值指标、SEC 申报原文 -- 追踪内幕交易记录与机构持仓变化 -- 下限价单、追踪止损单、期权单——AI 展示订单详情，等你确认后才执行 -- 复盘组合盈亏：指定日期范围的 P&L 趋势、各标的贡献排行、持仓结构分析 - -```bash -npx skills add longbridge/developers -``` - -如果 Skill 没有被自动触发，可以在提问前加上 `/longbridge` 强制引用，例如：`/longbridge 查一下 AAPL 当前报价`。 - -安装后，AI 可直接从对话中查询行情、执行技术分析、管理交易： - -``` -claude> 展示 NVDA 和 TSLA 最近 5 天的表现 - -⏺ Bash(longbridge kline TSLA.US --period day --count 5 & longbridge kline NVDA.US --period day --count 5 & wait) - ⎿ +---------------------+---------+---------+---------+---------+----------+-----------------+ - | Time | Open | High | Low | Close | Volume | Turnover | - … +11 lines (ctrl+o to expand) - -⏺ TSLA 数据已加载，以下是近 5 日表现： - - TSLA.US — 近 5 日 - - ┌────────┬────────┬────────┬────────┬────────┬──────────┐ - │ 日期 │ 开盘 │ 最高 │ 最低 │ 收盘 │ 涨跌幅 │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 10 │ 402.22 │ 406.59 │ 398.19 │ 399.24 │ — │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 11 │ 402.28 │ 416.38 │ 402.15 │ 407.82 │ ▲ +2.15% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 12 │ 405.18 │ 406.50 │ 394.65 │ 395.01 │ ▼ -3.14% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 13 │ 399.17 │ 400.20 │ 389.95 │ 391.20 │ ▼ -0.96% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 16 │ 396.22 │ 403.73 │ 394.42 │ 395.56 │ ▲ +1.11% │ - └────────┴────────┴────────┴────────┴────────┴──────────┘ - - 5 日收益：-0.92% | 区间：$389.95 – $416.38 -``` - -### 财报分析示例 - -AI 可直接调用 `filings` 检索公告列表，再用 `filing-detail` 拉取原始文件，完成跨公司财报对比： - -``` -claude> 对比分析 TSLA 和 NVDA 2025 Q4 的财报数据 - -⏺ Bash(longbridge filing list TSLA.US & longbridge filing list NVDA.US & wait) - ⎿ TSLA.US 610186794100660481 10-K 2025-02-26 Annual Report FY2025 - NVDA.US 620129220687041793 8-K 2026-02-26 Q4 FY2026 Earnings Release - … +18 filings - -⏺ Bash(longbridge filing detail TSLA.US 610186794100660481 --file-index 0 & - longbridge filing detail NVDA.US 620129220687041793 --file-index 1 & wait) - ⎿ [TSLA 10-K FY2025 / NVDA 8-K Exhibit 99.1 Q4 FY2026 已加载] - -⏺ 数据来源：100% 官方公告 via Longbridge filings + filing-detail - - TSLA：10-K FY2025（filing-detail TSLA.US 610186794100660481 --file-index 0） - - NVDA：8-K Exhibit 99.1 Q4 FY2026（filing-detail NVDA.US 620129220687041793 --file-index 1） - - 一、损益表对比（全年） - - ┌────────────┬─────────────┬─────────────┬───────────┐ - │ 指标 │ TSLA FY2025 │ NVDA FY2026 │ 倍数差 │ - ├────────────┼─────────────┼─────────────┼───────────┤ - │ 总营收 │ $94,827M │ $215,938M │ NVDA 2.3x │ - │ 营收同比 │ -3% │ +65% │ — │ - │ 毛利润 │ $17,094M │ $153,463M │ NVDA 9x │ - │ 毛利率 │ 18.0% │ 71.1% │ +53 ppts │ - │ 营业利润 │ $4,355M │ $130,387M │ NVDA 30x │ - │ 营业利润率 │ 4.6% │ 60.4% │ +56 ppts │ - │ 净利润 │ $3,794M │ $120,067M │ NVDA 32x │ - │ 摊薄 EPS │ $1.08 │ $4.90 │ — │ - └────────────┴─────────────┴─────────────┴───────────┘ - - 二、现金流对比（全年） - - ┌────────────┬─────────────┬─────────────┐ - │ 指标 │ TSLA FY2025 │ NVDA FY2026 │ - ├────────────┼─────────────┼─────────────┤ - │ 经营现金流 │ $14,747M │ $102,718M │ - │ 资本支出 │ $8,527M │ $6,042M │ - │ 自由现金流 │ $6,220M │ $96,676M │ - │ FCF 利润率 │ 6.6% │ 44.8% │ - └────────────┴─────────────┴─────────────┘ - - NVDA 的 CapEx 甚至低于 TSLA，却产生了 15x 的自由现金流。 - - 三、核心风险 - - TSLA：汽车竞争加剧、品牌压力、Musk 精力分散；汽车业务同比 -10%， - 能源（+27%）和服务（+19%）部分对冲。 - NVDA：对华出口管制；Q1 FY27 指引 $78B 已排除中国数据中心收入， - 单季营收约等于 TSLA 全年。 -``` - -## 速率限制 - -Longbridge OpenAPI 最高支持每秒 10 次调用，SDK 自动刷新 OAuth Token。 - -## Release Notes - -### [v0.15.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.15.0) - -- **新增：`portfolio` 命令** — 组合总损益、各市场资产分布（美/港/A 股/新加坡/现金）、持仓及现金明细 -- **新增：`investors` 命令** — 基于 SEC 13F 数据的主动基金经理排行榜，支持按 CIK 查询指定投资者的最新持仓（含实时价格） -- **新增：`insider-trades`** — 查看任意标的的内部人士交易记录（SEC Form 4） -- **新增：`watchlist pin/unpin`** — 将标的置顶至自选股分组顶部 -- **更名并增强：`assets`** — 原 `balance` 命令更名，展示完整资产概览：净资产、购买力、保证金、风险等级及分币种现金明细 - -### [v0.14.2](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.2) - -- **新增：`--lang` 全局标志** — 为所有命令指定内容语言（`zh-CN`、`zh-HK`、`en`），优先级：`--lang` → 系统 `LANG` 环境变量 → `en` - -### [v0.14.1](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.1) - -- **新增：CN 区域登录** — `longbridge login` 支持中国大陆区域路由 -- **新增：`-v` 标志** — 快速查看版本号 - -### [v0.14.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.0) - -- **新增：Device Auth 登录** — `longbridge login` 改为 OAuth Device Flow，显示验证 URL 和 Code，在任意设备完成授权，支持 SSH 和无头环境；`--headless` 标志已移除 -- **新增：订单增强** — 支持追踪止损和 AO 订单类型；订单命令新增 `--expire-date`、`--outside-rth`、`--remark` 参数 -- **修复：Linux Segfault** — Linux 预构建二进制改为 musl，修复在部分发行版崩溃的问题 - -### [v0.13.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.13.0) - -- **新增：基本面与分析命令** — `financial-report`、`valuation`、`forecast-eps`、`consensus`、`institution-rating`、`shareholder`、`fund-holder`、`dividend`、`finance-calendar`、`exchange-rate` -- **重大变更：命令结构调整** — 19 个扁平命令迁移为子命令树（如 `news-detail` → `news detail`、`kline-history` → `kline history`、`warrant-list` → `warrant list`） -- **中国区节点支持** — 设置 `LONGBRIDGE_REGION=cn` 可路由至国内节点 - -### [v0.12.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.12.0) - -- **新增：`statement` 命令** — 列出和导出日结单/月结单 -- **TUI** — 修复 `q` 退出；自选股页面新增资讯列表与详情视图 - ---- - -完整更新日志：[github.com/longbridge/longbridge-terminal/releases](https://github.com/longbridge/longbridge-terminal/releases) diff --git a/docs/zh-CN/docs/cli/account/_category_.json b/docs/zh-CN/docs/cli/account/_category_.json new file mode 100644 index 00000000..98e7d71b --- /dev/null +++ b/docs/zh-CN/docs/cli/account/_category_.json @@ -0,0 +1 @@ +{ "label": "账户与持仓", "icon": "briefcase", "position": 7, "collapsed": true } diff --git a/docs/zh-CN/docs/cli/account/assets.md b/docs/zh-CN/docs/cli/account/assets.md new file mode 100644 index 00000000..58cb75a4 --- /dev/null +++ b/docs/zh-CN/docs/cli/account/assets.md @@ -0,0 +1,41 @@ +--- +title: 'assets' +sidebar_label: 'assets' +sidebar_position: 3 +--- + +# longbridge assets + +查看完整账户概览——净资产、购买力、保证金状态、风险等级，以及各币种的现金余额。 + +## 基本用法 + +```bash +longbridge assets +``` + +``` +| Currency | Net Assets | Total Cash | Buy Power | Max Finance | Remaining Finance | Init Margin | Maintenance Margin | Risk Level | +|----------|------------|------------|------------|-------------|-------------------|-------------|--------------------|------------| +| USD | 125422.43 | 58638.84 | 106743.46 | 410651.27 | 371985.59 | 18678.97 | 16305.97 | Safe | + +| Currency | Available Cash | Frozen Cash | Settling Cash | Withdrawable | +|----------|----------------|-------------|---------------|--------------| +| USD | -38665.68 | 332.19 | -10108.02 | -38665.68 | +| HKD | 755592.21 | 64.69 | -27760.00 | 755592.21 | +``` + +## 示例 + +### 查看账户概览 + +```bash +longbridge assets +longbridge assets --format json +``` + +以表格形式展示净资产、总现金、购买力、保证金使用情况及风险等级。 + +## 权限要求 + +需要 OAuth 账户权限。参见[账户权限设置](/zh-CN/docs/trade/)。 diff --git a/docs/zh-CN/docs/cli/account/cash-flow.md b/docs/zh-CN/docs/cli/account/cash-flow.md new file mode 100644 index 00000000..be50ae5e --- /dev/null +++ b/docs/zh-CN/docs/cli/account/cash-flow.md @@ -0,0 +1,42 @@ +--- +title: 'cash-flow' +sidebar_label: 'cash-flow' +sidebar_position: 4 +--- + +# longbridge cash-flow + +查看资金流水历史——入金、出金、股息到账、交易结算及其他账户变动。 + +## 基本用法 + +```bash +longbridge cash-flow +``` + +``` +| Flow Name | Symbol | Business Type | Balance | Currency | Time | Description | +|-----------|--------|---------------|---------|----------|------|-------------| +``` + +## 示例 + +### 查看最近 30 天的资金流水 + +```bash +longbridge cash-flow +``` + +列出过去 30 天内所有资金变动，包括流水类型、关联标的、余额、币种及时间戳。 + +### 按日期范围过滤 + +```bash +longbridge cash-flow --start 2026-01-01 --end 2026-03-31 +``` + +获取指定日期范围内的资金流水记录。适用于季度对账或税务报告。 + +## 权限要求 + +需要 OAuth 账户权限。参见[账户权限设置](/zh-CN/docs/trade/)。 diff --git a/docs/zh-CN/docs/cli/account/fund-holder.md b/docs/zh-CN/docs/cli/account/fund-holder.md new file mode 100644 index 00000000..b08611b4 --- /dev/null +++ b/docs/zh-CN/docs/cli/account/fund-holder.md @@ -0,0 +1,48 @@ +--- +title: 'fund-holder' +sidebar_label: 'fund-holder' +sidebar_position: 6 +--- + +# longbridge fund-holder + +查询持有某只股票的 ETF 和基金，以及每只基金的持仓比例和报告日期。 + +## 基本用法 + +```bash +longbridge fund-holder AAPL.US +``` + +``` +| name | symbol | currency | weight | report_date | +|----------------------------------------|---------|----------|--------|-------------| +| T-Rex 2X Long Apple Daily Target ETF | AAPX.US | USD | 67.62% | 2026.04.03 | +| Global X PureCap MSCI Infor Tech ETF | GXPT.US | USD | 19.58% | 2026.04.06 | +| AAPL 周收益 ETF - Roundhill | AAPW.US | USD | 16.76% | 2026.04.06 | +| 信息科技 ETF - Vanguard | VGT.US | USD | 15.84% | 2026.02.28 | +... +``` + +## 示例 + +### 查找持有某股票的主要 ETF + +```bash +longbridge fund-holder AAPL.US +longbridge fund-holder AAPL.US --format json +``` + +按持仓比例排序，列出对该股票敞口最大的 ETF 和基金。 + +### 获取更多持有者 + +```bash +longbridge fund-holder TSLA.US --count 50 +``` + +使用 `--count` 获取超出默认数量限制的更多结果。 + +## 权限要求 + +需要 OAuth 账户权限。参见[账户权限设置](/zh-CN/docs/trade/)。 diff --git a/docs/zh-CN/docs/cli/account/fund-positions.md b/docs/zh-CN/docs/cli/account/fund-positions.md new file mode 100644 index 00000000..9aafc649 --- /dev/null +++ b/docs/zh-CN/docs/cli/account/fund-positions.md @@ -0,0 +1,35 @@ +--- +title: 'fund-positions' +sidebar_label: 'fund-positions' +sidebar_position: 5 +--- + +# longbridge fund-positions + +列出当前持有的基金和 ETF 仓位。 + +## 基本用法 + +```bash +longbridge fund-positions +``` + +``` +| Symbol | Name | Net Asset Value | Cost Net Asset Value | Currency | Holding Units | +|--------|------|-----------------|----------------------|----------|---------------| +``` + +## 示例 + +### 查看基金/ETF 持仓 + +```bash +longbridge fund-positions +longbridge fund-positions --format json +``` + +展示账户中所有基金和 ETF 持仓，包括标的代码、数量及成本信息。 + +## 权限要求 + +需要 OAuth 账户权限。参见[账户权限设置](/zh-CN/docs/trade/)。 diff --git a/docs/zh-CN/docs/cli/account/portfolio.md b/docs/zh-CN/docs/cli/account/portfolio.md new file mode 100644 index 00000000..b76723b6 --- /dev/null +++ b/docs/zh-CN/docs/cli/account/portfolio.md @@ -0,0 +1,50 @@ +--- +title: 'portfolio' +sidebar_label: 'portfolio' +sidebar_position: 1 +--- + +# longbridge portfolio + +获取完整投资组合概览——总盈亏、总资产、各市场（美股/港股/A 股/新加坡）市值，以及现金余额。 + +## 基本用法 + +```bash +longbridge portfolio +``` + +``` +| Field | Value | +|-------------------|-----------| +| Currency | USD | +| Total Asset | 125422.43 | +| Market Cap | 66783.59 | +| Total Cash | 58638.84 | +| P/L | 140473.44 | +| Intraday P/L | 14637.05 | +| Margin Call | 0 | +| Risk Level | Safe | +| Credit Limit | 410651.27 | + +| Market | Value (USD) | % | +|--------|-------------|---------| +| US | 58659.65 | 46.76% | +| HK | 493265.25 | 393.28% | +| Cash | 58638.84 | 46.75% | +``` + +## 示例 + +### 查看投资组合摘要 + +```bash +longbridge portfolio +longbridge portfolio --format json +``` + +展示总资产价值、总盈亏及今日盈亏，以及各市场市值分布。 + +## 权限要求 + +需要 OAuth 账户权限。参见[账户权限设置](/zh-CN/docs/trade/)。 diff --git a/docs/zh-CN/docs/cli/account/positions.md b/docs/zh-CN/docs/cli/account/positions.md new file mode 100644 index 00000000..4a02127c --- /dev/null +++ b/docs/zh-CN/docs/cli/account/positions.md @@ -0,0 +1,39 @@ +--- +title: 'positions' +sidebar_label: 'positions' +sidebar_position: 2 +--- + +# longbridge positions + +列出当前股票持仓——标的代码、数量、可用数量、成本价及市场。 + +## 基本用法 + +```bash +longbridge positions +``` + +``` +| Symbol | Name | Quantity | Available | Cost Price | Currency | Market | +|---------|-----------|----------|-----------|------------|----------|--------| +| NVDA.US | NVIDIA | 101 | 101 | 50.229 | USD | US | +| MSFT.US | Microsoft | 15 | 15 | 373.310 | USD | US | +| AAPL.US | Apple | 133 | 133 | 211.589 | USD | US | +| 9988.HK | BABA-W | 500 | 500 | 95.640 | HKD | HK | +``` + +## 示例 + +### 查看所有持仓 + +```bash +longbridge positions +longbridge positions --format json +``` + +展示每笔持仓的名称、标的代码、数量、可用交易数量、成本价及市场。 + +## 权限要求 + +需要 OAuth 账户权限。参见[账户权限设置](/zh-CN/docs/trade/)。 diff --git a/docs/zh-CN/docs/cli/content/_category_.json b/docs/zh-CN/docs/cli/content/_category_.json new file mode 100644 index 00000000..eeceaeec --- /dev/null +++ b/docs/zh-CN/docs/cli/content/_category_.json @@ -0,0 +1 @@ +{ "label": "内容", "icon": "newspaper", "position": 10, "collapsed": true } diff --git a/docs/zh-CN/docs/cli/content/filing.md b/docs/zh-CN/docs/cli/content/filing.md new file mode 100644 index 00000000..7b860320 --- /dev/null +++ b/docs/zh-CN/docs/cli/content/filing.md @@ -0,0 +1,45 @@ +--- +title: 'filing' +sidebar_label: 'filing' +sidebar_position: 2 +--- + +# longbridge filing + +浏览标的的监管申报文件和披露文件。美股支持 [SEC EDGAR](https://www.sec.gov/cgi-bin/browse-edgar) 申报文件，包括 [Form 4](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40) 内幕交易、[8-K](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=8-K&dateb=&owner=include&count=40) 当期报告及 [10-K](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=10-K&dateb=&owner=include&count=40) 年报。港股返回[香港联合交易所](https://www.hkexnews.hk/)的交易所披露文件。 + +## 基本用法 + +```bash +longbridge filing TSLA.US +``` + +``` +| id | title | file_name | files | publish_at | +|--------------------|---------------------------------------|----------------------------|-------|----------------------| +| 633214836329945345 | Tesla | 4 - Tesla, Inc. (Issuer) | 4 - Tesla, Inc. (Issuer) | 1 | 2026-04-03T00:08:52Z | +| 633048285147044097 | Tesla | 8-K - Tesla, Inc. (Filer) | 8-K - Tesla, Inc. (Filer) | 2 | 2026-04-02T13:07:13Z | +| 632835137097963777 | Tesla | 4 - Tesla, Inc. (Issuer) | 4 - Tesla, Inc. (Issuer) | 1 | 2026-04-01T23:00:13Z | +... +``` + +## 示例 + +### 查看最新申报文件 + +```bash +longbridge filing TSLA.US +# 以 JSON 格式输出（便于脚本处理） +longbridge filing TSLA.US --format json +``` + +列出该标的最新申报文件，包含标题、表格类型及发布日期。JSON 输出中的 `file_urls` 字段包含申报文件的直接下载链接。 + +### 阅读完整申报内容 + +```bash +# 使用申报列表中的 id 读取完整文件 +longbridge filing detail 633214836329945345 +``` + +返回申报文件的完整文本内容。适用于提取特定披露信息，或将内容传入 AI 模型进行分析。 diff --git a/docs/zh-CN/docs/cli/content/news.md b/docs/zh-CN/docs/cli/content/news.md new file mode 100644 index 00000000..02f64998 --- /dev/null +++ b/docs/zh-CN/docs/cli/content/news.md @@ -0,0 +1,47 @@ +--- +title: 'news' +sidebar_label: 'news' +sidebar_position: 1 +--- + +# longbridge news + +获取标的的最新资讯，或通过 ID 获取文章完整内容。 + +## 基本用法 + +```bash +longbridge news TSLA.US +``` + +``` +| id | title | published_at | likes | comments | +|-----------|---------------------------------------------------------|----------------------|-------|----------| +| 282284711 | Wall Street Backs Tesla? Cathie Wood Spends Nearly $28… | 2026-04-10T03:48:22Z | 0 | 0 | +| 282276051 | In response to market rumors that "Tesla is developing… | 2026-04-10T02:16:27Z | 0 | 0 | +| 282265091 | SpaceX posted nearly $5 billion loss in 2025 | 2026-04-10T00:31:27Z | 0 | 0 | +| 282247843 | Down More Than 30% from All-Time Highs, Should You Buy… | 2026-04-09T20:46:26Z | 0 | 0 | +... +``` + +## 示例 + +### 获取股票最新资讯 + +```bash +longbridge news TSLA.US +# 获取更多文章 +longbridge news NVDA.US --count 5 +# 以 JSON 格式输出（便于脚本处理） +longbridge news TSLA.US --format json +``` + +列出该标的最新资讯，包含标题、发布时间及 URL。 + +### 获取文章完整内容 + +```bash +longbridge news detail 282276051 +``` + +通过 ID 获取单篇文章的完整 Markdown 内容。文章 ID 来自列表输出的 `id` 字段。 diff --git a/docs/zh-CN/docs/cli/content/topic.md b/docs/zh-CN/docs/cli/content/topic.md new file mode 100644 index 00000000..595137f1 --- /dev/null +++ b/docs/zh-CN/docs/cli/content/topic.md @@ -0,0 +1,67 @@ +--- +title: 'topic' +sidebar_label: 'topic' +sidebar_position: 3 +--- + +# longbridge topic + +获取 Longbridge 平台上与某标的相关的社区讨论帖子。 + +## 基本用法 + +```bash +longbridge topic TSLA.US +``` + +``` +| id | title | published_at | likes | comments | shares | +|----------|-------------------------------------------------|----------------------|-------|----------|--------| +| 39798312 | AI's Hard Limit: Compute Boom Meets a Power Cr… | 2026-04-09T11:32:03Z | 41 | 7 | 97 | +| 39816927 | Tesla is weirdly terrible. Other stocks are up… | 2026-04-09T19:54:50Z | 6 | 4 | 0 | +| 39822930 | What does everyone think about current Tesla? | 2026-04-10T04:43:49Z | 0 | 0 | 0 | +... +``` + +## 示例 + +### 查看社区讨论 + +```bash +longbridge topic TSLA.US +# 查看其他标的的讨论 +longbridge topic NVDA.US +``` + +列出与该标的相关的社区帖子，包含标题、摘要及互动数据。 + +### 阅读帖子完整内容 + +```bash +longbridge topic detail 39798312 +``` + +``` +ID: 39798312 +Type: article +Title: AI's Hard Limit: Compute Boom Meets a Power Crunch; Gas Turbines the Hidden Boss? +Tickers: ST/US/TSLA, ST/US/NVDA, ST/US/GOOG +Stats: 42 likes 7 comments 0 views +Created: 2026-04-09T11:32:03Z +URL: https://longbridge.cn/topics/39798312 + +In the prior piece on AI infrastructure, Dolphin Research argued that +the U.S. power shortfall is not a cyclical mismatch but a structural conflict +between surging AI compute and long-lagging energy and grid build-out... +``` + +使用帖子列表中的 `id` 获取任意帖子的完整正文。 + +### 筛选高互动帖子 + +```bash +# 使用 jq 过滤点赞数较高的帖子 +longbridge topic TSLA.US --format json | jq '[.[] | select(.likes_count > 10)]' +``` + +结合 `jq` 筛选讨论最热的帖子。适用于在财报或重大新闻事件前后追踪散户情绪变化。 diff --git a/docs/zh-CN/docs/cli/derivatives/_category_.json b/docs/zh-CN/docs/cli/derivatives/_category_.json new file mode 100644 index 00000000..daba5e6c --- /dev/null +++ b/docs/zh-CN/docs/cli/derivatives/_category_.json @@ -0,0 +1 @@ +{ "label": "衍生品", "icon": "layers", "position": 4, "collapsed": true } diff --git a/docs/zh-CN/docs/cli/derivatives/option.md b/docs/zh-CN/docs/cli/derivatives/option.md new file mode 100644 index 00000000..1be8a7a7 --- /dev/null +++ b/docs/zh-CN/docs/cli/derivatives/option.md @@ -0,0 +1,81 @@ +--- +title: 'option' +sidebar_label: 'option' +sidebar_position: 1 +--- + +# longbridge option + +查询美股期权合约的实时行情，或浏览任意标的的完整期权链。 + +## 基本用法 + +```bash +longbridge option chain AAPL.US +``` + +``` +| Strike | Call Symbol | Put Symbol | Standard | +|--------|----------------------|----------------------|----------| +| 180 | AAPL260406C180000.US | AAPL260406P180000.US | true | +| 185 | AAPL260406C185000.US | AAPL260406P185000.US | true | +| 190 | AAPL260406C190000.US | AAPL260406P190000.US | true | +| 195 | AAPL260406C195000.US | AAPL260406P195000.US | true | +| 200 | AAPL260406C200000.US | AAPL260406P200000.US | true | +... +``` + +## 示例 + +### 浏览股票期权链 + +不加 `--date` 时，返回 AAPL 期权所有可用的到期日。选择一个到期日后，使用 `--date` 参数查看对应的行权价列表。 + +### 查看指定到期日的行权价 + +```bash +longbridge option chain AAPL.US --date 2026-04-17 --format json +``` + +```json +[ + { "call_symbol": "AAPL260417C110000.US", "put_symbol": "AAPL260417P110000.US", "standard": "true", "strike": "110" }, + { "call_symbol": "AAPL260417C115000.US", "put_symbol": "AAPL260417P115000.US", "standard": "true", "strike": "115" }, + { "call_symbol": "AAPL260417C120000.US", "put_symbol": "AAPL260417P120000.US", "standard": "true", "strike": "120" } +] +``` + +每行展示该行权价对应的认购和认沽合约代码。从 `call_symbol` 或 `put_symbol` 复制合约代码即可获取实时行情。 + +### 获取期权合约实时行情 + +```bash +longbridge option quote AAPL260417C190000.US --format json +``` + +```json +[ + { + "symbol": "AAPL260417C190000.US", + "last": "12.35", + "bid": "12.30", + "ask": "12.40", + "open_interest": "4821", + "implied_volatility": "0.2341", + "delta": "0.4812", + "gamma": "0.0231", + "theta": "-0.0512", + "vega": "0.1843" + } +] +``` + +返回该合约的最新买卖价、最新成交价、隐含波动率及希腊值（delta、gamma、theta、vega）。 + +## 权限要求 + +`option quote` 需要期权账户及期权行情权限；`option chain` 需要一级行情权限。参见[行情订阅](/zh-CN/docs/quote/)了解权限详情。 + +## 说明 + +期权代码格式：`AAPL260417C190000.US`——标的 AAPL，到期日 2026-04-17，认购（Call），行权价 $190.00。价格部分以 $0.001 为单位，因此 190000 = $190.00。 diff --git a/docs/zh-CN/docs/cli/derivatives/warrant.md b/docs/zh-CN/docs/cli/derivatives/warrant.md new file mode 100644 index 00000000..8ae42537 --- /dev/null +++ b/docs/zh-CN/docs/cli/derivatives/warrant.md @@ -0,0 +1,106 @@ +--- +title: 'warrant' +sidebar_label: 'warrant' +sidebar_position: 2 +--- + +# longbridge warrant + +浏览港股窝轮——列出某标的的所有窝轮、获取单只窝轮的实时行情，或查询发行商信息。 + +## 基本用法 + +```bash +longbridge warrant 700.HK +``` + +``` +| Symbol | Name | Last | Leverage Ratio | Expiry | Type | +|----------|-----------------|------|----------------|------------|------| +| 24760.HK | UBTENCT@EP2606B | 0.66 | 7.65 | 2026-06-30 | Call | +| 25228.HK | GJTENCT@EP2606B | 0.65 | 7.77 | 2026-06-30 | Call | +| 24687.HK | JPTENCT@EP2606A | 0.65 | 7.77 | 2026-06-30 | Call | +| 24880.HK | CITENCT@EP2606B | 0.64 | 7.89 | 2026-06-30 | Call | +... +``` + +## 示例 + +### 列出某股票的所有窝轮 + +```bash +longbridge warrant 700.HK --format json +``` + +```json +[ + { + "expiry": "2026-06-30", + "last": "0.65", + "leverage_ratio": "7.7846153846153845", + "name": "UBTENCT@EP2606B", + "symbol": "24760.HK", + "type": "Put" + }, + { + "expiry": "2026-06-30", + "last": "0.65", + "leverage_ratio": "7.7846153846153845", + "name": "JPTENCT@EP2606A", + "symbol": "24687.HK", + "type": "Put" + }, + { + "expiry": "2026-06-30", + "last": "0.64", + "leverage_ratio": "7.90625", + "name": "GJTENCT@EP2606B", + "symbol": "25228.HK", + "type": "Put" + } +] +``` + +返回该标的所有上市窝轮，包括类型（认购/认沽）、最新价、杠杆比率及到期日。使用 `symbol` 字段可获取详细行情。 + +### 获取单只窝轮行情 + +```bash +longbridge warrant quote 24760.HK --format json +``` + +```json +[ + { + "expiry": "2026-06-30", + "implied_vol": "0.344", + "last": "0.650", + "prev_close": "0.640", + "symbol": "24760.HK", + "type": "Put" + } +] +``` + +返回包含隐含波动率、最新价及昨收价的实时行情。 + +### 查询窝轮发行商 + +```bash +longbridge warrant issuers --format json +``` + +```json +[ + { "id": "1", "name_cn": "瑞信", "name_en": "CS" }, + { "id": "3", "name_cn": "摩通", "name_en": "JP" }, + { "id": "4", "name_cn": "麦银", "name_en": "MB" }, + { "id": "8", "name_cn": "法兴", "name_en": "SG" } +] +``` + +列出港股市场所有活跃窝轮发行商及其 ID 和名称。 + +## 权限要求 + +需要窝轮行情权限。窝轮数据仅覆盖港股市场。参见[行情订阅](/zh-CN/docs/quote/)了解权限详情。 diff --git a/docs/zh-CN/docs/cli/fundamentals/_category_.json b/docs/zh-CN/docs/cli/fundamentals/_category_.json new file mode 100644 index 00000000..e50d1d96 --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/_category_.json @@ -0,0 +1 @@ +{ "label": "基本面", "icon": "book-open", "position": 5, "collapsed": true } diff --git a/docs/zh-CN/docs/cli/fundamentals/consensus.md b/docs/zh-CN/docs/cli/fundamentals/consensus.md new file mode 100644 index 00000000..cd60dcc6 --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/consensus.md @@ -0,0 +1,58 @@ +--- +title: 'consensus' +sidebar_label: 'consensus' +sidebar_position: 5 +--- + +# longbridge consensus + +查看华尔街对即将到来的财报周期的一致性财务预测——营收、EBIT 及 EPS。 + +## 基本用法 + +```bash +longbridge consensus TSLA.US +``` + +``` +Currency: USD | Period: qf +| metric | Q3 2026 | Q2 2026 | Q1 2026 | Q4 2025 | Q3 2025 | +|---------------|---------|---------|----------|-----------|----------| +| Revenue | ~27.14B | ~24.71B | ~22.75B | 24.90B ↑ | 28.09B ↑ | +| Net Income | ~1.28B | ~1.08B | ~879.54M | 840.00M ↓ | 1.37B ↓ | +| EPS | ~0.3818 | ~0.2969 | ~0.2390 | 0.2400 ↓ | 0.3900 ↓ | +... +``` + +## 示例 + +### 查看一致性预测 + +```bash +longbridge consensus TSLA.US +``` + +展示即将报告期的分析师一致性预测，涵盖营收、EBIT 及 EPS 等核心指标。 + +### JSON 输出 + +```bash +longbridge consensus TSLA.US --format json +``` + +```json +{ + "currency": "USD", + "current_period": "qf", + "list": [ + { + "details": [ + { "key": "revenue", "name": "Revenue", "estimate": "27144782630.0000", "is_released": false }, + { "key": "ebit", "name": "EBIT", "estimate": "1496709370.0000", "is_released": false } + ] + } + ] +} +``` + +每条 `details` 记录包含指标名称、一致性预测值，以及实际结果是否已发布。完整响应中的 `current_index` 标示当前所在的报告期。 diff --git a/docs/zh-CN/docs/cli/fundamentals/dividend.md b/docs/zh-CN/docs/cli/fundamentals/dividend.md new file mode 100644 index 00000000..db474961 --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/dividend.md @@ -0,0 +1,68 @@ +--- +title: 'dividend' +sidebar_label: 'dividend' +sidebar_position: 3 +--- + +# longbridge dividend + +查看股票的历史股息派发记录。 + +## 基本用法 + +```bash +longbridge dividend 700.HK +``` + +``` +| desc | ex_date | payment_date | record_date | +|--------------------------------------|------------|--------------|-------------| +| Dividend: HKD 5.3/share | 2026.05.15 | 2026.06.01 | 2026.05.18 | +| Dividend: HKD 4.5/share | 2025.05.16 | 2025.05.30 | 2025.05.19 | +| Dividend: HKD 3.4/share | 2024.05.17 | 2024.05.31 | 2024.05.20 | +| Dividend: HKD 2.4/share | 2023.05.19 | 2023.06.05 | 2023.05.22 | +``` + +## 示例 + +### 查看股息历史 + +```bash +longbridge dividend AAPL.US +``` + +列出苹果公司所有历史股息记录，包括派息日期、每股金额及股息类型。 + +### 港股股息示例 + +```bash +longbridge dividend 700.HK +``` + +同样适用于港股。腾讯定期派发股息，此命令展示完整派息历史。 + +### 查找下一个除息日 + +```bash +# ex_date 字段显示每条记录的除息日 +longbridge dividend AAPL.US +``` + +最新记录显示最后已知的除息日。对于尚未公布的未来股息，可使用 `finance-calendar` 命令并指定 `dividend` 类型查询。 + +### 查看股息分配方案详情 + +```bash +# 展示详细股息分配方案（手数、币种、比例） +longbridge dividend detail AAPL.US +``` + +`detail` 子命令展示完整的分配方案——适用于股息中同时包含红股或配股的情况。 + +### JSON 输出用于自动化 + +```bash +longbridge dividend AAPL.US --format json +``` + +返回包含 `ex_date`、`payment_date`、`record_date` 及 `desc` 字段（如 `"Dividend: USD 0.26/share"`）的结构化 JSON，适合传入脚本或跟踪工具处理。 diff --git a/docs/zh-CN/docs/cli/fundamentals/finance-calendar.md b/docs/zh-CN/docs/cli/fundamentals/finance-calendar.md new file mode 100644 index 00000000..d4d584b0 --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/finance-calendar.md @@ -0,0 +1,55 @@ +--- +title: 'finance-calendar' +sidebar_label: 'finance-calendar' +sidebar_position: 6 +--- + +# longbridge finance-calendar + +浏览即将到来的财经事件——财报发布、股息派发、IPO 及宏观经济数据发布，支持按标的、市场或事件类型过滤。 + +## 基本用法 + +```bash +longbridge finance-calendar financial --symbol TSLA.US +``` + +``` +2026.01.28 (ET) [Financials] US Tesla (TSLA.US) + Q4 FY2025 Earnings Release + EPS: Est 0.3466 / Act 0.24 | Revenue: Est $24.8B / Act $24.9B +``` + +## 示例 + +### 查看某股票的即将财报 + +```bash +longbridge finance-calendar financial --symbol TSLA.US +``` + +显示特斯拉即将到来的财报日期及分析师对 EPS 和营收的预测。使用 `--symbol` 缩小到特定股票。 + +### 查看美股今日股息事件 + +```bash +longbridge finance-calendar dividend --market US +``` + +列出所有美股今日股息相关事件（除息日、派息日）。适用于追踪哪些股票即将除息。 + +### 高重要性宏观事件 + +```bash +longbridge finance-calendar macrodata --star 3 +``` + +只显示高重要性宏观经济数据发布（三星级），涵盖 CPI、非农就业、美联储利率决议等市场重要事件。 + +### IPO 日历 + +```bash +longbridge finance-calendar ipo +``` + +显示各支持市场即将到来的 IPO。可结合 `--market` 按交易所过滤。 diff --git a/docs/zh-CN/docs/cli/fundamentals/financial-report.md b/docs/zh-CN/docs/cli/fundamentals/financial-report.md new file mode 100644 index 00000000..c5971f2c --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/financial-report.md @@ -0,0 +1,61 @@ +--- +title: 'financial-report' +sidebar_label: 'financial-report' +sidebar_position: 1 +--- + +# longbridge financial-report + +获取任意上市公司的利润表、资产负债表及现金流量表。 + +## 基本用法 + +```bash +longbridge financial-report TSLA.US --kind IS +``` + +``` +── IS ── +| metric | Q4 2025 | Q3 2025 | Q2 2025 | Q1 2025 | Q4 2024 | +|---------------------|---------|---------|---------|---------|---------| +| EPS (USD) | 0.2404 | 0.3900 | 0.3300 | 0.1200 | 0.6104 | +| ROE | 4.15% | 6.98% | 6.17% | 2.22% | 11.90% | +| Revenue (USD) | 24.90B | 28.09B | 22.50B | 19.34B | 25.71B | +| Net Income (USD) | 840.00M | 1.37B | 1.17B | 409.00M | 2.12B | +| Gross Margin | 20.12% | 17.99% | 17.24% | 16.31% | 16.26% | +| Net Margin | 3.37% | 4.89% | 5.21% | 2.12% | 8.28% | +``` + +## 示例 + +### 获取最新利润表 + +```bash +longbridge financial-report TSLA.US --kind IS +``` + +返回最新报告期的利润表，包含 EPS、营收及其他盈利项目。 + +### 获取三张报表 + +```bash +longbridge financial-report TSLA.US +``` + +同时获取利润表、资产负债表和现金流量表，等同于 `--kind ALL`。 + +### 获取现金流量表 + +```bash +longbridge financial-report TSLA.US --kind CF +``` + +返回现金流量表，涵盖经营、投资及融资活动。 + +### 年度资产负债表 + +```bash +longbridge financial-report 700.HK --kind BS --report af +``` + +获取腾讯的年度资产负债表。使用 `--report` 选择报告周期：`af`（年报）、`saf`（半年报）、`q1`、`3q` 或 `qf`（季报）。 diff --git a/docs/zh-CN/docs/cli/fundamentals/forecast-eps.md b/docs/zh-CN/docs/cli/fundamentals/forecast-eps.md new file mode 100644 index 00000000..01bc67db --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/forecast-eps.md @@ -0,0 +1,60 @@ +--- +title: 'forecast-eps' +sidebar_label: 'forecast-eps' +sidebar_position: 4 +--- + +# longbridge forecast-eps + +获取分析师对未来报告期的 EPS 一致性预测——均值、中位数、最高及最低预测值。 + +## 基本用法 + +```bash +longbridge forecast-eps TSLA.US +``` + +``` +EPS Forecasts (recent 19): +| end_date | mean | median | highest | lowest | up | down | total | +|------------|-------|--------|---------|--------|----|------|-------| +| 2026-02-03 | 2.092 | 2.04 | 2.75 | 1.212 | 0 | 0 | 0 | +| 2026-02-04 | 2.092 | 2.04 | 2.75 | 1.212 | 0 | 0 | 0 | +| 2026-02-08 | 2.057 | 2.035 | 2.75 | 1.212 | 0 | 0 | 0 | +... +``` + +## 示例 + +### 查看 EPS 预测 + +```bash +longbridge forecast-eps TSLA.US +``` + +展示每个未来报告期的分析师 EPS 一致性预测，以及预测区间（最高和最低值）。 + +### JSON 输出用于跟踪预测变化 + +```bash +longbridge forecast-eps TSLA.US --format json +``` + +```json +{ + "items": [ + { + "forecast_end_date": "1726790400", + "forecast_eps_highest": "3.79", + "forecast_eps_lowest": "2.37", + "forecast_eps_mean": "3.043", + "forecast_eps_median": "3.02", + "institution_down": 0, + "institution_total": 0, + "institution_up": 0 + } + ] +} +``` + +每条记录对应一个报告期。`forecast_eps_mean` 和 `forecast_eps_median` 代表一致性预测，`highest` 和 `lowest` 显示分析师预测区间。 diff --git a/docs/zh-CN/docs/cli/fundamentals/institution-rating.md b/docs/zh-CN/docs/cli/fundamentals/institution-rating.md new file mode 100644 index 00000000..c7610376 --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/institution-rating.md @@ -0,0 +1,80 @@ +--- +title: 'institution-rating' +sidebar_label: 'institution-rating' +sidebar_position: 2 +--- + +# longbridge institution-rating + +查看华尔街分析师的一致性评级——买入/持有/卖出分布、目标价区间及行业排名。 + +## 基本用法 + +```bash +longbridge institution-rating TSLA.US +``` + +``` +Consensus: +| recommend | target | change | updated_at | +|-----------|--------|--------|-------------| +| buy | 415.78 | 20.30% | 2026-04-09 | + +Rating breakdown: +| strong_buy | buy | hold | sell | under | no_opinion | total | +|------------|-----|------|------|-------|------------|-------| +| 18 | 5 | 17 | 6 | 2 | 4 | 52 | + +Target price range: +| lowest_price | highest_price | prev_close | +|--------------|---------------|------------| +| 125.000 | 600.000 | 345.62 | +``` + +## 示例 + +### 查看分析师一致性评级 + +```bash +longbridge institution-rating TSLA.US +``` + +展示分析师评级分布（买入、持有、卖出及细分类别）、一致性目标价区间及行业同类排名。 + +### 查看历史评级变化 + +```bash +# 展示逐周评级数量历史及各分析师目标价 +longbridge institution-rating detail TSLA.US +``` + +`detail` 子命令列出按周统计的历史评级分布及各分析师目标价，便于追踪情绪随时间的变化趋势。 + +### JSON 输出用于监控 + +```bash +longbridge institution-rating TSLA.US --format json +``` + +```json +{ + "analyst": { + "evaluate": { + "buy": 18, + "hold": 17, + "no_opinion": 4, + "over": 5, + "sell": 6, + "under": 2, + "total": 52 + }, + "target": { + "highest_price": "600.000", + "lowest_price": "125.000", + "prev_close": "345.62" + } + } +} +``` + +`evaluate` 对象包含 52 位覆盖分析师的各评级数量；`target` 对象显示最高和最低目标价，以及上一收盘价供参考。 diff --git a/docs/zh-CN/docs/cli/fundamentals/valuation.md b/docs/zh-CN/docs/cli/fundamentals/valuation.md new file mode 100644 index 00000000..fd7a50b3 --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/valuation.md @@ -0,0 +1,79 @@ +--- +title: 'valuation' +sidebar_label: 'valuation' +sidebar_position: 7 +--- + +# longbridge valuation + +分析股票当前估值（P/E、P/B、P/S、股息率），结合 5 年历史区间和行业同类对比，或追踪估值随时间的变化。 + +## 基本用法 + +```bash +longbridge valuation TSLA.US --indicator pe +``` + +``` +Overview: +| indicator | current | high | low | median | industry_median | date | +|-----------|---------|--------|-------|--------|-----------------|------------| +| PE | 341.83x | 284.01 | 51.31 | 96.85 | -0.11 | 2026-04-09 | +Current P/E 341.83, above fair range, cheaper than 8.85% of last 5 years, industry rank 19/49 + +Peers (5): +| name | pe | +|-------|--------| +| TSLA | 341.83 | +... +``` + +## 示例 + +### 当前估值快照 + +```bash +longbridge valuation TSLA.US +``` + +展示当前 P/E、P/B、P/S 及股息率，以及 5 年历史区间和当前值在区间内的位置，包含行业同类排名。 + +### 历史 P/E 走势 + +```bash +longbridge valuation TSLA.US --history --indicator pe --range 5 +``` + +返回特斯拉过去 5 年的 P/E 时间序列。使用 `--range` 设置回溯窗口：`1`、`3`、`5` 或 `10` 年。 + +### 追踪 P/B 历史变化 + +```bash +longbridge valuation 700.HK --history --indicator pb +``` + +追踪腾讯市净率的历史变化。`--history` 模式支持的指标：`pe`、`pb`、`ps`、`dvd_yld`。 + +### JSON 输出用于监控 + +```bash +# 以 JSON 格式导出历史 P/B 数据，用于脚本或监控流水线 +longbridge valuation TSLA.US --history --indicator pb --format json +``` + +```json +{ + "metrics": { + "pb": { + "desc": "current P/B 15.79, in reasonable range, cheaper than 50.31% of last 5 years, industry rank 35/49", + "high": "24.35", + "list": [ + { "timestamp": "1619841600", "value": "26.87" }, + { "timestamp": "1622520000", "value": "24.53" } + ] + } + } +} +``` + +`desc` 字段提供当前估值与历史区间及行业同类对比的可读摘要；`list` 数组包含时间序列数据点。 diff --git a/docs/zh-CN/docs/cli/index.md b/docs/zh-CN/docs/cli/index.md new file mode 100644 index 00000000..093be7dd --- /dev/null +++ b/docs/zh-CN/docs/cli/index.md @@ -0,0 +1,49 @@ +--- +title: 'Longbridge CLI' +sidebar_label: '概述' +sidebar_position: 1 +sidebar_icon: terminal +--- + +# Longbridge CLI + +Longbridge CLI（`longbridge`）是面向 Longbridge OpenAPI 全端点的 AI 原生命令行工具，覆盖实时行情、基本面数据、账户管理与交易。适用于脚本自动化、AI Agent 工具调用及日常终端工作流。 + +**GitHub：** [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal) + +## 快速开始 + +参见[安装说明](/zh-CN/docs/cli/installation)了解平台安装方式与鉴权配置。安装后可直接运行任意命令： + +```bash +# 查询实时行情 +longbridge quote TSLA.US NVDA.US + +# 查看持仓 +longbridge portfolio + +# JSON 输出（适用于脚本或 AI Agent） +longbridge quote AAPL.US --format json +``` + +## JSON 输出 + +所有命令均支持 `--format json`，输出机器可读格式，方便管道传递、`jq` 处理或 AI Agent 调用： + +```bash +longbridge positions --format json +longbridge quote TSLA.US NVDA.US --format json +``` + +## 标的代码格式 + +标的代码采用 `代码.市场` 格式： + +| 示例 | 市场 | +| ------------- | ------------------ | +| `TSLA.US` | 美股 | +| `700.HK` | 港股 | +| `600519.SH` | A 股（上交所） | +| `000568.SZ` | A 股（深交所） | +| `D05.SG` | 新加坡 | +| `BTCUSD.HAS` | 加密货币（Longbridge 专属）| diff --git a/docs/zh-CN/docs/cli/installation.md b/docs/zh-CN/docs/cli/installation.md new file mode 100644 index 00000000..e634dca5 --- /dev/null +++ b/docs/zh-CN/docs/cli/installation.md @@ -0,0 +1,80 @@ +--- +title: '安装' +sidebar_label: '安装' +sidebar_position: 2 +sidebar_icon: cpu +--- + +# 安装 + +安装 CLI 并完成 Longbridge 账户鉴权。 + +源码与发布版本：[longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal){target="_blank"} + +## 安装 + + + + +```bash +brew install --cask longbridge/tap/longbridge-terminal +``` + + + + +```bash +curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh +``` + + + + +```powershell +scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json +``` + + + + +```powershell +iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex +``` + + + + +## login + +通过 OAuth 2.0 设备授权流完成鉴权，适用于任何环境，包括 SSH 和无界面服务器。 + +```bash +longbridge login +``` + +运行 `login` 后会打印一个 URL 和短码。在任意浏览器中打开该 URL，输入短码并授权。Token 保存至 `~/.longbridge/openapi/tokens/`，后续所有命令自动复用。 + +## check + +验证 Token 有效性与 API 连通性。显示 Token 状态、缓存区域，以及全球和 CN 两端 API 的延迟。无需活跃市场交易时段。 + +```bash +longbridge check +longbridge check --format json +``` + +## update + +下载并运行官方安装脚本，将当前二进制文件替换为最新版本。 + +```bash +longbridge update +``` + +## logout + +清除已存储的 OAuth Token。下次执行命令或启动 TUI 时将重新触发鉴权。 + +```bash +longbridge logout +``` diff --git a/docs/zh-CN/docs/cli/market-data/_category_.json b/docs/zh-CN/docs/cli/market-data/_category_.json new file mode 100644 index 00000000..8f644473 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/_category_.json @@ -0,0 +1 @@ +{ "label": "行情数据", "icon": "bar-chart-2", "position": 3, "collapsed": false } diff --git a/docs/zh-CN/docs/cli/market-data/brokers.md b/docs/zh-CN/docs/cli/market-data/brokers.md new file mode 100644 index 00000000..cda3f4fa --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/brokers.md @@ -0,0 +1,52 @@ +--- +title: 'brokers' +sidebar_label: 'brokers' +sidebar_position: 3 +--- + +# longbridge brokers + +查看港股盘口各价位的券商 ID 分布，适合识别机构资金的委托流向。 + +## 基本用法 + +```bash +longbridge brokers 700.HK +``` + +``` +Symbol: 700.HK + +Ask Brokers: +| Position | Broker IDs | +|----------|---------------| +| 1 | 3014, 6409 | +| 2 | 7707, 724 | +| 3 | 1142 | + +Bid Brokers: +| Position | Broker IDs | +|----------|---------------| +| 1 | 5428, 3423 | +| 2 | 3506, 3507 | +| 3 | 4482, 4483 | +``` + +## 示例 + +### 查看券商分布 + +```bash +longbridge brokers 700.HK +longbridge brokers 700.HK --format json +``` + +显示港股盘口各价位及在该价位挂单的券商 ID。 + +## 权限要求 + +需要 Level 2 行情订阅，仅支持港股市场。详见 [行情订阅](/zh-CN/docs/quote/) 中的订阅选项。 + +## 说明 + +使用 `longbridge participants` 可按 ID 查询券商名称。`brokers` 输出中的券商 ID 与 participants 列表中的 `broker_id` 字段直接对应。 diff --git a/docs/zh-CN/docs/cli/market-data/calc-index.md b/docs/zh-CN/docs/cli/market-data/calc-index.md new file mode 100644 index 00000000..5c3588eb --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/calc-index.md @@ -0,0 +1,54 @@ +--- +title: 'calc-index' +sidebar_label: 'calc-index' +sidebar_position: 8 +--- + +# longbridge calc-index + +计算任意标的的财务指标——市盈率、市净率、股息率、换手率、期权希腊值等。 + +## 基本用法 + +```bash +longbridge calc-index TSLA.US +``` + +``` +| Symbol | PE TTM | PB | DPS Rate | Turnover Rate | Total Market Value | +|---------|--------|-------|----------|---------------|---------------------| +| TSLA.US | 341.83 | 15.79 | - | 2.21 | 1296915542310.08 | +``` + +## 示例 + +### 查看市盈率和市净率 + +```bash +longbridge calc-index TSLA.US NVDA.US --index pe pb +longbridge calc-index TSLA.US NVDA.US --index pe pb --format json +``` + +计算每个标的的指定指标。一次调用可同时请求多个标的和多个指标。JSON 输出中仅包含有数据的指标，无数据的指标会被省略。 + +### 默认指标（市盈率、市净率、股息率、换手率、市值） + +```bash +longbridge calc-index TSLA.US +``` + +省略 `--index` 时，返回默认指标集：`pe`、`pb`、`dps_rate`、`turnover_rate`、`total_market_value`。 + +### 衍生品的期权希腊值 + +```bash +longbridge calc-index 24760.HK --index delta gamma vega theta +``` + +对于期权和权证，可直接请求希腊值。输出中仅包含适用于该品种类型的指标。希腊值仅对期权/权证标的有意义——普通股票标的不会返回希腊值数据。 + +## 说明 + +支持的指标名称完整列表：`last_done`、`change_value`、`change_rate`、`volume`、`turnover`、`ytd_change_rate`、`turnover_rate`、`total_market_value`、`capital_flow`、`amplitude`、`volume_ratio`、`pe`（别名：`pe_ttm`）、`pb`、`dps_rate`（别名：`dividend_yield`）、`five_day_change_rate`、`ten_day_change_rate`、`half_year_change_rate`、`five_minutes_change_rate`、`implied_volatility`、`delta`、`gamma`、`theta`、`vega`、`rho`、`open_interest`、`expiry_date`、`strike_price`。 + +未知指标名称会被静默忽略——若预期字段在输出中缺失，请检查拼写是否正确。 diff --git a/docs/zh-CN/docs/cli/market-data/capital.md b/docs/zh-CN/docs/cli/market-data/capital.md new file mode 100644 index 00000000..b9c81bc8 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/capital.md @@ -0,0 +1,61 @@ +--- +title: 'capital' +sidebar_label: 'capital' +sidebar_position: 9 +--- + +# longbridge capital + +追踪盘中资金流向——通过 `flow` 子命令逐分钟查看大、中、小资金的流入流出，或通过 `dist` 子命令查看资金分布快照。 + +## 基本用法 + +```bash +longbridge capital flow TSLA.US +``` + +``` +| Time | Inflow | +|---------------------|----------| +| 2026-04-09 13:30:00 | 1100.46 | +| 2026-04-09 13:31:00 | 1129.09 | +| 2026-04-09 13:32:00 | 1711.27 | +| 2026-04-09 13:33:00 | 1955.54 | +| 2026-04-09 13:34:00 | 1609.27 | +... +``` + +## 示例 + +### 逐分钟追踪大资金净流入 + +```bash +longbridge capital flow TSLA.US --format json +``` + +```json +[ + { "inflow": "1100.46", "time": "2026-04-09 13:30:00" }, + { "inflow": "1129.09", "time": "2026-04-09 13:31:00" }, + { "inflow": "1711.27", "time": "2026-04-09 13:32:00" } +] +``` + +每条数据显示该分钟的净流入量。正值表示净买入，负值表示净卖出。 + +### 快照：大中小资金分布 + +```bash +longbridge capital dist TSLA.US --format json +``` + +```json +{ + "capital_in": { "large": "30160.97", "medium": "131976.32", "small": "134017.99" }, + "capital_out": { "large": "21801.89", "medium": "132803.77", "small": "124441.20" }, + "symbol": "TSLA.US", + "timestamp": "2026-04-09 20:00:00" +} +``` + +`capital_in` 按订单规模（大 / 中 / 小）显示流入该股票的总资金；`capital_out` 显示对应的资金流出。对比两者可判断大型机构资金是净买入还是净卖出。 diff --git a/docs/zh-CN/docs/cli/market-data/depth.md b/docs/zh-CN/docs/cli/market-data/depth.md new file mode 100644 index 00000000..a7ab0148 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/depth.md @@ -0,0 +1,48 @@ +--- +title: 'depth' +sidebar_label: 'depth' +sidebar_position: 2 +--- + +# longbridge depth + +查看某标的的 Level 2 盘口——买卖双方前 10 档价位的委托单数量和挂单量。 + +## 基本用法 + +```bash +longbridge depth TSLA.US +``` + +``` +Symbol: TSLA.US + +Asks (Sell): +| Position | Price | Volume | Orders | +|----------|---------|--------|--------| +| 1 | 344.990 | 200 | 3 | +| 2 | 345.000 | 500 | 8 | +| 3 | 345.010 | 300 | 4 | + +Bids (Buy): +| Position | Price | Volume | Orders | +|----------|---------|--------|--------| +| 1 | 344.980 | 400 | 6 | +| 2 | 344.970 | 600 | 9 | +| 3 | 344.960 | 250 | 3 | +``` + +## 示例 + +### 查看盘口 + +```bash +longbridge depth 700.HK +longbridge depth 700.HK --format json +``` + +显示 700.HK 当前的买卖盘档位，包括各档价格、挂单量和委托单数量。市场开盘期间每侧最多返回 10 档。 + +## 权限要求 + +需要 Level 2 行情订阅。详见 [行情订阅](/zh-CN/docs/quote/) 中的订阅选项。 diff --git a/docs/zh-CN/docs/cli/market-data/intraday.md b/docs/zh-CN/docs/cli/market-data/intraday.md new file mode 100644 index 00000000..bfb6a98e --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/intraday.md @@ -0,0 +1,62 @@ +--- +title: 'intraday' +sidebar_label: 'intraday' +sidebar_position: 5 +--- + +# longbridge intraday + +获取任意标的今日逐分钟的价格和成交量数据（分时线）。 + +## 基本用法 + +```bash +longbridge intraday TSLA.US +``` + +``` +| Time | Price | Avg Price | Volume | Turnover | +|---------------------|---------|-----------|---------|----------------| +| 2026-04-09 13:30:00 | 343.150 | 343.150 | 1234567 | 423567890.000 | +| 2026-04-09 13:31:00 | 344.200 | 343.675 | 987654 | 339876540.000 | +| 2026-04-09 13:32:00 | 343.800 | 343.717 | 876543 | 301234560.000 | +... +``` + +## 示例 + +### 查看今日分时线 + +```bash +longbridge intraday TSLA.US +longbridge intraday TSLA.US --format json +``` + +从开盘至最新一分钟，每分钟输出一条数据，包含价格、均价、成交量和成交额。 + +### 包含美股盘前和盘后数据 + +```bash +longbridge intraday AAPL.US --session all +``` + +```json +[ + { + "avg_price": "258.368439", + "price": "258.330", + "time": "2026-04-09 08:00:00", + "turnover": "97663.270", + "volume": "378" + }, + { + "avg_price": "258.382920", + "price": "258.240", + "time": "2026-04-09 08:01:00", + "turnover": "1622133.447", + "volume": "6278" + } +] +``` + +`--session all` 包含从美东时间约早上 8:00 开始的盘前数据，以及下午 4:00 之后的盘后数据。 diff --git a/docs/zh-CN/docs/cli/market-data/kline.md b/docs/zh-CN/docs/cli/market-data/kline.md new file mode 100644 index 00000000..aa37b81f --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/kline.md @@ -0,0 +1,50 @@ +--- +title: 'kline' +sidebar_label: 'kline' +sidebar_position: 6 +--- + +# longbridge kline + +获取任意标的的 K 线数据，支持多种周期和历史日期范围。 + +## 基本用法 + +```bash +longbridge kline TSLA.US --period day --count 3 +``` + +``` +| Time | Open | High | Low | Close | Volume | Turnover | +|---------------------|---------|---------|---------|---------|----------|-----------------| +| 2026-04-07 04:00:00 | 346.440 | 348.020 | 337.240 | 346.650 | 74515355 | 25563965746.000 | +| 2026-04-08 04:00:00 | 363.790 | 364.500 | 339.670 | 343.250 | 78838616 | 27457043487.000 | +| 2026-04-09 04:00:00 | 343.150 | 348.880 | 337.250 | 345.620 | 62164016 | 21375312140.000 | +``` + +## 示例 + +### 日线（最近 100 天，默认） + +```bash +longbridge kline TSLA.US +``` + +默认返回最近 100 根日线，每根包含开盘价、最高价、最低价、收盘价、成交量和成交额。 + +### 不同周期的分时 K 线 + +```bash +longbridge kline TSLA.US --period 1h --count 48 +``` + +使用 `--period` 切换粒度（如 `1m`、`5m`、`15m`、`30m`、`1h`、`day`、`week`、`month`、`year`），用 `--count` 控制返回的 K 线条数。 + +### 历史区间 + +```bash +longbridge kline TSLA.US --period day --start 2025-01-01 --end 2025-03-31 +longbridge kline TSLA.US --period day --start 2025-01-01 --end 2025-03-31 --format json +``` + +用 `--start` 和 `--end` 指定日期窗口（格式：`YYYY-MM-DD`）获取历史 K 线。JSON 输出中的 `time` 字段表示 K 线开盘时间——美股日线以 UTC 时间表示美东时间零点。 diff --git a/docs/zh-CN/docs/cli/market-data/market-temp.md b/docs/zh-CN/docs/cli/market-data/market-temp.md new file mode 100644 index 00000000..387e94cb --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/market-temp.md @@ -0,0 +1,58 @@ +--- +title: 'market-temp' +sidebar_label: 'market-temp' +sidebar_position: 10 +--- + +# longbridge market-temp + +获取 Longbridge 市场温度指数——结合估值与市场情绪的综合 0–100 情绪量表。数值越高表示市场越偏多头。 + +## 基本用法 + +```bash +longbridge market-temp US +``` + +``` +| Field | Value | +|-------------|---------------------------------------| +| Market | US | +| Temperature | 64 | +| Description | Temp Comfortable & Gradually Dropping | +| Valuation | 83 | +| Sentiment | 45 | +``` + +## 示例 + +### 查看当前市场温度 + +```bash +# 港股市场 +longbridge market-temp HK +# 美股市场 +longbridge market-temp US +# 中国 A 股 +longbridge market-temp CN +# JSON 输出，适合脚本或监控 +longbridge market-temp US --format json +``` + +支持的市场：`HK`（默认）、`US`、`CN`（别名：`SH`、`SZ`）、`SG`。不带参数运行默认为 `HK`。 + +### 历史温度趋势 + +```bash +longbridge market-temp US --history --start 2026-04-01 --end 2026-04-09 --format json +``` + +```json +[ + { "description": "", "sentiment": "70", "temperature": "67", "time": "2026-04-01 04:00:00", "valuation": "64" }, + { "description": "", "sentiment": "34", "temperature": "50", "time": "2026-04-02 04:00:00", "valuation": "67" }, + { "description": "", "sentiment": "56", "temperature": "61", "time": "2026-04-06 04:00:00", "valuation": "67" } +] +``` + +返回指定范围内每个交易日的一条记录，适合在市场事件前后对情绪变化进行可视化分析。 diff --git a/docs/zh-CN/docs/cli/market-data/participants.md b/docs/zh-CN/docs/cli/market-data/participants.md new file mode 100644 index 00000000..c5d25e87 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/participants.md @@ -0,0 +1,42 @@ +--- +title: 'participants' +sidebar_label: 'participants' +sidebar_position: 13 +--- + +# longbridge participants + +获取港股市场的完整券商/参与者目录——将券商 ID 映射到机构名称，用于解读 `brokers` 命令的输出。 + +## 基本用法 + +```bash +longbridge participants +``` + +``` +| Broker ID | Name EN | Name CN | +|------------|----------------------------------|----------------| +| 6596 | WE | 维恩证券 | +| 3014 | DRW (Hong Kong) Limited | DRW (Hong Kong) Limited | +| 7707, 7708 | Ark Securities (Hong Kong) Ltd | 同舟证券 | +| 724 | UTR8 Hong Kong Limited | UTR8 Hong Kong Limited | +| 1142 | Wanhai Securities (HK) Limited | 万海证券(香港) | +| 6409 | Standard Chartered(HK) | 渣打(香港) | +... +``` + +## 示例 + +### 查询所有券商 ID + +```bash +longbridge participants +longbridge participants --format json +``` + +返回港交所参与者的完整目录，每条包含券商 ID 及机构名称。部分机构在单个 `broker_id` 字符串中列出多个 ID。 + +## 说明 + +仅支持港股市场。配合 `longbridge brokers` 使用，可识别在各价位挂单的机构。此处的 `broker_id` 值与 `brokers` 命令返回的 ID 直接对应。 diff --git a/docs/zh-CN/docs/cli/market-data/quote.md b/docs/zh-CN/docs/cli/market-data/quote.md new file mode 100644 index 00000000..44fae2e8 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/quote.md @@ -0,0 +1,58 @@ +--- +title: 'quote' +sidebar_label: 'quote' +sidebar_position: 1 +--- + +# longbridge quote + +获取一个或多个标的代码的实时行情——价格、成交量、较前收盘的涨跌幅，以及美股的盘前盘后数据。 + +## 基本用法 + +```bash +longbridge quote TSLA.US NVDA.US +``` + +``` +| Symbol | Last | Prev Close | Open | High | Low | Volume | Turnover | Status | +|---------|---------|------------|---------|---------|---------|-----------|-----------------|--------| +| TSLA.US | 345.620 | 343.250 | 343.150 | 348.880 | 337.250 | 62164016 | 21375312140.000 | Normal | +| NVDA.US | 183.910 | 182.080 | 181.840 | 184.080 | 180.620 | 116428523 | 21303315176.000 | Normal | + +Extended Hours: +| Symbol | Session | Last | High | Low | Volume | Prev Close | Time | +|---------|---------|---------|---------|---------|---------|------------|---------------------| +| TSLA.US | Pre | 343.100 | 346.450 | 339.695 | 945393 | 343.250 | 2026-04-09 13:30:00 | +| TSLA.US | Post | 344.930 | 346.260 | 344.820 | 1348872 | 345.620 | 2026-04-09 23:59:59 | +| NVDA.US | Pre | 181.990 | 182.080 | 180.000 | 1116645 | 182.080 | 2026-04-09 13:30:00 | +| NVDA.US | Post | 183.020 | 183.950 | 182.900 | 6021581 | 183.910 | 2026-04-09 23:59:58 | +``` + +## 示例 + +### 查看单只股票 + +```bash +longbridge quote TSLA.US +``` + +显示 TSLA 的最新价、开盘价、最高价、最低价、成交量、成交额及前收盘价。 + +### 跨市场对比多个标的 + +```bash +longbridge quote TSLA.US NVDA.US 700.HK +longbridge quote TSLA.US NVDA.US 700.HK --format json +``` + +在一次调用中传入多个标的代码，可并排对比行情。支持不同市场的标的（US、HK、CN）。有盘前盘后数据时，美股输出中会包含 `pre_market_quote` 和 `post_market_quote` 字段。 + +### 获取盘前和盘后数据 + +```bash +# pre_market_quote 和 post_market_quote 字段出现在美股 JSON 输出中 +longbridge quote TSLA.US --format json +``` + +对于美股，当有盘前盘后数据时，JSON 输出中包含 `pre_market_quote` 和 `post_market_quote` 对象。在美股正常交易时段内，这两个字段为 `null`。 diff --git a/docs/zh-CN/docs/cli/market-data/security-list.md b/docs/zh-CN/docs/cli/market-data/security-list.md new file mode 100644 index 00000000..e305a1c4 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/security-list.md @@ -0,0 +1,45 @@ +--- +title: 'security-list' +sidebar_label: 'security-list' +sidebar_position: 12 +--- + +# longbridge security-list + +列出 Longbridge 支持夜盘交易的美股标的。 + +## 基本用法 + +```bash +longbridge security-list +``` + +``` +| Symbol | Name | +|----------|----------------------------| +| GDS.US | GDS | +| ZK.US | ZEEKR Intelligent Tech | +| ALTM.US | Arcadium Lithium | +| HE.US | Hawaiian Electric Inds | +| WB.US | Weibo | +... +``` + +## 示例 + +### 查看可夜盘交易的美股标的 + +```bash +# 默认（美股市场） +longbridge security-list +# 明确指定市场 +longbridge security-list US +# JSON 输出，可在下单前校验标的资格 +longbridge security-list US --format json +``` + +返回当前在 Longbridge 支持夜盘交易的美股标的完整列表。使用 `--format json` 获取机器可读列表，便于自动化资格校验。 + +## 说明 + +仅支持美股市场（Longbridge API 限制）。此列表会随资格更新而变化——请在提交夜盘委托前实时查询，勿依赖缓存数据。 diff --git a/docs/zh-CN/docs/cli/market-data/static.md b/docs/zh-CN/docs/cli/market-data/static.md new file mode 100644 index 00000000..89201b18 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/static.md @@ -0,0 +1,40 @@ +--- +title: 'static' +sidebar_label: 'static' +sidebar_position: 7 +--- + +# longbridge static + +获取任意标的的静态基本资料——名称、交易所、货币、手数、总股本、EPS、BPS 和股息率。 + +## 基本用法 + +```bash +longbridge static TSLA.US +``` + +``` +| Symbol | Name | Exchange | Currency | Lot Size | Total Shares | Circ. Shares | EPS | EPS TTM | BPS | Dividend | +|---------|-------------|----------|----------|----------|--------------|--------------|--------|---------|--------|----------| +| TSLA.US | Tesla, Inc. | NASD | USD | 1 | 3752431984 | 2812676349 | 1.0111 | 1.0111 | 21.889 | 0 | +``` + +## 示例 + +### 同时查询多个标的 + +```bash +longbridge static NVDA.US TSLA.US +longbridge static NVDA.US TSLA.US --format json +``` + +一次调用返回所有请求标的的基本资料，适合快速对比基础属性。 + +### 交易前确认标的信息 + +```bash +longbridge static 700.HK +``` + +确认标的有效，并查看其交易所、货币、手数及当前股本——下单前的便捷校验工具。 diff --git a/docs/zh-CN/docs/cli/market-data/subscriptions.md b/docs/zh-CN/docs/cli/market-data/subscriptions.md new file mode 100644 index 00000000..a756f439 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/subscriptions.md @@ -0,0 +1,38 @@ +--- +title: 'subscriptions' +sidebar_label: 'subscriptions' +sidebar_position: 14 +--- + +# longbridge subscriptions + +列出当前所有有效的实时行情订阅。 + +## 基本用法 + +```bash +longbridge subscriptions +``` + +## 示例 + +### 查看有效订阅 + +```bash +longbridge subscriptions +``` + +返回当前已订阅实时行情推送的所有标的，以及订阅类型（如 quote、depth、trades）。 + +### 排查行情推送中断问题 + +```bash +# 查看当前会话中已订阅的标的 +longbridge subscriptions +``` + +若实时行情推送中断，运行 `subscriptions` 确认该标的是否仍处于有效订阅状态。订阅与会话绑定——每次启动新会话时会重置。 + +## 说明 + +若无有效订阅，返回空列表。订阅通过 TUI 创建（或通过 OpenAPI SDK 以编程方式创建），与会话绑定，退出登录或会话过期后自动重置。 diff --git a/docs/zh-CN/docs/cli/market-data/trades.md b/docs/zh-CN/docs/cli/market-data/trades.md new file mode 100644 index 00000000..7f88dc61 --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/trades.md @@ -0,0 +1,53 @@ +--- +title: 'trades' +sidebar_label: 'trades' +sidebar_position: 4 +--- + +# longbridge trades + +获取某标的的最近逐笔成交记录，包括价格、成交量、时间和成交方向。 + +## 基本用法 + +```bash +longbridge trades TSLA.US +``` + +``` +| Time | Price | Volume | Direction | Type | +|---------------------|---------|--------|-----------|------| +| 2026-04-09 23:59:43 | 344.940 | 5 | Down | I | +| 2026-04-09 23:59:43 | 344.940 | 40 | Down | | +| 2026-04-09 23:59:44 | 344.980 | 40 | Up | | +| 2026-04-09 23:59:44 | 344.980 | 5 | Up | I | +| 2026-04-09 23:59:45 | 344.970 | 1 | Down | I | +| 2026-04-09 23:59:52 | 344.975 | 100 | Neutral | | +``` + +## 示例 + +### 查看最近 20 条成交记录 + +```bash +longbridge trades TSLA.US +``` + +返回 TSLA 最近 20 笔成交，每笔显示价格、成交量、时间戳和成交方向。 + +### 用 --count 获取更多成交记录 + +```bash +longbridge trades TSLA.US --count 50 +``` + +使用 `--count` 可在单次调用中获取最多 50 条（或更多）最近成交记录。 + +### 从成交方向判断买卖压力 + +```bash +# direction 字段显示相对于前一笔成交的方向：Up、Down 或 Neutral +longbridge trades TSLA.US --count 50 --format json +``` + +每条记录包含 `direction` 字段，表示本笔成交价格相对于前一笔是上涨、下跌还是持平，可用于判断短期动量。 diff --git a/docs/zh-CN/docs/cli/market-data/trading.md b/docs/zh-CN/docs/cli/market-data/trading.md new file mode 100644 index 00000000..1442b37d --- /dev/null +++ b/docs/zh-CN/docs/cli/market-data/trading.md @@ -0,0 +1,78 @@ +--- +title: 'trading' +sidebar_label: 'trading' +sidebar_position: 11 +--- + +# longbridge trading + +查询任意市场的交易时段安排和交易日历。 + +## 基本用法 + +```bash +longbridge trading session +``` + +``` +| Market | Session | Open | Close | +|--------|----------|----------|----------| +| US | Pre | 04:00:00 | 09:30:00 | +| US | Intraday | 09:30:00 | 16:00:00 | +| US | Post | 16:00:00 | 20:00:00 | +| HK | Intraday | 09:30:00 | 12:00:00 | +| HK | Intraday | 13:00:00 | 16:00:00 | +``` + +## 示例 + +### 查看所有市场的交易时段 + +```bash +longbridge trading session --format json +``` + +```json +[ + { + "market": "US", + "sessions": [ + { "close": "9:30:00.0", "open": "4:00:00.0", "session": "Pre" }, + { "close": "16:00:00.0", "open": "9:30:00.0", "session": "Intraday" }, + { "close": "20:00:00.0", "open": "16:00:00.0", "session": "Post" } + ] + }, + { + "market": "HK", + "sessions": [ + { "close": "12:00:00.0", "open": "9:30:00.0", "session": "Intraday" }, + { "close": "16:00:00.0", "open": "13:00:00.0", "session": "Intraday" } + ] + } +] +``` + +美股有三个交易时段（盘前、盘中、盘后）；港股有两个盘中时段，中间有午休间隔。 + +### 查询日期范围内的交易日历 + +```bash +longbridge trading days HK --start 2026-04-01 --end 2026-04-10 --format json +``` + +```json +{ + "half_trading_days": [], + "trading_days": ["2026-04-01", "2026-04-02", "2026-04-08", "2026-04-09", "2026-04-10"] +} +``` + +返回指定范围内的完整交易日列表及半日市列表，公众假期自动排除。 + +### 查看今天是否为交易日 + +```bash +longbridge trading days US +``` + +省略 `--start` 和 `--end` 返回今日交易状态。若今天是交易日，则出现在 `trading_days` 列表中。 diff --git a/docs/zh-CN/docs/cli/orders/_category_.json b/docs/zh-CN/docs/cli/orders/_category_.json new file mode 100644 index 00000000..45a94bb5 --- /dev/null +++ b/docs/zh-CN/docs/cli/orders/_category_.json @@ -0,0 +1 @@ +{ "label": "委托与交易", "icon": "arrow-right-left", "position": 8, "collapsed": true } diff --git a/docs/zh-CN/docs/cli/orders/exchange-rate.md b/docs/zh-CN/docs/cli/orders/exchange-rate.md new file mode 100644 index 00000000..a2b47846 --- /dev/null +++ b/docs/zh-CN/docs/cli/orders/exchange-rate.md @@ -0,0 +1,39 @@ +--- +title: 'exchange-rate' +sidebar_label: 'exchange-rate' +sidebar_position: 4 +--- + +# longbridge exchange-rate + +获取 Longbridge 账户中所有货币对的当前汇率。 + +## 基本用法 + +```bash +longbridge exchange-rate +``` + +``` +| pair | average_rate | bid_rate | offer_rate | +|-----------|--------------|----------|------------| +| HKD → CNH | 1.1465 | 1.1465 | 1.1465 | +| HKD → HKD | 1 | 1 | 1 | +| HKD → USD | 7.7925 | 7.7925 | 7.7925 | +| HKD → CNY | 1.1465 | 1.1465 | 1.1465 | +``` + +## 示例 + +### 查看所有汇率 + +```bash +longbridge exchange-rate +longbridge exchange-rate --format json +``` + +显示账户中所有可用货币对（如 HKD/USD、HKD/CNH）的买入价、卖出价和中间价。所有汇率以港币（HKD）为基准货币报价。 + +## 权限要求 + +无需登录，此命令无需鉴权即可使用。 diff --git a/docs/zh-CN/docs/cli/orders/margin-ratio.md b/docs/zh-CN/docs/cli/orders/margin-ratio.md new file mode 100644 index 00000000..a6d8b5a8 --- /dev/null +++ b/docs/zh-CN/docs/cli/orders/margin-ratio.md @@ -0,0 +1,48 @@ +--- +title: 'margin-ratio' +sidebar_label: 'margin-ratio' +sidebar_position: 2 +--- + +# longbridge margin-ratio + +查询某标的的保证金要求——初始保证金比率、维持保证金比率和强平比率。 + +## 基本用法 + +```bash +longbridge margin-ratio TSLA.US +``` + +``` +| Field | Value | +|--------------------------|---------| +| Symbol | TSLA.US | +| Initial Margin Ratio | 0.35 | +| Maintenance Margin Ratio | 0.33 | +| Forced Liquidation Ratio | 0.25 | +``` + +## 示例 + +### 融资买入前查看保证金要求 + +```bash +longbridge margin-ratio TSLA.US +# JSON 输出，适合脚本使用 +longbridge margin-ratio TSLA.US --format json +``` + +显示该标的的初始保证金比率、维持保证金比率和强平比率。在进行融资买入前使用，了解所需资金要求。 + +### 对比多个标的 + +```bash +longbridge margin-ratio TSLA.US NVDA.US +``` + +传入多个标的，并排对比各自的保证金要求。 + +## 权限要求 + +查询保证金比率需要 OAuth 交易或账户权限。详见 [交易权限](/zh-CN/docs/trade/) 设置说明。 diff --git a/docs/zh-CN/docs/cli/orders/max-qty.md b/docs/zh-CN/docs/cli/orders/max-qty.md new file mode 100644 index 00000000..be3eebc9 --- /dev/null +++ b/docs/zh-CN/docs/cli/orders/max-qty.md @@ -0,0 +1,47 @@ +--- +title: 'max-qty' +sidebar_label: 'max-qty' +sidebar_position: 3 +--- + +# longbridge max-qty + +根据当前账户余额和指定价格，估算最大可买入或卖出数量。 + +## 基本用法 + +```bash +longbridge max-qty TSLA.US --side buy --price 340.00 +``` + +``` +| Field | Value | +|----------------|---------| +| Symbol | TSLA.US | +| Cash Max Qty | 0 | +| Margin Max Qty | 896 | +``` + +## 示例 + +### 查询指定价格下的最大买入数量 + +```bash +longbridge max-qty TSLA.US --side buy --price 340.00 +# JSON 输出，适合脚本使用 +longbridge max-qty TSLA.US --side buy --price 340.00 --format json +``` + +返回按给定价格可买入的最大股数，分别按现金和融资购买力拆分显示。 + +### 查询最大卖出数量 + +```bash +longbridge max-qty TSLA.US --side sell +``` + +根据当前持仓返回最大可卖出股数。 + +## 权限要求 + +查询最大可委托数量需要 OAuth 交易或账户权限。详见 [交易权限](/zh-CN/docs/trade/) 设置说明。 diff --git a/docs/zh-CN/docs/cli/orders/order.md b/docs/zh-CN/docs/cli/orders/order.md new file mode 100644 index 00000000..c9dd0062 --- /dev/null +++ b/docs/zh-CN/docs/cli/orders/order.md @@ -0,0 +1,100 @@ +--- +title: 'order' +sidebar_label: 'order' +sidebar_position: 1 +--- + +# longbridge order + +查看委托记录和成交明细，或直接在终端提交买入/卖出委托。 + +## 基本用法 + +```bash +longbridge order +``` + +``` +| Order ID | Symbol | Side | Order Type | Status | Qty | Price | Exec Qty | Exec Price | Created At | +|--------------------|---------|------|------------|---------------|-----|--------|----------|------------|---------------------| +| 701276261045858304 | TSLA.US | Buy | LO | Filled | 10 | 340.00 | 10 | 339.85 | 2026-04-10 09:32:14 | +| 701276261045858305 | NVDA.US | Sell | LO | PartialFilled | 20 | 185.00 | 12 | 185.00 | 2026-04-10 09:45:01 | +| 701276261045858306 | AAPL.US | Buy | MO | New | 5 | - | 0 | - | 2026-04-10 10:01:33 | +``` + +## 示例 + +### 查看今日委托 + +```bash +longbridge order +``` + +列出今日所有委托及其状态、标的代码、数量、价格和委托 ID。 + +### 查询指定标的的历史委托 + +```bash +longbridge order --history --start 2026-01-01 --symbol TSLA.US +``` + +按标的和日期范围筛选历史委托。使用 `--start` 和 `--end` 设置日期窗口。 + +### 提交限价买入委托 + +```bash +longbridge order buy TSLA.US 10 --price 340.00 +``` + +以 340.00 美元的价格对 TSLA 提交 10 股限价买入委托。命令在提交前会提示确认。 + +### 提交限价卖出委托 + +```bash +longbridge order sell TSLA.US 5 --price 360.00 +``` + +以 360.00 美元的价格对 TSLA 提交 5 股限价卖出委托。命令在提交前会提示确认。 + +### 查看成交记录 + +```bash +longbridge order executions +``` + +列出当日所有已成交的委托，包括成交价格、数量和时间。 + +### 查看委托详情 + +```bash +# 查询指定委托的完整详情 +longbridge order detail 701276261045858304 +``` + +返回该委托的成交明细、时间戳和成交信息。 + +### 撤销待成交委托 + +```bash +# 撤单前会提示确认 +longbridge order cancel 701276261045858304 +``` + +仅接受处于可撤状态的委托（New、PartialFilled 等）。在脚本中使用 `-y` 跳过确认提示。 + +### 修改未成交委托 + +```bash +# 修改待成交委托的数量或价格 +longbridge order replace 701276261045858304 --qty 5 --price 350.00 +``` + +`--qty` 为必填项。省略 `--price` 则保持当前限价不变。在脚本中使用 `-y` 跳过确认提示。 + +## 权限要求 + +提交、撤销或修改委托需要 OAuth 交易权限。详见 [交易权限设置](/zh-CN/docs/trade/) 指南以开启交易访问。 + +## 说明 + +`buy` 和 `sell` 在提交前始终提示确认。在脚本场景中使用 `cancel` 和 `replace` 时，可加 `-y` 跳过确认。 diff --git a/docs/zh-CN/docs/cli/release-notes.md b/docs/zh-CN/docs/cli/release-notes.md new file mode 100644 index 00000000..b19d1962 --- /dev/null +++ b/docs/zh-CN/docs/cli/release-notes.md @@ -0,0 +1,45 @@ +--- +title: 'Release Notes' +sidebar_label: 'Release Notes' +sidebar_position: 100 +--- + +# Release Notes + +### [v0.15.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.15.0) + +- **新增：`portfolio` 命令** — 显示总盈亏、各市场资产分布（美股/港股/A 股/新加坡/现金）、持仓明细和现金余额 +- **新增：`investors` 命令** — 基于 SEC 13F 的活跃基金经理排行榜；通过 CIK 查看任意投资者的持仓及实时价格 +- **新增：`insider-trades`** — 任意标的的 SEC Form 4 内部人交易历史 +- **新增：`watchlist pin/unpin`** — 将证券置顶到自选股分组顶部 +- **增强：`assets`** — 从 `balance` 更名；现在显示完整资产概览：净资产、购买力、保证金、风险等级及各币种现金明细 + +### [v0.14.2](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.2) + +- **新增：`--lang` 全局参数** — 为所有命令设置内容语言（`zh-CN`、`zh-HK`、`en`）；未设置时依次回退到系统 `LANG` 环境变量，最终默认 `en` + +### [v0.14.1](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.1) + +- **新增：中国区登录** — `longbridge login` 现在支持中国区路由 +- **新增：`-v` 参数** — 无需输入完整命令即可查看版本号 + +### [v0.14.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.0) + +- **新增：设备授权登录** — `longbridge login` 改用 OAuth 设备流程；显示 URL 和授权码，可在任意设备上完成授权，支持 SSH 和无头环境；移除了 `--headless` 参数 +- **新增：订单增强** — 新增追踪止损和 AO 订单类型；订单命令新增 `--expire-date`、`--outside-rth`、`--remark` 参数 +- **修复：Linux 段错误** — 预编译 Linux 二进制文件改用 musl，修复在部分发行版上的崩溃问题 + +### [v0.13.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.13.0) + +- **新增：基本面与分析命令** — `financial-report`、`valuation`、`forecast-eps`、`consensus`、`institution-rating`、`shareholder`、`fund-holder`、`dividend`、`finance-calendar`、`exchange-rate` +- **破坏性变更：命令重构** — 19 个独立命令合并为子命令树（例如 `news-detail` → `news detail`、`kline-history` → `kline history`、`warrant-list` → `warrant list`） +- **支持中国区** — 设置 `LONGBRIDGE_REGION=cn` 以通过中国区端点路由 + +### [v0.12.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.12.0) + +- **新增：`statement` 命令** — 列出并导出日/月账户结单 +- **TUI** — 修复 `q` 退出；在自选股内新增资讯列表和详情视图 + +--- + +完整更新日志：[github.com/longbridge/longbridge-terminal/releases](https://github.com/longbridge/longbridge-terminal/releases) diff --git a/docs/zh-CN/docs/cli/research/_category_.json b/docs/zh-CN/docs/cli/research/_category_.json new file mode 100644 index 00000000..9d8812a5 --- /dev/null +++ b/docs/zh-CN/docs/cli/research/_category_.json @@ -0,0 +1 @@ +{ "label": "研究分析", "icon": "search", "position": 6, "collapsed": true } diff --git a/docs/zh-CN/docs/cli/research/insider-trades.md b/docs/zh-CN/docs/cli/research/insider-trades.md new file mode 100644 index 00000000..8adb1545 --- /dev/null +++ b/docs/zh-CN/docs/cli/research/insider-trades.md @@ -0,0 +1,49 @@ +--- +title: 'insider-trades' +sidebar_label: 'insider-trades' +sidebar_position: 2 +--- + +# longbridge insider-trades + +查看任意美股的 [SEC Form 4](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40) 内幕交易历史——公司内部人士的买入、卖出及期权行权记录。 + +## 基本用法 + +```bash +longbridge insider-trades TSLA.US +``` + +``` +| date | filer | title | type | shares | price | value | owned_after | +|------------|--------------|---------------|----------|--------|---------|----------|-------------| +| 2026-03-31 | Zhu Xiaotong | SVP | EXERCISE | 20.00K | $20.57 | $411.40K | 20.00K | +| 2025-09-11 | Zhu Xiaotong | SVP, APAC and | SELL | 20.00K | $363.75 | $7.28M | 47.60K | +| 2025-06-12 | Zhu Xiaotong | SVP, APAC | EXERCISE | 15.00K | $20.57 | $308.55K | 82.60K | +| 2025-06-12 | Zhu Xiaotong | SVP, APAC | SELL | 15.00K | $323.81 | $4.86M | 67.60K | +``` + +## 示例 + +### 查看内幕交易动态 + +```bash +longbridge insider-trades TSLA.US +longbridge insider-trades TSLA.US --format json +``` + +列出最新内幕交易记录，包含内部人士姓名、职务、交易日期、类型、股数及价格。 + +### 扩展申报历史范围 + +```bash +# 获取更多申报文件以覆盖更宽泛的日期范围 +longbridge insider-trades TSLA.US --count 100 +longbridge insider-trades AAPL.US --count 100 --format json +``` + +使用 `--count` 获取更多 Form 4 申报文件，覆盖更长时间窗口。适用于追踪财报公告前后或重大公司事件期间的内幕交易活动。 + +## 说明 + +仅限美股市场。数据来源：[SEC EDGAR Form 4 申报](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40)。 diff --git a/docs/zh-CN/docs/cli/research/investors.md b/docs/zh-CN/docs/cli/research/investors.md new file mode 100644 index 00000000..75b7a58a --- /dev/null +++ b/docs/zh-CN/docs/cli/research/investors.md @@ -0,0 +1,56 @@ +--- +title: 'investors' +sidebar_label: 'investors' +sidebar_position: 3 +--- + +# longbridge investors + +浏览按 AUM 排名的活跃机构基金经理（数据来自 [SEC 13F 申报](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=13F&dateb=&owner=include&count=40)），并深入查看任意基金经理的当前持仓。 + +## 基本用法 + +```bash +longbridge investors +``` + +``` +| # | name | AUM | period | cik | +|----|-----------------------------------|----------|-------------|------------| +| 1 | Capital International Investors | $637.97B | 31-DEC-2025 | 0001562230 | +| 2 | Capital Research Global Investors | $541.73B | 31-DEC-2025 | 0001422848 | +| 3 | CTC LLC | $404.44B | 31-DEC-2025 | 0001445893 | +| 4 | BERKSHIRE HATHAWAY INC | $274.16B | 31-DEC-2025 | 0001067983 | +| 5 | DODGE & COX | $185.26B | 31-DEC-2025 | 0000200217 | +... +``` + +## 示例 + +### 浏览顶级基金经理 + +列出按 AUM 排名的最大机构投资者，包含 CIK 标识符、名称、报告 AUM 及最新 [13F 申报](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=13F&dateb=&owner=include&count=40)的报告期。 + +### 查看基金经理持仓 + +```bash +# 使用投资者列表中的 CIK 深入查看持仓 +longbridge investors 0001067983 +longbridge investors 0001067983 --format json +``` + +``` +BERKSHIRE HATHAWAY INC (period: 2025-12-31) +Portfolio: 42 positions, total value ~$274.16B + +| company | value | shares | weight | +|-----------------------|---------|---------|--------| +| APPLE INC | $61.96B | 227.92M | 22.6% | +| AMERICAN EXPRESS CO | $56.09B | 151.61M | 20.5% | +| BANK AMERICA CORP | $28.45B | 517.30M | 10.4% | +| COCA COLA CO | $27.96B | 400.00M | 10.2% | +| CHEVRON CORP NEW | $19.84B | 130.16M | 7.2% | +... +``` + +传入 CIK 可查看该基金经理申报的完整股票持仓列表。CIK `0001067983` 为伯克希尔·哈撒韦。 diff --git a/docs/zh-CN/docs/cli/research/shareholder.md b/docs/zh-CN/docs/cli/research/shareholder.md new file mode 100644 index 00000000..23017bf2 --- /dev/null +++ b/docs/zh-CN/docs/cli/research/shareholder.md @@ -0,0 +1,36 @@ +--- +title: 'shareholder' +sidebar_label: 'shareholder' +sidebar_position: 1 +--- + +# longbridge shareholder + +查看公司主要股东——机构和个人——及其持股比例和最新持股变动。 + +## 基本用法 + +```bash +longbridge shareholder TSLA.US +``` + +``` +| shareholder | symbol | % shares | chg shares | report_date | +|------------------------------------|--------|----------|------------|-------------| +| Elon R. Musk | - | 24.86% | +423.53M | 2025-12-30 | +| The Vanguard Group, Inc. | - | 6.90% | +6.54M | 2025-12-31 | +| BlackRock, Inc. | BLK.US | 5.57% | +2.81M | 2025-12-31 | +| State Street Global Advisors, Inc. | - | 3.06% | +1.08M | 2025-12-31 | +| Geode Capital Management, LLC | - | 1.75% | +375.95K | 2025-12-31 | +``` + +## 示例 + +### 查看主要股东 + +```bash +longbridge shareholder TSLA.US +longbridge shareholder TSLA.US --format json +``` + +按持股比例列出最大股东，包括机构投资者和个人内部人士。 diff --git a/docs/zh-CN/docs/cli/tui.md b/docs/zh-CN/docs/cli/tui.md new file mode 100644 index 00000000..aee0bb25 --- /dev/null +++ b/docs/zh-CN/docs/cli/tui.md @@ -0,0 +1,39 @@ +--- +title: 'tui' +sidebar_label: 'TUI' +sidebar_position: 99 +--- + +# longbridge tui + +启动交互式全屏终端界面（TUI）——实时交易看板，包含自选股管理、实时 K 线图表、持仓视图和股票搜索。支持 Vim 风格快捷键。 + +## 基本用法 + +```bash +longbridge tui +``` + + + longbridge tui demo + + +## 示例 + +### 实时监控自选股 + +TUI 打开后展示自选股列表，实时显示价格、涨跌幅和成交量。使用 `j`/`k` 或方向键在股票间导航。 + +### 查看 K 线图表 + +在任意标的上按 `Enter` 进入股票详情页，显示实时 K 线图。使用 `1m`、`5m`、`1h`、`1d` 快捷键切换时间周期。 + +### 搜索并添加标的 + +按 `/` 打开搜索浮层，输入名称或代码即可查找并添加到自选股。 + +## 注意事项 + +- 需要有效的 `longbridge login` 登录会话 +- TUI 与 CLI 命令共用同一个 token +- 按 `q` 或 `Ctrl+C` 退出 diff --git a/docs/zh-CN/docs/cli/watchlist/_category_.json b/docs/zh-CN/docs/cli/watchlist/_category_.json new file mode 100644 index 00000000..0a134563 --- /dev/null +++ b/docs/zh-CN/docs/cli/watchlist/_category_.json @@ -0,0 +1 @@ +{ "label": "自选", "icon": "star", "position": 9, "collapsed": true } diff --git a/docs/zh-CN/docs/cli/watchlist/watchlist.md b/docs/zh-CN/docs/cli/watchlist/watchlist.md new file mode 100644 index 00000000..0a491954 --- /dev/null +++ b/docs/zh-CN/docs/cli/watchlist/watchlist.md @@ -0,0 +1,102 @@ +--- +title: 'watchlist' +sidebar_label: 'watchlist' +sidebar_position: 1 +--- + +# longbridge watchlist + +查看和管理 Longbridge 自选股——列出分组、添加或删除标的、创建新分组，以及将标的置顶。 + +## 基本用法 + +```bash +longbridge watchlist +``` + +``` +Group: all (ID: 2630) +| Symbol | Name | Market | Pinned | +|------------|------------------------------------|--------|--------| +| SPY.US | SPDR S&P 500 | US | yes | +| QQQ.US | Invesco QQQ Trust | US | yes | +| TSLA.US | Tesla | US | | +| AAPL.US | Apple | US | | +| QQQI.US | NEOS Nasdaq-100(R) High Income ETF | US | | +``` + +## 示例 + +### 查看所有自选分组及其标的 + +```bash +longbridge watchlist +``` + +```json +[ + { + "id": 2630, + "name": "all", + "securities": [ + { "is_pinned": true, "market": "US", "name": "SPDR S&P 500", "symbol": "SPY.US" }, + { "is_pinned": true, "market": "US", "name": "Invesco QQQ Trust", "symbol": "QQQ.US" }, + { "is_pinned": false, "market": "US", "name": "Tesla", "symbol": "TSLA.US" } + ] + } +] +``` + +列出所有自选分组及其 ID、名称和标的。`update`、`pin`、`delete` 子命令均需要分组 ID。 + +### 向分组添加标的 + +```bash +longbridge watchlist update 2630 --add NVDA.US --add AAPL.US +``` + +向已有分组添加一个或多个标的。先运行 `longbridge watchlist` 查找分组 ID。 + +### 从分组移除标的 + +```bash +longbridge watchlist update 2630 --remove NVDA.US --remove AAPL.US +``` + +从已有分组移除一个或多个标的。先运行 `longbridge watchlist` 确认分组 ID 及当前标的列表。 + +### 创建新自选分组 + +```bash +longbridge watchlist create "Tech Stocks" +``` + +以指定名称创建一个新的空自选分组，之后使用 `update` 添加标的。 + +### 重命名分组 + +```bash +longbridge watchlist update 2630 --name "New Name" +``` + +重命名已有自选分组。先运行 `longbridge watchlist` 查找分组 ID。 + +### 将标的置顶 + +```bash +longbridge watchlist pin 2630 TSLA.US +``` + +将标的置顶显示在自选分组顶部。已置顶的标的在输出中显示 `is_pinned: true`。对已置顶标的再次执行此命令可取消置顶。 + +### 删除分组 + +```bash +longbridge watchlist delete 2630 +``` + +永久删除自选分组及其所有标的。删除前先运行 `longbridge watchlist` 确认分组 ID。 + +## 权限要求 + +需要有效的 OAuth 登录。未登录时请先运行 `longbridge login`。 diff --git a/docs/zh-CN/docs/content/_category_.json b/docs/zh-CN/docs/content/_category_.json index 4bd04e06..abab4d85 100644 --- a/docs/zh-CN/docs/content/_category_.json +++ b/docs/zh-CN/docs/content/_category_.json @@ -1 +1,8 @@ -{ "label": "社区", "collapsible": true, "collapsed": true, "link": null, "position": 4.5 } +{ + "label": "社区", + "collapsible": true, + "collapsed": true, + "link": null, + "position": 4.5, + "icon": "newspaper" +} diff --git a/docs/zh-CN/docs/qa/_category_.json b/docs/zh-CN/docs/qa/_category_.json index ca4cc317..505ef91a 100644 --- a/docs/zh-CN/docs/qa/_category_.json +++ b/docs/zh-CN/docs/qa/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": true, "link": null, - "position": 6.5 + "position": 6.5, + "icon": "book-open" } diff --git a/docs/zh-CN/docs/quote/_category_.json b/docs/zh-CN/docs/quote/_category_.json index 4a190eb5..85c561b2 100644 --- a/docs/zh-CN/docs/quote/_category_.json +++ b/docs/zh-CN/docs/quote/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": false, "link": null, - "position": 3 + "position": 3, + "icon": "bar-chart-2" } diff --git a/docs/zh-CN/docs/socket/_category_.json b/docs/zh-CN/docs/socket/_category_.json index 0f0353ad..c8cfebd8 100644 --- a/docs/zh-CN/docs/socket/_category_.json +++ b/docs/zh-CN/docs/socket/_category_.json @@ -3,5 +3,6 @@ "label": "Socket 实时推送", "collapsible": true, "collapsed": true, - "link": null + "link": null, + "icon": "zap" } diff --git a/docs/zh-CN/docs/trade/_category_.json b/docs/zh-CN/docs/trade/_category_.json index 0cf4aee6..5257d9a3 100644 --- a/docs/zh-CN/docs/trade/_category_.json +++ b/docs/zh-CN/docs/trade/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": false, "position": 4, - "link": null + "link": null, + "icon": "trending-up" } diff --git a/docs/zh-HK/docs/cli.md b/docs/zh-HK/docs/cli.md deleted file mode 100644 index 4d344328..00000000 --- a/docs/zh-HK/docs/cli.md +++ /dev/null @@ -1,406 +0,0 @@ ---- -sidebar_position: 2.1 -slug: /cli -sidebar_label: CLI -sidebarCollapsed: true -id: cli -sidebar_icon: terminal ---- - -# Longbridge CLI - -Longbridge CLI 是一款 AI-native 命令列工具，涵蓋全部 Longbridge Developers 端點，支援即時行情、帳戶管理與交易操作。專為腳本自動化、AI 代理工具調用及日常終端交易工作流程設計。 - -**GitHub：** [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal) - -```bash -$ longbridge static NVDA.US -+---------+--------------------+----------+----------+----------+--------------+--------------+--------------------+--------------------+-------------------+----------------+ -| Symbol | Name (EN) | Exchange | Currency | Lot Size | Total Shares | Circ. Shares | EPS | EPS TTM | BPS | Dividend Yield | -+============================================================================================================================================================================+ -| NVDA.US | NVIDIA Corporation | NASD | USD | 1 | 24300000000 | 23501828621 | 4.9410288065843621 | 4.9410288065843621 | 6.472962962962963 | 0.04 | -+---------+--------------------+----------+----------+----------+--------------+--------------+--------------------+--------------------+-------------------+----------------+ - -$ longbridge quote TSLA.US NVDA.US --format json -[ - { - "high": "403.730", - "last": "395.560", - "low": "394.420", - "open": "396.220", - "prev_close": "391.200", - "status": "Normal", - "symbol": "TSLA.US", - "turnover": "23138752546.000", - "volume": "58068343" - }, - { - "high": "188.880", - "last": "183.220", - "low": "181.410", - "open": "182.970", - "prev_close": "180.250", - "status": "Normal", - "symbol": "NVDA.US", - "turnover": "40023702698.000", - "volume": "217307380" - } -] -``` - -## 安裝 - - - - -```bash -brew install --cask longbridge/tap/longbridge-terminal -``` - - - - -```bash -curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh -``` - - - - -```powershell -scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json -``` - - - - -```powershell -iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex -``` - - - - -安裝完成後，`longbridge` 二進位檔案位於 `/usr/local/bin`（macOS/Linux）或 `%LOCALAPPDATA%\Programs\longbridge`（Windows），Windows 下可執行檔名為 `longbridge.exe`。 - -安裝完成後，完成登入並查看可用指令： - -```bash -longbridge --help # 查看所有可用指令 -longbridge login # 透過 Device Flow 認證 — 顯示驗證 URL 和 Code，在任意裝置上完成授權 -``` - -## 認證 - -使用 OAuth 2.0 Device Auth Flow，支援本地、SSH、無頭環境： - -```bash -longbridge login # 顯示驗證 URL 和 Code，在任意裝置或瀏覽器上完成授權 -longbridge logout # 清除已儲存的 Token -``` - -## 可用能力 - -### 行情資料 - -```bash -longbridge quote TSLA.US 700.HK # 即時行情 -longbridge depth TSLA.US # Level 2 盤口深度 -longbridge trades TSLA.US [--count 50] # 最新逐筆成交 -longbridge kline TSLA.US [--period day] [--count 100] # K 線（OHLCV） -longbridge kline history TSLA.US --start 2024-01-01 --end 2024-12-31 # 歷史 K 線 -longbridge intraday TSLA.US # 當日分時資料 -longbridge static TSLA.US # 標的靜態參考資訊 -longbridge calc-index TSLA.US --index pe,pb,eps # 財務指標（PE、PB、EPS 等） -longbridge capital flow TSLA.US # 當日資金流入流出時序 -longbridge capital dist TSLA.US # 資金分佈快照 -longbridge market-temp [HK|US|CN|SG] # 市場情緒溫度指數（0–100） -``` - -### 公司公告與文件 - -```bash -longbridge filing list AAPL.US [--count 20] # 公司公告與監管文件列表（財報、公告、SEC 申報等） -longbridge filing detail AAPL.US # 文件原文（Markdown 格式）；多文件用 --file-index N 指定附件（如 8-K Exhibit） -``` - -### 基本面與分析 - -```bash -# 財務報表（利潤表、資產負債表、現金流量表） -longbridge financial-report TSLA.US -# 年度利潤表 -longbridge financial-report TSLA.US --kind IS --report af -# 季度資產負債表 -longbridge financial-report TSLA.US --kind BS --report qf -# 估值快照：PE、PB、PS、股息率 + 同業對比 -longbridge valuation TSLA.US -# 歷史 PE 時間序列 -longbridge valuation TSLA.US --history -# PB 歷史，5 年區間 -longbridge valuation TSLA.US --history --indicator pb --range 5 -# 分析師 EPS 預測共識 -longbridge forecast-eps TSLA.US -# 收入/利潤/EPS 共識（含超預期/不及預期標注） -longbridge consensus TSLA.US -# 機構評級分佈與目標價共識 -longbridge institution-rating TSLA.US -# 月度評級趨勢與分析師準確率 -longbridge institution-rating detail TSLA.US -# 機構股東列表（含變動追蹤） -longbridge shareholder AAPL.US -# 增持機構，按持股量排序 -longbridge shareholder AAPL.US --range inc --sort owned -# 持有該標的的基金和 ETF（預設前 20） -longbridge fund-holder AAPL.US -# 全部持倉機構 -longbridge fund-holder AAPL.US --count -1 -# 歷史股息記錄 -longbridge dividend AAPL.US -# 股息分配方案詳情 -longbridge dividend detail AAPL.US -# 即將發布的財經事件 -longbridge finance-calendar financial -# 指定標的財報日曆 -longbridge finance-calendar report --symbol AAPL.US --symbol TSLA.US -# 僅高重要性宏觀經濟事件 -longbridge finance-calendar macrodata --star 3 -# 美股即將派息事件 -longbridge finance-calendar dividend --market US -# 全市場匯率 -longbridge exchange-rate -# 按 AUM 排名的主動基金經理（SEC 13F 資料，已排除被動指數巨頭） -longbridge investors -# 僅顯示前 10 名 -longbridge investors --top 10 -# 查看指定投資者的持倉（SEC CIK） -longbridge investors 0001067983 -# 內部人士交易記錄（SEC Form 4） -longbridge insider-trades TSLA.US -``` - -### 社區內容 - -```bash -longbridge topic mine # 我發布的全部討論 -longbridge topic mine --type article # 僅長文 -longbridge topic mine --type post --size 10 # 短帖，每頁 10 條 -longbridge topic mine --page 2 # 翻頁 -longbridge topic create --body "今天看好 700.HK" # 發短帖（純文本） -longbridge topic create --body "NVDA GTC 看點" --tickers NVDA.US # 帶關聯標的 -longbridge topic create --title "我的分析" --body "$(cat post.md)" --type article # 發長文（從文件讀取） -``` - -### 期權與權證 - -```bash -longbridge option quote AAPL240119C190000 # 期權即時行情 -longbridge option chain AAPL.US # 期權鏈（所有到期日） -longbridge option chain AAPL.US --date 2024-01-19 # 指定到期日的行權價列表 -longbridge warrant quote 12345.HK # 權證即時行情 -longbridge warrant list 700.HK # 標的關聯權證列表 -``` - -### 自選股 - -```bash -longbridge watchlist # 查看自選股分組 -longbridge watchlist create "My Portfolio" # 新建分組 -longbridge watchlist update --add TSLA.US --remove AAPL.US # 新增/移除標的 -longbridge watchlist delete # 刪除分組 -longbridge watchlist pin TSLA.US AAPL.US # 置頂標的 -longbridge watchlist pin --remove 700.HK # 取消置頂 -``` - -### 交易 - -```bash -longbridge orders # 當日訂單，加 --history 查歷史 -longbridge buy TSLA.US 100 --price 250.00 # 買入（執行前需確認） -longbridge sell TSLA.US 100 --price 260.00 # 賣出（執行前需確認） -longbridge cancel # 撤單（執行前需確認） -longbridge replace --qty 200 --price 255.00 # 改單 -longbridge assets # 帳戶資產概覽（現金、購買力、保證金、風險等級） -longbridge portfolio # 組合損益、各市場資產分布、持倉及現金明細 -longbridge positions # 股票持倉 -longbridge fund-positions # 基金持倉 -longbridge executions # 成交記錄 -``` - -### 帳戶結單 - -```bash -longbridge statement list # 列出最近的日結單 -longbridge statement list --type monthly # 列出月結單 -longbridge statement export --file-key --section equity_holdings # 匯出某個板塊為 Markdown 到終端 -longbridge statement export --file-key --section stock_trades -o trades.csv # 匯出為 CSV 檔案 -``` - -### 標的格式 - -``` -<代碼>.<市場> 例如 TSLA.US 700.HK 600519.SH -``` - -支援市場：`HK`（香港）· `US`（美國）· `CN` / `SH` / `SZ`（A 股）· `SG`（新加坡） - -## AI 整合 - -### JSON 輸出 - -所有命令支援 `--format json`，輸出機器可讀的結構化資料，適合 AI 代理調用和管道處理： - -```bash -longbridge quote TSLA.US --format json -longbridge positions --format json | jq '.[] | {symbol, quantity}' -``` - -### 安裝 AI Skill - -安裝 Longbridge Skill 後，你的 AI 助手（Claude Code、Codex、Cursor 等）就能幫你調用所有 `longbridge` 指令。安裝完成後，直接用自然語言提需求，AI 會自動完成數據獲取、分析和下單操作。 - -安裝 Skill 後可以做的事情： - -- 跨市場選股：港股、美股、A 股、新加坡，可疊加市值、PE、技術信號等條件篩選 -- 對任意股票做技術面綜合診斷——均線、MACD、KDJ、RSI、支撐壓力位，覆蓋日線、小時線、15 分鐘線及盤前盤後數據 -- 財報深度研究：實際業績 vs 分析師預期、各業務線營收拆解、估值指標、SEC 申報原文 -- 追蹤內幕交易記錄與機構持倉變化 -- 下限價單、追蹤止損單、期權單——AI 展示訂單詳情，等你確認後才執行 -- 復盤組合盈虧：指定日期範圍的 P&L 趨勢、各標的貢獻排行、持倉結構分析 - -```bash -npx skills add longbridge/developers -``` - -如果 Skill 沒有被自動觸發，可以在提問前加上 `/longbridge` 強制引用，例如：`/longbridge 查一下 AAPL 當前報價`。 - -安裝後，AI 可直接從對話中查詢行情、執行技術分析、管理交易： - -``` -claude> 展示 NVDA 和 TSLA 最近 5 天的表現 - -⏺ Bash(longbridge kline TSLA.US --period day --count 5 & longbridge kline NVDA.US --period day --count 5 & wait) - ⎿ +---------------------+---------+---------+---------+---------+----------+-----------------+ - | Time | Open | High | Low | Close | Volume | Turnover | - … +11 lines (ctrl+o to expand) - -⏺ TSLA 資料已載入，以下是近 5 日表現： - - TSLA.US — 近 5 日 - - ┌────────┬────────┬────────┬────────┬────────┬──────────┐ - │ 日期 │ 開盤 │ 最高 │ 最低 │ 收盤 │ 漲跌幅 │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 10 │ 402.22 │ 406.59 │ 398.19 │ 399.24 │ — │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 11 │ 402.28 │ 416.38 │ 402.15 │ 407.82 │ ▲ +2.15% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 12 │ 405.18 │ 406.50 │ 394.65 │ 395.01 │ ▼ -3.14% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 13 │ 399.17 │ 400.20 │ 389.95 │ 391.20 │ ▼ -0.96% │ - ├────────┼────────┼────────┼────────┼────────┼──────────┤ - │ Mar 16 │ 396.22 │ 403.73 │ 394.42 │ 395.56 │ ▲ +1.11% │ - └────────┴────────┴────────┴────────┴────────┴──────────┘ - - 5 日收益：-0.92% | 區間：$389.95 – $416.38 -``` - -### 財報分析示例 - -AI 可直接調用 `filings` 檢索公告列表，再用 `filing-detail` 拉取原始文件，完成跨公司財報對比： - -``` -claude> 對比分析 TSLA 和 NVDA 2025 Q4 的財報數據 - -⏺ Bash(longbridge filing list TSLA.US & longbridge filing list NVDA.US & wait) - ⎿ TSLA.US 610186794100660481 10-K 2025-02-26 Annual Report FY2025 - NVDA.US 620129220687041793 8-K 2026-02-26 Q4 FY2026 Earnings Release - … +18 filings - -⏺ Bash(longbridge filing detail TSLA.US 610186794100660481 --file-index 0 & - longbridge filing detail NVDA.US 620129220687041793 --file-index 1 & wait) - ⎿ [TSLA 10-K FY2025 / NVDA 8-K Exhibit 99.1 Q4 FY2026 已載入] - -⏺ 數據來源：100% 官方公告 via Longbridge filings + filing-detail - - TSLA：10-K FY2025（filing-detail TSLA.US 610186794100660481 --file-index 0） - - NVDA：8-K Exhibit 99.1 Q4 FY2026（filing-detail NVDA.US 620129220687041793 --file-index 1） - - 一、損益表對比（全年） - - ┌────────────┬─────────────┬─────────────┬───────────┐ - │ 指標 │ TSLA FY2025 │ NVDA FY2026 │ 倍數差 │ - ├────────────┼─────────────┼─────────────┼───────────┤ - │ 總營收 │ $94,827M │ $215,938M │ NVDA 2.3x │ - │ 營收同比 │ -3% │ +65% │ — │ - │ 毛利潤 │ $17,094M │ $153,463M │ NVDA 9x │ - │ 毛利率 │ 18.0% │ 71.1% │ +53 ppts │ - │ 營業利潤 │ $4,355M │ $130,387M │ NVDA 30x │ - │ 營業利潤率 │ 4.6% │ 60.4% │ +56 ppts │ - │ 淨利潤 │ $3,794M │ $120,067M │ NVDA 32x │ - │ 攤薄 EPS │ $1.08 │ $4.90 │ — │ - └────────────┴─────────────┴─────────────┴───────────┘ - - 二、現金流對比（全年） - - ┌────────────┬─────────────┬─────────────┐ - │ 指標 │ TSLA FY2025 │ NVDA FY2026 │ - ├────────────┼─────────────┼─────────────┤ - │ 經營現金流 │ $14,747M │ $102,718M │ - │ 資本支出 │ $8,527M │ $6,042M │ - │ 自由現金流 │ $6,220M │ $96,676M │ - │ FCF 利潤率 │ 6.6% │ 44.8% │ - └────────────┴─────────────┴─────────────┘ - - NVDA 的 CapEx 甚至低於 TSLA，卻產生了 15x 的自由現金流。 - - 三、核心風險 - - TSLA：汽車競爭加劇、品牌壓力、Musk 精力分散；汽車業務同比 -10%， - 能源（+27%）和服務（+19%）部分對沖。 - NVDA：對華出口管制；Q1 FY27 指引 $78B 已排除中國數據中心收入， - 單季營收約等於 TSLA 全年。 -``` - -## 速率限制 - -Longbridge OpenAPI 最高支援每秒 10 次調用，SDK 自動刷新 OAuth Token。 - -## Release Notes - -### [v0.15.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.15.0) - -- **新增：`portfolio` 指令** — 組合總損益、各市場資產分布（美/港/A 股/新加坡/現金）、持倉及現金明細 -- **新增：`investors` 指令** — 基於 SEC 13F 資料的主動基金經理排行榜，支援按 CIK 查詢指定投資者的最新持倉（含即時價格） -- **新增：`insider-trades`** — 查看任意標的的內部人士交易記錄（SEC Form 4） -- **新增：`watchlist pin/unpin`** — 將標的置頂至自選股分組頂部 -- **更名並增強：`assets`** — 原 `balance` 指令更名，展示完整資產概覽：淨資產、購買力、保證金、風險等級及分幣種現金明細 - -### [v0.14.2](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.2) - -- **新增：`--lang` 全域標誌** — 為所有指令指定內容語言（`zh-CN`、`zh-HK`、`en`），優先級：`--lang` → 系統 `LANG` 環境變數 → `en` - -### [v0.14.1](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.1) - -- **新增：CN 區域登入** — `longbridge login` 支援中國大陸區域路由 -- **新增：`-v` 標誌** — 快速查看版本號 - -### [v0.14.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.0) - -- **新增：Device Auth 登入** — `longbridge login` 改為 OAuth Device Flow，顯示驗證 URL 和 Code，在任意裝置完成授權，支援 SSH 和無頭環境；`--headless` 標誌已移除 -- **新增：訂單增強** — 支援追蹤止損和 AO 訂單類型；訂單指令新增 `--expire-date`、`--outside-rth`、`--remark` 參數 -- **修復：Linux Segfault** — Linux 預建二進位改為 musl，修復在部分發行版崩潰的問題 - -### [v0.13.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.13.0) - -- **新增：基本面與分析命令** — `financial-report`、`valuation`、`forecast-eps`、`consensus`、`institution-rating`、`shareholder`、`fund-holder`、`dividend`、`finance-calendar`、`exchange-rate` -- **重大變更：命令結構調整** — 19 個扁平命令遷移為子命令樹（如 `news-detail` → `news detail`、`kline-history` → `kline history`、`warrant-list` → `warrant list`） -- **中國區節點支援** — 設定 `LONGBRIDGE_REGION=cn` 可路由至中國節點 - -### [v0.12.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.12.0) - -- **新增：`statement` 命令** — 列出和匯出日結單/月結單 -- **TUI** — 修復 `q` 退出；自選股頁面新增資訊列表與詳情視圖 - ---- - -完整更新日誌：[github.com/longbridge/longbridge-terminal/releases](https://github.com/longbridge/longbridge-terminal/releases) diff --git a/docs/zh-HK/docs/cli/account/_category_.json b/docs/zh-HK/docs/cli/account/_category_.json new file mode 100644 index 00000000..685d7085 --- /dev/null +++ b/docs/zh-HK/docs/cli/account/_category_.json @@ -0,0 +1 @@ +{ "label": "帳戶與持倉", "icon": "briefcase", "position": 7, "collapsed": true } diff --git a/docs/zh-HK/docs/cli/account/assets.md b/docs/zh-HK/docs/cli/account/assets.md new file mode 100644 index 00000000..45580e03 --- /dev/null +++ b/docs/zh-HK/docs/cli/account/assets.md @@ -0,0 +1,41 @@ +--- +title: 'assets' +sidebar_label: 'assets' +sidebar_position: 3 +--- + +# longbridge assets + +查看完整帳戶概覽——淨資產、購買力、保證金狀態、風險等級，以及各幣種的現金餘額。 + +## 基本用法 + +```bash +longbridge assets +``` + +``` +| Currency | Net Assets | Total Cash | Buy Power | Max Finance | Remaining Finance | Init Margin | Maintenance Margin | Risk Level | +|----------|------------|------------|------------|-------------|-------------------|-------------|--------------------|------------| +| USD | 125422.43 | 58638.84 | 106743.46 | 410651.27 | 371985.59 | 18678.97 | 16305.97 | Safe | + +| Currency | Available Cash | Frozen Cash | Settling Cash | Withdrawable | +|----------|----------------|-------------|---------------|--------------| +| USD | -38665.68 | 332.19 | -10108.02 | -38665.68 | +| HKD | 755592.21 | 64.69 | -27760.00 | 755592.21 | +``` + +## 示例 + +### 查看帳戶概覽 + +```bash +longbridge assets +longbridge assets --format json +``` + +以表格形式展示淨資產、總現金、購買力、保證金使用情況及風險等級。 + +## 權限要求 + +需要 OAuth 帳戶權限。參見[帳戶權限設置](/zh-HK/docs/trade/)。 diff --git a/docs/zh-HK/docs/cli/account/cash-flow.md b/docs/zh-HK/docs/cli/account/cash-flow.md new file mode 100644 index 00000000..e358029e --- /dev/null +++ b/docs/zh-HK/docs/cli/account/cash-flow.md @@ -0,0 +1,42 @@ +--- +title: 'cash-flow' +sidebar_label: 'cash-flow' +sidebar_position: 4 +--- + +# longbridge cash-flow + +查看資金流水歷史——入金、出金、股息到帳、交易結算及其他帳戶變動。 + +## 基本用法 + +```bash +longbridge cash-flow +``` + +``` +| Flow Name | Symbol | Business Type | Balance | Currency | Time | Description | +|-----------|--------|---------------|---------|----------|------|-------------| +``` + +## 示例 + +### 查看最近 30 天的資金流水 + +```bash +longbridge cash-flow +``` + +列出過去 30 天內所有資金變動，包括流水類型、關聯標的、餘額、幣種及時間戳。 + +### 按日期範圍篩選 + +```bash +longbridge cash-flow --start 2026-01-01 --end 2026-03-31 +``` + +取得指定日期範圍內的資金流水記錄。適用於季度對帳或稅務報告。 + +## 權限要求 + +需要 OAuth 帳戶權限。參見[帳戶權限設置](/zh-HK/docs/trade/)。 diff --git a/docs/zh-HK/docs/cli/account/fund-holder.md b/docs/zh-HK/docs/cli/account/fund-holder.md new file mode 100644 index 00000000..5151b82b --- /dev/null +++ b/docs/zh-HK/docs/cli/account/fund-holder.md @@ -0,0 +1,48 @@ +--- +title: 'fund-holder' +sidebar_label: 'fund-holder' +sidebar_position: 6 +--- + +# longbridge fund-holder + +查詢持有某只股票的 ETF 和基金，以及每只基金的持倉比例和報告日期。 + +## 基本用法 + +```bash +longbridge fund-holder AAPL.US +``` + +``` +| name | symbol | currency | weight | report_date | +|----------------------------------------|---------|----------|--------|-------------| +| T-Rex 2X Long Apple Daily Target ETF | AAPX.US | USD | 67.62% | 2026.04.03 | +| Global X PureCap MSCI Infor Tech ETF | GXPT.US | USD | 19.58% | 2026.04.06 | +| AAPL 周收益 ETF - Roundhill | AAPW.US | USD | 16.76% | 2026.04.06 | +| 信息科技 ETF - Vanguard | VGT.US | USD | 15.84% | 2026.02.28 | +... +``` + +## 示例 + +### 查找持有某股票的主要 ETF + +```bash +longbridge fund-holder AAPL.US +longbridge fund-holder AAPL.US --format json +``` + +按持倉比例排序，列出對該股票敞口最大的 ETF 和基金。 + +### 取得更多持有者 + +```bash +longbridge fund-holder TSLA.US --count 50 +``` + +使用 `--count` 取得超出預設數量限制的更多結果。 + +## 權限要求 + +需要 OAuth 帳戶權限。參見[帳戶權限設置](/zh-HK/docs/trade/)。 diff --git a/docs/zh-HK/docs/cli/account/fund-positions.md b/docs/zh-HK/docs/cli/account/fund-positions.md new file mode 100644 index 00000000..bd695a49 --- /dev/null +++ b/docs/zh-HK/docs/cli/account/fund-positions.md @@ -0,0 +1,35 @@ +--- +title: 'fund-positions' +sidebar_label: 'fund-positions' +sidebar_position: 5 +--- + +# longbridge fund-positions + +列出當前持有的基金和 ETF 倉位。 + +## 基本用法 + +```bash +longbridge fund-positions +``` + +``` +| Symbol | Name | Net Asset Value | Cost Net Asset Value | Currency | Holding Units | +|--------|------|-----------------|----------------------|----------|---------------| +``` + +## 示例 + +### 查看基金/ETF 持倉 + +```bash +longbridge fund-positions +longbridge fund-positions --format json +``` + +展示帳戶中所有基金和 ETF 持倉，包括標的代碼、數量及成本資訊。 + +## 權限要求 + +需要 OAuth 帳戶權限。參見[帳戶權限設置](/zh-HK/docs/trade/)。 diff --git a/docs/zh-HK/docs/cli/account/portfolio.md b/docs/zh-HK/docs/cli/account/portfolio.md new file mode 100644 index 00000000..facc6fa4 --- /dev/null +++ b/docs/zh-HK/docs/cli/account/portfolio.md @@ -0,0 +1,50 @@ +--- +title: 'portfolio' +sidebar_label: 'portfolio' +sidebar_position: 1 +--- + +# longbridge portfolio + +取得完整投資組合概覽——總盈虧、總資產、各市場（美股/港股/A 股/新加坡）市值，以及現金餘額。 + +## 基本用法 + +```bash +longbridge portfolio +``` + +``` +| Field | Value | +|-------------------|-----------| +| Currency | USD | +| Total Asset | 125422.43 | +| Market Cap | 66783.59 | +| Total Cash | 58638.84 | +| P/L | 140473.44 | +| Intraday P/L | 14637.05 | +| Margin Call | 0 | +| Risk Level | Safe | +| Credit Limit | 410651.27 | + +| Market | Value (USD) | % | +|--------|-------------|---------| +| US | 58659.65 | 46.76% | +| HK | 493265.25 | 393.28% | +| Cash | 58638.84 | 46.75% | +``` + +## 示例 + +### 查看投資組合摘要 + +```bash +longbridge portfolio +longbridge portfolio --format json +``` + +展示總資產價值、總盈虧及今日盈虧，以及各市場市值分佈。 + +## 權限要求 + +需要 OAuth 帳戶權限。參見[帳戶權限設置](/zh-HK/docs/trade/)。 diff --git a/docs/zh-HK/docs/cli/account/positions.md b/docs/zh-HK/docs/cli/account/positions.md new file mode 100644 index 00000000..78dbc76f --- /dev/null +++ b/docs/zh-HK/docs/cli/account/positions.md @@ -0,0 +1,39 @@ +--- +title: 'positions' +sidebar_label: 'positions' +sidebar_position: 2 +--- + +# longbridge positions + +列出當前股票持倉——標的代碼、數量、可用數量、成本價及市場。 + +## 基本用法 + +```bash +longbridge positions +``` + +``` +| Symbol | Name | Quantity | Available | Cost Price | Currency | Market | +|---------|-----------|----------|-----------|------------|----------|--------| +| NVDA.US | NVIDIA | 101 | 101 | 50.229 | USD | US | +| MSFT.US | Microsoft | 15 | 15 | 373.310 | USD | US | +| AAPL.US | Apple | 133 | 133 | 211.589 | USD | US | +| 9988.HK | BABA-W | 500 | 500 | 95.640 | HKD | HK | +``` + +## 示例 + +### 查看所有持倉 + +```bash +longbridge positions +longbridge positions --format json +``` + +展示每筆持倉的名稱、標的代碼、數量、可用交易數量、成本價及市場。 + +## 權限要求 + +需要 OAuth 帳戶權限。參見[帳戶權限設置](/zh-HK/docs/trade/)。 diff --git a/docs/zh-HK/docs/cli/content/_category_.json b/docs/zh-HK/docs/cli/content/_category_.json new file mode 100644 index 00000000..ac8b5ff8 --- /dev/null +++ b/docs/zh-HK/docs/cli/content/_category_.json @@ -0,0 +1 @@ +{ "label": "內容", "icon": "newspaper", "position": 10, "collapsed": true } diff --git a/docs/zh-HK/docs/cli/content/filing.md b/docs/zh-HK/docs/cli/content/filing.md new file mode 100644 index 00000000..bb82b0e9 --- /dev/null +++ b/docs/zh-HK/docs/cli/content/filing.md @@ -0,0 +1,45 @@ +--- +title: 'filing' +sidebar_label: 'filing' +sidebar_position: 2 +--- + +# longbridge filing + +瀏覽標的的監管申報文件和披露文件。美股支持 [SEC EDGAR](https://www.sec.gov/cgi-bin/browse-edgar) 申報文件，包括 [Form 4](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40) 內幕交易、[8-K](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=8-K&dateb=&owner=include&count=40) 當期報告及 [10-K](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=10-K&dateb=&owner=include&count=40) 年報。港股返回[香港聯合交易所](https://www.hkexnews.hk/)的交易所披露文件。 + +## 基本用法 + +```bash +longbridge filing TSLA.US +``` + +``` +| id | title | file_name | files | publish_at | +|--------------------|---------------------------------------|----------------------------|-------|----------------------| +| 633214836329945345 | Tesla | 4 - Tesla, Inc. (Issuer) | 4 - Tesla, Inc. (Issuer) | 1 | 2026-04-03T00:08:52Z | +| 633048285147044097 | Tesla | 8-K - Tesla, Inc. (Filer) | 8-K - Tesla, Inc. (Filer) | 2 | 2026-04-02T13:07:13Z | +| 632835137097963777 | Tesla | 4 - Tesla, Inc. (Issuer) | 4 - Tesla, Inc. (Issuer) | 1 | 2026-04-01T23:00:13Z | +... +``` + +## 示例 + +### 查看最新申報文件 + +```bash +longbridge filing TSLA.US +# 以 JSON 格式輸出（便於腳本處理） +longbridge filing TSLA.US --format json +``` + +列出該標的最新申報文件，包含標題、表格類型及發布日期。JSON 輸出中的 `file_urls` 字段包含申報文件的直接下載鏈接。 + +### 閱讀完整申報內容 + +```bash +# 使用申報列表中的 id 讀取完整文件 +longbridge filing detail 633214836329945345 +``` + +返回申報文件的完整文本內容。適用於提取特定披露資訊，或將內容傳入 AI 模型進行分析。 diff --git a/docs/zh-HK/docs/cli/content/news.md b/docs/zh-HK/docs/cli/content/news.md new file mode 100644 index 00000000..e951955b --- /dev/null +++ b/docs/zh-HK/docs/cli/content/news.md @@ -0,0 +1,47 @@ +--- +title: 'news' +sidebar_label: 'news' +sidebar_position: 1 +--- + +# longbridge news + +取得標的的最新資訊，或透過 ID 取得文章完整內容。 + +## 基本用法 + +```bash +longbridge news TSLA.US +``` + +``` +| id | title | published_at | likes | comments | +|-----------|---------------------------------------------------------|----------------------|-------|----------| +| 282284711 | Wall Street Backs Tesla? Cathie Wood Spends Nearly $28… | 2026-04-10T03:48:22Z | 0 | 0 | +| 282276051 | In response to market rumors that "Tesla is developing… | 2026-04-10T02:16:27Z | 0 | 0 | +| 282265091 | SpaceX posted nearly $5 billion loss in 2025 | 2026-04-10T00:31:27Z | 0 | 0 | +| 282247843 | Down More Than 30% from All-Time Highs, Should You Buy… | 2026-04-09T20:46:26Z | 0 | 0 | +... +``` + +## 示例 + +### 取得股票最新資訊 + +```bash +longbridge news TSLA.US +# 取得更多文章 +longbridge news NVDA.US --count 5 +# 以 JSON 格式輸出（便於腳本處理） +longbridge news TSLA.US --format json +``` + +列出該標的最新資訊，包含標題、發布時間及 URL。 + +### 取得文章完整內容 + +```bash +longbridge news detail 282276051 +``` + +透過 ID 取得單篇文章的完整 Markdown 內容。文章 ID 來自列表輸出的 `id` 字段。 diff --git a/docs/zh-HK/docs/cli/content/topic.md b/docs/zh-HK/docs/cli/content/topic.md new file mode 100644 index 00000000..00a2088c --- /dev/null +++ b/docs/zh-HK/docs/cli/content/topic.md @@ -0,0 +1,67 @@ +--- +title: 'topic' +sidebar_label: 'topic' +sidebar_position: 3 +--- + +# longbridge topic + +取得 Longbridge 平台上與某標的相關的社區討論帖子。 + +## 基本用法 + +```bash +longbridge topic TSLA.US +``` + +``` +| id | title | published_at | likes | comments | shares | +|----------|-------------------------------------------------|----------------------|-------|----------|--------| +| 39798312 | AI's Hard Limit: Compute Boom Meets a Power Cr… | 2026-04-09T11:32:03Z | 41 | 7 | 97 | +| 39816927 | Tesla is weirdly terrible. Other stocks are up… | 2026-04-09T19:54:50Z | 6 | 4 | 0 | +| 39822930 | What does everyone think about current Tesla? | 2026-04-10T04:43:49Z | 0 | 0 | 0 | +... +``` + +## 示例 + +### 查看社區討論 + +```bash +longbridge topic TSLA.US +# 查看其他標的的討論 +longbridge topic NVDA.US +``` + +列出與該標的相關的社區帖子，包含標題、摘要及互動數據。 + +### 閱讀帖子完整內容 + +```bash +longbridge topic detail 39798312 +``` + +``` +ID: 39798312 +Type: article +Title: AI's Hard Limit: Compute Boom Meets a Power Crunch; Gas Turbines the Hidden Boss? +Tickers: ST/US/TSLA, ST/US/NVDA, ST/US/GOOG +Stats: 42 likes 7 comments 0 views +Created: 2026-04-09T11:32:03Z +URL: https://longbridge.cn/topics/39798312 + +In the prior piece on AI infrastructure, Dolphin Research argued that +the U.S. power shortfall is not a cyclical mismatch but a structural conflict +between surging AI compute and long-lagging energy and grid build-out... +``` + +使用帖子列表中的 `id` 取得任意帖子的完整正文。 + +### 篩選高互動帖子 + +```bash +# 使用 jq 篩選點讚數較高的帖子 +longbridge topic TSLA.US --format json | jq '[.[] | select(.likes_count > 10)]' +``` + +結合 `jq` 篩選討論最熱的帖子。適用於在財報或重大新聞事件前後追蹤散戶情緒變化。 diff --git a/docs/zh-HK/docs/cli/derivatives/_category_.json b/docs/zh-HK/docs/cli/derivatives/_category_.json new file mode 100644 index 00000000..daba5e6c --- /dev/null +++ b/docs/zh-HK/docs/cli/derivatives/_category_.json @@ -0,0 +1 @@ +{ "label": "衍生品", "icon": "layers", "position": 4, "collapsed": true } diff --git a/docs/zh-HK/docs/cli/derivatives/option.md b/docs/zh-HK/docs/cli/derivatives/option.md new file mode 100644 index 00000000..fa10f446 --- /dev/null +++ b/docs/zh-HK/docs/cli/derivatives/option.md @@ -0,0 +1,81 @@ +--- +title: 'option' +sidebar_label: 'option' +sidebar_position: 1 +--- + +# longbridge option + +查詢美股期權合約的即時行情，或瀏覽任意標的的完整期權鏈。 + +## 基本用法 + +```bash +longbridge option chain AAPL.US +``` + +``` +| Strike | Call Symbol | Put Symbol | Standard | +|--------|----------------------|----------------------|----------| +| 180 | AAPL260406C180000.US | AAPL260406P180000.US | true | +| 185 | AAPL260406C185000.US | AAPL260406P185000.US | true | +| 190 | AAPL260406C190000.US | AAPL260406P190000.US | true | +| 195 | AAPL260406C195000.US | AAPL260406P195000.US | true | +| 200 | AAPL260406C200000.US | AAPL260406P200000.US | true | +... +``` + +## 示例 + +### 瀏覽股票期權鏈 + +不加 `--date` 時，返回 AAPL 期權所有可用的到期日。選擇一個到期日後，使用 `--date` 參數查看對應的行權價列表。 + +### 查看指定到期日的行權價 + +```bash +longbridge option chain AAPL.US --date 2026-04-17 --format json +``` + +```json +[ + { "call_symbol": "AAPL260417C110000.US", "put_symbol": "AAPL260417P110000.US", "standard": "true", "strike": "110" }, + { "call_symbol": "AAPL260417C115000.US", "put_symbol": "AAPL260417P115000.US", "standard": "true", "strike": "115" }, + { "call_symbol": "AAPL260417C120000.US", "put_symbol": "AAPL260417P120000.US", "standard": "true", "strike": "120" } +] +``` + +每行展示該行權價對應的認購和認沽合約代碼。從 `call_symbol` 或 `put_symbol` 複製合約代碼即可取得即時行情。 + +### 取得期權合約即時行情 + +```bash +longbridge option quote AAPL260417C190000.US --format json +``` + +```json +[ + { + "symbol": "AAPL260417C190000.US", + "last": "12.35", + "bid": "12.30", + "ask": "12.40", + "open_interest": "4821", + "implied_volatility": "0.2341", + "delta": "0.4812", + "gamma": "0.0231", + "theta": "-0.0512", + "vega": "0.1843" + } +] +``` + +返回該合約的最新買賣價、最新成交價、隱含波動率及希臘值（delta、gamma、theta、vega）。 + +## 權限要求 + +`option quote` 需要期權帳戶及期權行情權限；`option chain` 需要一級行情權限。參見[行情訂閱](/zh-HK/docs/quote/)了解權限詳情。 + +## 說明 + +期權代碼格式：`AAPL260417C190000.US`——標的 AAPL，到期日 2026-04-17，認購（Call），行權價 $190.00。價格部分以 $0.001 為單位，因此 190000 = $190.00。 diff --git a/docs/zh-HK/docs/cli/derivatives/warrant.md b/docs/zh-HK/docs/cli/derivatives/warrant.md new file mode 100644 index 00000000..660b3af3 --- /dev/null +++ b/docs/zh-HK/docs/cli/derivatives/warrant.md @@ -0,0 +1,106 @@ +--- +title: 'warrant' +sidebar_label: 'warrant' +sidebar_position: 2 +--- + +# longbridge warrant + +瀏覽港股窩輪——列出某標的的所有窩輪、取得單只窩輪的即時行情，或查詢發行商資訊。 + +## 基本用法 + +```bash +longbridge warrant 700.HK +``` + +``` +| Symbol | Name | Last | Leverage Ratio | Expiry | Type | +|----------|-----------------|------|----------------|------------|------| +| 24760.HK | UBTENCT@EP2606B | 0.66 | 7.65 | 2026-06-30 | Call | +| 25228.HK | GJTENCT@EP2606B | 0.65 | 7.77 | 2026-06-30 | Call | +| 24687.HK | JPTENCT@EP2606A | 0.65 | 7.77 | 2026-06-30 | Call | +| 24880.HK | CITENCT@EP2606B | 0.64 | 7.89 | 2026-06-30 | Call | +... +``` + +## 示例 + +### 列出某股票的所有窩輪 + +```bash +longbridge warrant 700.HK --format json +``` + +```json +[ + { + "expiry": "2026-06-30", + "last": "0.65", + "leverage_ratio": "7.7846153846153845", + "name": "UBTENCT@EP2606B", + "symbol": "24760.HK", + "type": "Put" + }, + { + "expiry": "2026-06-30", + "last": "0.65", + "leverage_ratio": "7.7846153846153845", + "name": "JPTENCT@EP2606A", + "symbol": "24687.HK", + "type": "Put" + }, + { + "expiry": "2026-06-30", + "last": "0.64", + "leverage_ratio": "7.90625", + "name": "GJTENCT@EP2606B", + "symbol": "25228.HK", + "type": "Put" + } +] +``` + +返回該標的所有上市窩輪，包括類型（認購/認沽）、最新價、槓桿比率及到期日。使用 `symbol` 字段可取得詳細行情。 + +### 取得單只窩輪行情 + +```bash +longbridge warrant quote 24760.HK --format json +``` + +```json +[ + { + "expiry": "2026-06-30", + "implied_vol": "0.344", + "last": "0.650", + "prev_close": "0.640", + "symbol": "24760.HK", + "type": "Put" + } +] +``` + +返回包含隱含波動率、最新價及昨收價的即時行情。 + +### 查詢窩輪發行商 + +```bash +longbridge warrant issuers --format json +``` + +```json +[ + { "id": "1", "name_cn": "瑞信", "name_en": "CS" }, + { "id": "3", "name_cn": "摩通", "name_en": "JP" }, + { "id": "4", "name_cn": "麥銀", "name_en": "MB" }, + { "id": "8", "name_cn": "法興", "name_en": "SG" } +] +``` + +列出港股市場所有活躍窩輪發行商及其 ID 和名稱。 + +## 權限要求 + +需要窩輪行情權限。窩輪數據僅覆蓋港股市場。參見[行情訂閱](/zh-HK/docs/quote/)了解權限詳情。 diff --git a/docs/zh-HK/docs/cli/fundamentals/_category_.json b/docs/zh-HK/docs/cli/fundamentals/_category_.json new file mode 100644 index 00000000..e50d1d96 --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/_category_.json @@ -0,0 +1 @@ +{ "label": "基本面", "icon": "book-open", "position": 5, "collapsed": true } diff --git a/docs/zh-HK/docs/cli/fundamentals/consensus.md b/docs/zh-HK/docs/cli/fundamentals/consensus.md new file mode 100644 index 00000000..958dc743 --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/consensus.md @@ -0,0 +1,58 @@ +--- +title: 'consensus' +sidebar_label: 'consensus' +sidebar_position: 5 +--- + +# longbridge consensus + +查看華爾街對即將到來的財報周期的一致性財務預測——營收、EBIT 及 EPS。 + +## 基本用法 + +```bash +longbridge consensus TSLA.US +``` + +``` +Currency: USD | Period: qf +| metric | Q3 2026 | Q2 2026 | Q1 2026 | Q4 2025 | Q3 2025 | +|---------------|---------|---------|----------|-----------|----------| +| Revenue | ~27.14B | ~24.71B | ~22.75B | 24.90B ↑ | 28.09B ↑ | +| Net Income | ~1.28B | ~1.08B | ~879.54M | 840.00M ↓ | 1.37B ↓ | +| EPS | ~0.3818 | ~0.2969 | ~0.2390 | 0.2400 ↓ | 0.3900 ↓ | +... +``` + +## 示例 + +### 查看一致性預測 + +```bash +longbridge consensus TSLA.US +``` + +展示即將報告期的分析師一致性預測，涵蓋營收、EBIT 及 EPS 等核心指標。 + +### JSON 輸出 + +```bash +longbridge consensus TSLA.US --format json +``` + +```json +{ + "currency": "USD", + "current_period": "qf", + "list": [ + { + "details": [ + { "key": "revenue", "name": "Revenue", "estimate": "27144782630.0000", "is_released": false }, + { "key": "ebit", "name": "EBIT", "estimate": "1496709370.0000", "is_released": false } + ] + } + ] +} +``` + +每條 `details` 記錄包含指標名稱、一致性預測值，以及實際結果是否已發布。完整響應中的 `current_index` 標示當前所在的報告期。 diff --git a/docs/zh-HK/docs/cli/fundamentals/dividend.md b/docs/zh-HK/docs/cli/fundamentals/dividend.md new file mode 100644 index 00000000..27e5d3bf --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/dividend.md @@ -0,0 +1,68 @@ +--- +title: 'dividend' +sidebar_label: 'dividend' +sidebar_position: 3 +--- + +# longbridge dividend + +查看股票的歷史股息派發記錄。 + +## 基本用法 + +```bash +longbridge dividend 700.HK +``` + +``` +| desc | ex_date | payment_date | record_date | +|--------------------------------------|------------|--------------|-------------| +| Dividend: HKD 5.3/share | 2026.05.15 | 2026.06.01 | 2026.05.18 | +| Dividend: HKD 4.5/share | 2025.05.16 | 2025.05.30 | 2025.05.19 | +| Dividend: HKD 3.4/share | 2024.05.17 | 2024.05.31 | 2024.05.20 | +| Dividend: HKD 2.4/share | 2023.05.19 | 2023.06.05 | 2023.05.22 | +``` + +## 示例 + +### 查看股息歷史 + +```bash +longbridge dividend AAPL.US +``` + +列出蘋果公司所有歷史股息記錄，包括派息日期、每股金額及股息類型。 + +### 港股股息示例 + +```bash +longbridge dividend 700.HK +``` + +同樣適用於港股。騰訊定期派發股息，此命令展示完整派息歷史。 + +### 查找下一個除息日 + +```bash +# ex_date 字段顯示每條記錄的除息日 +longbridge dividend AAPL.US +``` + +最新記錄顯示最後已知的除息日。對於尚未公布的未來股息，可使用 `finance-calendar` 命令並指定 `dividend` 類型查詢。 + +### 查看股息分配方案詳情 + +```bash +# 展示詳細股息分配方案（手數、幣種、比例） +longbridge dividend detail AAPL.US +``` + +`detail` 子命令展示完整的分配方案——適用於股息中同時包含紅股或配股的情況。 + +### JSON 輸出用於自動化 + +```bash +longbridge dividend AAPL.US --format json +``` + +返回包含 `ex_date`、`payment_date`、`record_date` 及 `desc` 字段（如 `"Dividend: USD 0.26/share"`）的結構化 JSON，適合傳入腳本或跟蹤工具處理。 diff --git a/docs/zh-HK/docs/cli/fundamentals/finance-calendar.md b/docs/zh-HK/docs/cli/fundamentals/finance-calendar.md new file mode 100644 index 00000000..7509d1b6 --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/finance-calendar.md @@ -0,0 +1,55 @@ +--- +title: 'finance-calendar' +sidebar_label: 'finance-calendar' +sidebar_position: 6 +--- + +# longbridge finance-calendar + +瀏覽即將到來的財經事件——財報發布、股息派發、IPO 及宏觀經濟數據發布，支持按標的、市場或事件類型篩選。 + +## 基本用法 + +```bash +longbridge finance-calendar financial --symbol TSLA.US +``` + +``` +2026.01.28 (ET) [Financials] US Tesla (TSLA.US) + Q4 FY2025 Earnings Release + EPS: Est 0.3466 / Act 0.24 | Revenue: Est $24.8B / Act $24.9B +``` + +## 示例 + +### 查看某股票的即將財報 + +```bash +longbridge finance-calendar financial --symbol TSLA.US +``` + +顯示特斯拉即將到來的財報日期及分析師對 EPS 和營收的預測。使用 `--symbol` 縮小到特定股票。 + +### 查看美股今日股息事件 + +```bash +longbridge finance-calendar dividend --market US +``` + +列出所有美股今日股息相關事件（除息日、派息日）。適用於追蹤哪些股票即將除息。 + +### 高重要性宏觀事件 + +```bash +longbridge finance-calendar macrodata --star 3 +``` + +只顯示高重要性宏觀經濟數據發布（三星級），涵蓋 CPI、非農就業、美聯儲利率決議等市場重要事件。 + +### IPO 日曆 + +```bash +longbridge finance-calendar ipo +``` + +顯示各支持市場即將到來的 IPO。可結合 `--market` 按交易所篩選。 diff --git a/docs/zh-HK/docs/cli/fundamentals/financial-report.md b/docs/zh-HK/docs/cli/fundamentals/financial-report.md new file mode 100644 index 00000000..0a9391f3 --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/financial-report.md @@ -0,0 +1,61 @@ +--- +title: 'financial-report' +sidebar_label: 'financial-report' +sidebar_position: 1 +--- + +# longbridge financial-report + +取得任意上市公司的利潤表、資產負債表及現金流量表。 + +## 基本用法 + +```bash +longbridge financial-report TSLA.US --kind IS +``` + +``` +── IS ── +| metric | Q4 2025 | Q3 2025 | Q2 2025 | Q1 2025 | Q4 2024 | +|---------------------|---------|---------|---------|---------|---------| +| EPS (USD) | 0.2404 | 0.3900 | 0.3300 | 0.1200 | 0.6104 | +| ROE | 4.15% | 6.98% | 6.17% | 2.22% | 11.90% | +| Revenue (USD) | 24.90B | 28.09B | 22.50B | 19.34B | 25.71B | +| Net Income (USD) | 840.00M | 1.37B | 1.17B | 409.00M | 2.12B | +| Gross Margin | 20.12% | 17.99% | 17.24% | 16.31% | 16.26% | +| Net Margin | 3.37% | 4.89% | 5.21% | 2.12% | 8.28% | +``` + +## 示例 + +### 取得最新利潤表 + +```bash +longbridge financial-report TSLA.US --kind IS +``` + +返回最新報告期的利潤表，包含 EPS、營收及其他盈利項目。 + +### 取得三張報表 + +```bash +longbridge financial-report TSLA.US +``` + +同時取得利潤表、資產負債表和現金流量表，等同於 `--kind ALL`。 + +### 取得現金流量表 + +```bash +longbridge financial-report TSLA.US --kind CF +``` + +返回現金流量表，涵蓋經營、投資及融資活動。 + +### 年度資產負債表 + +```bash +longbridge financial-report 700.HK --kind BS --report af +``` + +取得騰訊的年度資產負債表。使用 `--report` 選擇報告周期：`af`（年報）、`saf`（半年報）、`q1`、`3q` 或 `qf`（季報）。 diff --git a/docs/zh-HK/docs/cli/fundamentals/forecast-eps.md b/docs/zh-HK/docs/cli/fundamentals/forecast-eps.md new file mode 100644 index 00000000..c03c8c07 --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/forecast-eps.md @@ -0,0 +1,60 @@ +--- +title: 'forecast-eps' +sidebar_label: 'forecast-eps' +sidebar_position: 4 +--- + +# longbridge forecast-eps + +取得分析師對未來報告期的 EPS 一致性預測——均值、中位數、最高及最低預測值。 + +## 基本用法 + +```bash +longbridge forecast-eps TSLA.US +``` + +``` +EPS Forecasts (recent 19): +| end_date | mean | median | highest | lowest | up | down | total | +|------------|-------|--------|---------|--------|----|------|-------| +| 2026-02-03 | 2.092 | 2.04 | 2.75 | 1.212 | 0 | 0 | 0 | +| 2026-02-04 | 2.092 | 2.04 | 2.75 | 1.212 | 0 | 0 | 0 | +| 2026-02-08 | 2.057 | 2.035 | 2.75 | 1.212 | 0 | 0 | 0 | +... +``` + +## 示例 + +### 查看 EPS 預測 + +```bash +longbridge forecast-eps TSLA.US +``` + +展示每個未來報告期的分析師 EPS 一致性預測，以及預測區間（最高和最低值）。 + +### JSON 輸出用於跟蹤預測變化 + +```bash +longbridge forecast-eps TSLA.US --format json +``` + +```json +{ + "items": [ + { + "forecast_end_date": "1726790400", + "forecast_eps_highest": "3.79", + "forecast_eps_lowest": "2.37", + "forecast_eps_mean": "3.043", + "forecast_eps_median": "3.02", + "institution_down": 0, + "institution_total": 0, + "institution_up": 0 + } + ] +} +``` + +每條記錄對應一個報告期。`forecast_eps_mean` 和 `forecast_eps_median` 代表一致性預測，`highest` 和 `lowest` 顯示分析師預測區間。 diff --git a/docs/zh-HK/docs/cli/fundamentals/institution-rating.md b/docs/zh-HK/docs/cli/fundamentals/institution-rating.md new file mode 100644 index 00000000..5fa89955 --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/institution-rating.md @@ -0,0 +1,80 @@ +--- +title: 'institution-rating' +sidebar_label: 'institution-rating' +sidebar_position: 2 +--- + +# longbridge institution-rating + +查看華爾街分析師的一致性評級——買入/持有/賣出分佈、目標價區間及行業排名。 + +## 基本用法 + +```bash +longbridge institution-rating TSLA.US +``` + +``` +Consensus: +| recommend | target | change | updated_at | +|-----------|--------|--------|-------------| +| buy | 415.78 | 20.30% | 2026-04-09 | + +Rating breakdown: +| strong_buy | buy | hold | sell | under | no_opinion | total | +|------------|-----|------|------|-------|------------|-------| +| 18 | 5 | 17 | 6 | 2 | 4 | 52 | + +Target price range: +| lowest_price | highest_price | prev_close | +|--------------|---------------|------------| +| 125.000 | 600.000 | 345.62 | +``` + +## 示例 + +### 查看分析師一致性評級 + +```bash +longbridge institution-rating TSLA.US +``` + +展示分析師評級分佈（買入、持有、賣出及細分類別）、一致性目標價區間及行業同類排名。 + +### 查看歷史評級變化 + +```bash +# 展示逐周評級數量歷史及各分析師目標價 +longbridge institution-rating detail TSLA.US +``` + +`detail` 子命令列出按周統計的歷史評級分佈及各分析師目標價，便於追蹤情緒隨時間的變化趨勢。 + +### JSON 輸出用於監控 + +```bash +longbridge institution-rating TSLA.US --format json +``` + +```json +{ + "analyst": { + "evaluate": { + "buy": 18, + "hold": 17, + "no_opinion": 4, + "over": 5, + "sell": 6, + "under": 2, + "total": 52 + }, + "target": { + "highest_price": "600.000", + "lowest_price": "125.000", + "prev_close": "345.62" + } + } +} +``` + +`evaluate` 對象包含 52 位覆蓋分析師的各評級數量；`target` 對象顯示最高和最低目標價，以及上一收盤價供參考。 diff --git a/docs/zh-HK/docs/cli/fundamentals/valuation.md b/docs/zh-HK/docs/cli/fundamentals/valuation.md new file mode 100644 index 00000000..cf2c0625 --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/valuation.md @@ -0,0 +1,79 @@ +--- +title: 'valuation' +sidebar_label: 'valuation' +sidebar_position: 7 +--- + +# longbridge valuation + +分析股票當前估值（P/E、P/B、P/S、股息率），結合 5 年歷史區間和行業同類對比，或追蹤估值隨時間的變化。 + +## 基本用法 + +```bash +longbridge valuation TSLA.US --indicator pe +``` + +``` +Overview: +| indicator | current | high | low | median | industry_median | date | +|-----------|---------|--------|-------|--------|-----------------|------------| +| PE | 341.83x | 284.01 | 51.31 | 96.85 | -0.11 | 2026-04-09 | +Current P/E 341.83, above fair range, cheaper than 8.85% of last 5 years, industry rank 19/49 + +Peers (5): +| name | pe | +|-------|--------| +| TSLA | 341.83 | +... +``` + +## 示例 + +### 當前估值快照 + +```bash +longbridge valuation TSLA.US +``` + +展示當前 P/E、P/B、P/S 及股息率，以及 5 年歷史區間和當前值在區間內的位置，包含行業同類排名。 + +### 歷史 P/E 走勢 + +```bash +longbridge valuation TSLA.US --history --indicator pe --range 5 +``` + +返回特斯拉過去 5 年的 P/E 時間序列。使用 `--range` 設置回溯窗口：`1`、`3`、`5` 或 `10` 年。 + +### 追蹤 P/B 歷史變化 + +```bash +longbridge valuation 700.HK --history --indicator pb +``` + +追蹤騰訊市淨率的歷史變化。`--history` 模式支持的指標：`pe`、`pb`、`ps`、`dvd_yld`。 + +### JSON 輸出用於監控 + +```bash +# 以 JSON 格式匯出歷史 P/B 數據，用於腳本或監控流水線 +longbridge valuation TSLA.US --history --indicator pb --format json +``` + +```json +{ + "metrics": { + "pb": { + "desc": "current P/B 15.79, in reasonable range, cheaper than 50.31% of last 5 years, industry rank 35/49", + "high": "24.35", + "list": [ + { "timestamp": "1619841600", "value": "26.87" }, + { "timestamp": "1622520000", "value": "24.53" } + ] + } + } +} +``` + +`desc` 字段提供當前估值與歷史區間及行業同類對比的可讀摘要；`list` 數組包含時間序列數據點。 diff --git a/docs/zh-HK/docs/cli/index.md b/docs/zh-HK/docs/cli/index.md new file mode 100644 index 00000000..0e5a4a1a --- /dev/null +++ b/docs/zh-HK/docs/cli/index.md @@ -0,0 +1,49 @@ +--- +title: 'Longbridge CLI' +sidebar_label: '概述' +sidebar_position: 1 +sidebar_icon: terminal +--- + +# Longbridge CLI + +Longbridge CLI（`longbridge`）是面向 Longbridge OpenAPI 全端點的 AI 原生命令列工具，覆蓋即時行情、基本面數據、帳戶管理與交易。適用於腳本自動化、AI Agent 工具呼叫及日常終端工作流。 + +**GitHub：** [longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal) + +## 快速開始 + +參見[安裝說明](/zh-HK/docs/cli/installation)了解平台安裝方式與鑑權配置。安裝後可直接執行任意命令： + +```bash +# 查詢即時行情 +longbridge quote TSLA.US NVDA.US + +# 查看持倉 +longbridge portfolio + +# JSON 輸出（適用於腳本或 AI Agent） +longbridge quote AAPL.US --format json +``` + +## JSON 輸出 + +所有命令均支援 `--format json`，輸出機器可讀格式，方便管道傳遞、`jq` 處理或 AI Agent 呼叫： + +```bash +longbridge positions --format json +longbridge quote TSLA.US NVDA.US --format json +``` + +## 標的代碼格式 + +標的代碼採用 `代碼.市場` 格式： + +| 示例 | 市場 | +| ------------- | ------------------ | +| `TSLA.US` | 美股 | +| `700.HK` | 港股 | +| `600519.SH` | A 股（上交所） | +| `000568.SZ` | A 股（深交所） | +| `D05.SG` | 新加坡 | +| `BTCUSD.HAS` | 加密貨幣（Longbridge 專屬）| diff --git a/docs/zh-HK/docs/cli/installation.md b/docs/zh-HK/docs/cli/installation.md new file mode 100644 index 00000000..e2684370 --- /dev/null +++ b/docs/zh-HK/docs/cli/installation.md @@ -0,0 +1,80 @@ +--- +title: '安裝' +sidebar_label: '安裝' +sidebar_position: 2 +sidebar_icon: cpu +--- + +# 安裝 + +安裝 CLI 並完成 Longbridge 帳戶鑑權。 + +原始碼與發佈版本：[longbridge/longbridge-terminal](https://github.com/longbridge/longbridge-terminal){target="_blank"} + +## 安裝 + + + + +```bash +brew install --cask longbridge/tap/longbridge-terminal +``` + + + + +```bash +curl -sSL https://open.longbridge.com/longbridge/longbridge-terminal/install | sh +``` + + + + +```powershell +scoop install https://open.longbridge.com/longbridge/longbridge-terminal/longbridge.json +``` + + + + +```powershell +iwr https://open.longbridge.com/longbridge/longbridge-terminal/install.ps1 | iex +``` + + + + +## login + +通過 OAuth 2.0 裝置授權流完成鑑權，適用於任何環境，包括 SSH 和無介面伺服器。 + +```bash +longbridge login +``` + +執行 `login` 後會印出一個 URL 和短碼。在任意瀏覽器中開啟該 URL，輸入短碼並授權。Token 儲存至 `~/.longbridge/openapi/tokens/`，後續所有命令自動複用。 + +## check + +驗證 Token 有效性與 API 連通性。顯示 Token 狀態、快取區域，以及全球和 CN 兩端 API 的延遲。無需活躍市場交易時段。 + +```bash +longbridge check +longbridge check --format json +``` + +## update + +下載並執行官方安裝腳本，將目前二進位檔案替換為最新版本。 + +```bash +longbridge update +``` + +## logout + +清除已儲存的 OAuth Token。下次執行命令或啟動 TUI 時將重新觸發鑑權。 + +```bash +longbridge logout +``` diff --git a/docs/zh-HK/docs/cli/market-data/_category_.json b/docs/zh-HK/docs/cli/market-data/_category_.json new file mode 100644 index 00000000..21ddb97e --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/_category_.json @@ -0,0 +1 @@ +{ "label": "行情數據", "icon": "bar-chart-2", "position": 3, "collapsed": false } diff --git a/docs/zh-HK/docs/cli/market-data/brokers.md b/docs/zh-HK/docs/cli/market-data/brokers.md new file mode 100644 index 00000000..ad55d094 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/brokers.md @@ -0,0 +1,52 @@ +--- +title: 'brokers' +sidebar_label: 'brokers' +sidebar_position: 3 +--- + +# longbridge brokers + +查看港股盤口各價位的券商 ID 分佈，適合識別機構資金的委託流向。 + +## 基本用法 + +```bash +longbridge brokers 700.HK +``` + +``` +Symbol: 700.HK + +Ask Brokers: +| Position | Broker IDs | +|----------|---------------| +| 1 | 3014, 6409 | +| 2 | 7707, 724 | +| 3 | 1142 | + +Bid Brokers: +| Position | Broker IDs | +|----------|---------------| +| 1 | 5428, 3423 | +| 2 | 3506, 3507 | +| 3 | 4482, 4483 | +``` + +## 示例 + +### 查看券商分佈 + +```bash +longbridge brokers 700.HK +longbridge brokers 700.HK --format json +``` + +顯示港股盤口各價位及在該價位掛單的券商 ID。 + +## 權限要求 + +需要 Level 2 行情訂閱，僅支援港股市場。詳見 [行情訂閱](/zh-HK/docs/quote/) 中的訂閱選項。 + +## 說明 + +使用 `longbridge participants` 可按 ID 查詢券商名稱。`brokers` 輸出中的券商 ID 與 participants 列表中的 `broker_id` 欄位直接對應。 diff --git a/docs/zh-HK/docs/cli/market-data/calc-index.md b/docs/zh-HK/docs/cli/market-data/calc-index.md new file mode 100644 index 00000000..5a519b10 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/calc-index.md @@ -0,0 +1,54 @@ +--- +title: 'calc-index' +sidebar_label: 'calc-index' +sidebar_position: 8 +--- + +# longbridge calc-index + +計算任意標的的財務指標——市盈率、市淨率、股息率、換手率、期權希臘值等。 + +## 基本用法 + +```bash +longbridge calc-index TSLA.US +``` + +``` +| Symbol | PE TTM | PB | DPS Rate | Turnover Rate | Total Market Value | +|---------|--------|-------|----------|---------------|---------------------| +| TSLA.US | 341.83 | 15.79 | - | 2.21 | 1296915542310.08 | +``` + +## 示例 + +### 查看市盈率和市淨率 + +```bash +longbridge calc-index TSLA.US NVDA.US --index pe pb +longbridge calc-index TSLA.US NVDA.US --index pe pb --format json +``` + +計算每個標的的指定指標。一次調用可同時請求多個標的和多個指標。JSON 輸出中僅包含有數據的指標，無數據的指標會被省略。 + +### 默認指標（市盈率、市淨率、股息率、換手率、市值） + +```bash +longbridge calc-index TSLA.US +``` + +省略 `--index` 時，返回默認指標集：`pe`、`pb`、`dps_rate`、`turnover_rate`、`total_market_value`。 + +### 衍生品的期權希臘值 + +```bash +longbridge calc-index 24760.HK --index delta gamma vega theta +``` + +對於期權和權證，可直接請求希臘值。輸出中僅包含適用於該品種類型的指標。希臘值僅對期權/權證標的有意義——普通股票標的不會返回希臘值數據。 + +## 說明 + +支援的指標名稱完整列表：`last_done`、`change_value`、`change_rate`、`volume`、`turnover`、`ytd_change_rate`、`turnover_rate`、`total_market_value`、`capital_flow`、`amplitude`、`volume_ratio`、`pe`（別名：`pe_ttm`）、`pb`、`dps_rate`（別名：`dividend_yield`）、`five_day_change_rate`、`ten_day_change_rate`、`half_year_change_rate`、`five_minutes_change_rate`、`implied_volatility`、`delta`、`gamma`、`theta`、`vega`、`rho`、`open_interest`、`expiry_date`、`strike_price`。 + +未知指標名稱會被靜默忽略——若預期欄位在輸出中缺失，請檢查拼寫是否正確。 diff --git a/docs/zh-HK/docs/cli/market-data/capital.md b/docs/zh-HK/docs/cli/market-data/capital.md new file mode 100644 index 00000000..63ee77f0 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/capital.md @@ -0,0 +1,61 @@ +--- +title: 'capital' +sidebar_label: 'capital' +sidebar_position: 9 +--- + +# longbridge capital + +追蹤盤中資金流向——通過 `flow` 子命令逐分鐘查看大、中、小資金的流入流出，或通過 `dist` 子命令查看資金分佈快照。 + +## 基本用法 + +```bash +longbridge capital flow TSLA.US +``` + +``` +| Time | Inflow | +|---------------------|----------| +| 2026-04-09 13:30:00 | 1100.46 | +| 2026-04-09 13:31:00 | 1129.09 | +| 2026-04-09 13:32:00 | 1711.27 | +| 2026-04-09 13:33:00 | 1955.54 | +| 2026-04-09 13:34:00 | 1609.27 | +... +``` + +## 示例 + +### 逐分鐘追蹤大資金淨流入 + +```bash +longbridge capital flow TSLA.US --format json +``` + +```json +[ + { "inflow": "1100.46", "time": "2026-04-09 13:30:00" }, + { "inflow": "1129.09", "time": "2026-04-09 13:31:00" }, + { "inflow": "1711.27", "time": "2026-04-09 13:32:00" } +] +``` + +每條數據顯示該分鐘的淨流入量。正值表示淨買入，負值表示淨賣出。 + +### 快照：大中小資金分佈 + +```bash +longbridge capital dist TSLA.US --format json +``` + +```json +{ + "capital_in": { "large": "30160.97", "medium": "131976.32", "small": "134017.99" }, + "capital_out": { "large": "21801.89", "medium": "132803.77", "small": "124441.20" }, + "symbol": "TSLA.US", + "timestamp": "2026-04-09 20:00:00" +} +``` + +`capital_in` 按訂單規模（大 / 中 / 小）顯示流入該股票的總資金；`capital_out` 顯示對應的資金流出。對比兩者可判斷大型機構資金是淨買入還是淨賣出。 diff --git a/docs/zh-HK/docs/cli/market-data/depth.md b/docs/zh-HK/docs/cli/market-data/depth.md new file mode 100644 index 00000000..40e28ed7 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/depth.md @@ -0,0 +1,48 @@ +--- +title: 'depth' +sidebar_label: 'depth' +sidebar_position: 2 +--- + +# longbridge depth + +查看某標的的 Level 2 盤口——買賣雙方前 10 檔價位的委託單數量和掛單量。 + +## 基本用法 + +```bash +longbridge depth TSLA.US +``` + +``` +Symbol: TSLA.US + +Asks (Sell): +| Position | Price | Volume | Orders | +|----------|---------|--------|--------| +| 1 | 344.990 | 200 | 3 | +| 2 | 345.000 | 500 | 8 | +| 3 | 345.010 | 300 | 4 | + +Bids (Buy): +| Position | Price | Volume | Orders | +|----------|---------|--------|--------| +| 1 | 344.980 | 400 | 6 | +| 2 | 344.970 | 600 | 9 | +| 3 | 344.960 | 250 | 3 | +``` + +## 示例 + +### 查看盤口 + +```bash +longbridge depth 700.HK +longbridge depth 700.HK --format json +``` + +顯示 700.HK 當前的買賣盤檔位，包括各檔價格、掛單量和委託單數量。市場開盤期間每側最多返回 10 檔。 + +## 權限要求 + +需要 Level 2 行情訂閱。詳見 [行情訂閱](/zh-HK/docs/quote/) 中的訂閱選項。 diff --git a/docs/zh-HK/docs/cli/market-data/intraday.md b/docs/zh-HK/docs/cli/market-data/intraday.md new file mode 100644 index 00000000..a9402a32 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/intraday.md @@ -0,0 +1,62 @@ +--- +title: 'intraday' +sidebar_label: 'intraday' +sidebar_position: 5 +--- + +# longbridge intraday + +取得任意標的今日逐分鐘的價格和成交量數據（分時線）。 + +## 基本用法 + +```bash +longbridge intraday TSLA.US +``` + +``` +| Time | Price | Avg Price | Volume | Turnover | +|---------------------|---------|-----------|---------|----------------| +| 2026-04-09 13:30:00 | 343.150 | 343.150 | 1234567 | 423567890.000 | +| 2026-04-09 13:31:00 | 344.200 | 343.675 | 987654 | 339876540.000 | +| 2026-04-09 13:32:00 | 343.800 | 343.717 | 876543 | 301234560.000 | +... +``` + +## 示例 + +### 查看今日分時線 + +```bash +longbridge intraday TSLA.US +longbridge intraday TSLA.US --format json +``` + +從開盤至最新一分鐘，每分鐘輸出一條數據，包含價格、均價、成交量和成交額。 + +### 包含美股盤前和盤後數據 + +```bash +longbridge intraday AAPL.US --session all +``` + +```json +[ + { + "avg_price": "258.368439", + "price": "258.330", + "time": "2026-04-09 08:00:00", + "turnover": "97663.270", + "volume": "378" + }, + { + "avg_price": "258.382920", + "price": "258.240", + "time": "2026-04-09 08:01:00", + "turnover": "1622133.447", + "volume": "6278" + } +] +``` + +`--session all` 包含從美東時間約早上 8:00 開始的盤前數據，以及下午 4:00 之後的盤後數據。 diff --git a/docs/zh-HK/docs/cli/market-data/kline.md b/docs/zh-HK/docs/cli/market-data/kline.md new file mode 100644 index 00000000..0c5879b9 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/kline.md @@ -0,0 +1,50 @@ +--- +title: 'kline' +sidebar_label: 'kline' +sidebar_position: 6 +--- + +# longbridge kline + +取得任意標的的 K 線數據，支援多種週期和歷史日期範圍。 + +## 基本用法 + +```bash +longbridge kline TSLA.US --period day --count 3 +``` + +``` +| Time | Open | High | Low | Close | Volume | Turnover | +|---------------------|---------|---------|---------|---------|----------|-----------------| +| 2026-04-07 04:00:00 | 346.440 | 348.020 | 337.240 | 346.650 | 74515355 | 25563965746.000 | +| 2026-04-08 04:00:00 | 363.790 | 364.500 | 339.670 | 343.250 | 78838616 | 27457043487.000 | +| 2026-04-09 04:00:00 | 343.150 | 348.880 | 337.250 | 345.620 | 62164016 | 21375312140.000 | +``` + +## 示例 + +### 日線（最近 100 天，默認） + +```bash +longbridge kline TSLA.US +``` + +默認返回最近 100 根日線，每根包含開盤價、最高價、最低價、收盤價、成交量和成交額。 + +### 不同週期的分時 K 線 + +```bash +longbridge kline TSLA.US --period 1h --count 48 +``` + +使用 `--period` 切換粒度（如 `1m`、`5m`、`15m`、`30m`、`1h`、`day`、`week`、`month`、`year`），用 `--count` 控制返回的 K 線條數。 + +### 歷史區間 + +```bash +longbridge kline TSLA.US --period day --start 2025-01-01 --end 2025-03-31 +longbridge kline TSLA.US --period day --start 2025-01-01 --end 2025-03-31 --format json +``` + +用 `--start` 和 `--end` 指定日期窗口（格式：`YYYY-MM-DD`）取得歷史 K 線。JSON 輸出中的 `time` 欄位表示 K 線開盤時間——美股日線以 UTC 時間表示美東時間零點。 diff --git a/docs/zh-HK/docs/cli/market-data/market-temp.md b/docs/zh-HK/docs/cli/market-data/market-temp.md new file mode 100644 index 00000000..e4b69fe2 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/market-temp.md @@ -0,0 +1,58 @@ +--- +title: 'market-temp' +sidebar_label: 'market-temp' +sidebar_position: 10 +--- + +# longbridge market-temp + +取得 Longbridge 市場溫度指數——結合估值與市場情緒的綜合 0–100 情緒量表。數值越高表示市場越偏多頭。 + +## 基本用法 + +```bash +longbridge market-temp US +``` + +``` +| Field | Value | +|-------------|---------------------------------------| +| Market | US | +| Temperature | 64 | +| Description | Temp Comfortable & Gradually Dropping | +| Valuation | 83 | +| Sentiment | 45 | +``` + +## 示例 + +### 查看當前市場溫度 + +```bash +# 港股市場 +longbridge market-temp HK +# 美股市場 +longbridge market-temp US +# 中國 A 股 +longbridge market-temp CN +# JSON 輸出，適合腳本或監控 +longbridge market-temp US --format json +``` + +支援的市場：`HK`（默認）、`US`、`CN`（別名：`SH`、`SZ`）、`SG`。不帶參數運行默認為 `HK`。 + +### 歷史溫度趨勢 + +```bash +longbridge market-temp US --history --start 2026-04-01 --end 2026-04-09 --format json +``` + +```json +[ + { "description": "", "sentiment": "70", "temperature": "67", "time": "2026-04-01 04:00:00", "valuation": "64" }, + { "description": "", "sentiment": "34", "temperature": "50", "time": "2026-04-02 04:00:00", "valuation": "67" }, + { "description": "", "sentiment": "56", "temperature": "61", "time": "2026-04-06 04:00:00", "valuation": "67" } +] +``` + +返回指定範圍內每個交易日的一條記錄，適合在市場事件前後對情緒變化進行可視化分析。 diff --git a/docs/zh-HK/docs/cli/market-data/participants.md b/docs/zh-HK/docs/cli/market-data/participants.md new file mode 100644 index 00000000..c450ad78 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/participants.md @@ -0,0 +1,42 @@ +--- +title: 'participants' +sidebar_label: 'participants' +sidebar_position: 13 +--- + +# longbridge participants + +取得港股市場的完整券商/參與者目錄——將券商 ID 映射到機構名稱，用於解讀 `brokers` 命令的輸出。 + +## 基本用法 + +```bash +longbridge participants +``` + +``` +| Broker ID | Name EN | Name CN | +|------------|----------------------------------|----------------| +| 6596 | WE | 維恩證券 | +| 3014 | DRW (Hong Kong) Limited | DRW (Hong Kong) Limited | +| 7707, 7708 | Ark Securities (Hong Kong) Ltd | 同舟證券 | +| 724 | UTR8 Hong Kong Limited | UTR8 Hong Kong Limited | +| 1142 | Wanhai Securities (HK) Limited | 萬海證券(香港) | +| 6409 | Standard Chartered(HK) | 渣打(香港) | +... +``` + +## 示例 + +### 查詢所有券商 ID + +```bash +longbridge participants +longbridge participants --format json +``` + +返回港交所參與者的完整目錄，每條包含券商 ID 及機構名稱。部分機構在單個 `broker_id` 字串中列出多個 ID。 + +## 說明 + +僅支援港股市場。配合 `longbridge brokers` 使用，可識別在各價位掛單的機構。此處的 `broker_id` 值與 `brokers` 命令返回的 ID 直接對應。 diff --git a/docs/zh-HK/docs/cli/market-data/quote.md b/docs/zh-HK/docs/cli/market-data/quote.md new file mode 100644 index 00000000..11a8fc76 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/quote.md @@ -0,0 +1,58 @@ +--- +title: 'quote' +sidebar_label: 'quote' +sidebar_position: 1 +--- + +# longbridge quote + +取得一個或多個標的代碼的即時行情——價格、成交量、較前收盤的漲跌幅，以及美股的盤前盤後數據。 + +## 基本用法 + +```bash +longbridge quote TSLA.US NVDA.US +``` + +``` +| Symbol | Last | Prev Close | Open | High | Low | Volume | Turnover | Status | +|---------|---------|------------|---------|---------|---------|-----------|-----------------|--------| +| TSLA.US | 345.620 | 343.250 | 343.150 | 348.880 | 337.250 | 62164016 | 21375312140.000 | Normal | +| NVDA.US | 183.910 | 182.080 | 181.840 | 184.080 | 180.620 | 116428523 | 21303315176.000 | Normal | + +Extended Hours: +| Symbol | Session | Last | High | Low | Volume | Prev Close | Time | +|---------|---------|---------|---------|---------|---------|------------|---------------------| +| TSLA.US | Pre | 343.100 | 346.450 | 339.695 | 945393 | 343.250 | 2026-04-09 13:30:00 | +| TSLA.US | Post | 344.930 | 346.260 | 344.820 | 1348872 | 345.620 | 2026-04-09 23:59:59 | +| NVDA.US | Pre | 181.990 | 182.080 | 180.000 | 1116645 | 182.080 | 2026-04-09 13:30:00 | +| NVDA.US | Post | 183.020 | 183.950 | 182.900 | 6021581 | 183.910 | 2026-04-09 23:59:58 | +``` + +## 示例 + +### 查看單隻股票 + +```bash +longbridge quote TSLA.US +``` + +顯示 TSLA 的最新價、開盤價、最高價、最低價、成交量、成交額及前收盤價。 + +### 跨市場對比多個標的 + +```bash +longbridge quote TSLA.US NVDA.US 700.HK +longbridge quote TSLA.US NVDA.US 700.HK --format json +``` + +在一次調用中傳入多個標的代碼，可並排對比行情。支援不同市場的標的（US、HK、CN）。有盤前盤後數據時，美股輸出中會包含 `pre_market_quote` 和 `post_market_quote` 欄位。 + +### 取得盤前和盤後數據 + +```bash +# pre_market_quote 和 post_market_quote 欄位出現在美股 JSON 輸出中 +longbridge quote TSLA.US --format json +``` + +對於美股，當有盤前盤後數據時，JSON 輸出中包含 `pre_market_quote` 和 `post_market_quote` 物件。在美股正常交易時段內，這兩個欄位為 `null`。 diff --git a/docs/zh-HK/docs/cli/market-data/security-list.md b/docs/zh-HK/docs/cli/market-data/security-list.md new file mode 100644 index 00000000..456ad76b --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/security-list.md @@ -0,0 +1,45 @@ +--- +title: 'security-list' +sidebar_label: 'security-list' +sidebar_position: 12 +--- + +# longbridge security-list + +列出 Longbridge 支援夜盤交易的美股標的。 + +## 基本用法 + +```bash +longbridge security-list +``` + +``` +| Symbol | Name | +|----------|----------------------------| +| GDS.US | GDS | +| ZK.US | ZEEKR Intelligent Tech | +| ALTM.US | Arcadium Lithium | +| HE.US | Hawaiian Electric Inds | +| WB.US | Weibo | +... +``` + +## 示例 + +### 查看可夜盤交易的美股標的 + +```bash +# 默認（美股市場） +longbridge security-list +# 明確指定市場 +longbridge security-list US +# JSON 輸出，可在下單前校驗標的資格 +longbridge security-list US --format json +``` + +返回當前在 Longbridge 支援夜盤交易的美股標的完整列表。使用 `--format json` 取得機器可讀列表，便於自動化資格校驗。 + +## 說明 + +僅支援美股市場（Longbridge API 限制）。此列表會隨資格更新而變化——請在提交夜盤委託前即時查詢，勿依賴緩存數據。 diff --git a/docs/zh-HK/docs/cli/market-data/static.md b/docs/zh-HK/docs/cli/market-data/static.md new file mode 100644 index 00000000..783ad035 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/static.md @@ -0,0 +1,40 @@ +--- +title: 'static' +sidebar_label: 'static' +sidebar_position: 7 +--- + +# longbridge static + +取得任意標的的靜態基本資料——名稱、交易所、貨幣、手數、總股本、EPS、BPS 和股息率。 + +## 基本用法 + +```bash +longbridge static TSLA.US +``` + +``` +| Symbol | Name | Exchange | Currency | Lot Size | Total Shares | Circ. Shares | EPS | EPS TTM | BPS | Dividend | +|---------|-------------|----------|----------|----------|--------------|--------------|--------|---------|--------|----------| +| TSLA.US | Tesla, Inc. | NASD | USD | 1 | 3752431984 | 2812676349 | 1.0111 | 1.0111 | 21.889 | 0 | +``` + +## 示例 + +### 同時查詢多個標的 + +```bash +longbridge static NVDA.US TSLA.US +longbridge static NVDA.US TSLA.US --format json +``` + +一次調用返回所有請求標的的基本資料，適合快速對比基礎屬性。 + +### 交易前確認標的資訊 + +```bash +longbridge static 700.HK +``` + +確認標的有效，並查看其交易所、貨幣、手數及當前股本——下單前的便捷校驗工具。 diff --git a/docs/zh-HK/docs/cli/market-data/subscriptions.md b/docs/zh-HK/docs/cli/market-data/subscriptions.md new file mode 100644 index 00000000..666a0cc1 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/subscriptions.md @@ -0,0 +1,38 @@ +--- +title: 'subscriptions' +sidebar_label: 'subscriptions' +sidebar_position: 14 +--- + +# longbridge subscriptions + +列出當前所有有效的即時行情訂閱。 + +## 基本用法 + +```bash +longbridge subscriptions +``` + +## 示例 + +### 查看有效訂閱 + +```bash +longbridge subscriptions +``` + +返回當前已訂閱即時行情推送的所有標的，以及訂閱類型（如 quote、depth、trades）。 + +### 排查行情推送中斷問題 + +```bash +# 查看當前會話中已訂閱的標的 +longbridge subscriptions +``` + +若即時行情推送中斷，運行 `subscriptions` 確認該標的是否仍處於有效訂閱狀態。訂閱與會話綁定——每次啟動新會話時會重置。 + +## 說明 + +若無有效訂閱，返回空列表。訂閱通過 TUI 創建（或通過 OpenAPI SDK 以程式化方式創建），與會話綁定，退出登錄或會話過期後自動重置。 diff --git a/docs/zh-HK/docs/cli/market-data/trades.md b/docs/zh-HK/docs/cli/market-data/trades.md new file mode 100644 index 00000000..6d801d47 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/trades.md @@ -0,0 +1,53 @@ +--- +title: 'trades' +sidebar_label: 'trades' +sidebar_position: 4 +--- + +# longbridge trades + +取得某標的的最近逐筆成交記錄，包括價格、成交量、時間和成交方向。 + +## 基本用法 + +```bash +longbridge trades TSLA.US +``` + +``` +| Time | Price | Volume | Direction | Type | +|---------------------|---------|--------|-----------|------| +| 2026-04-09 23:59:43 | 344.940 | 5 | Down | I | +| 2026-04-09 23:59:43 | 344.940 | 40 | Down | | +| 2026-04-09 23:59:44 | 344.980 | 40 | Up | | +| 2026-04-09 23:59:44 | 344.980 | 5 | Up | I | +| 2026-04-09 23:59:45 | 344.970 | 1 | Down | I | +| 2026-04-09 23:59:52 | 344.975 | 100 | Neutral | | +``` + +## 示例 + +### 查看最近 20 條成交記錄 + +```bash +longbridge trades TSLA.US +``` + +返回 TSLA 最近 20 筆成交，每筆顯示價格、成交量、時間戳和成交方向。 + +### 用 --count 取得更多成交記錄 + +```bash +longbridge trades TSLA.US --count 50 +``` + +使用 `--count` 可在單次調用中取得最多 50 條（或更多）最近成交記錄。 + +### 從成交方向判斷買賣壓力 + +```bash +# direction 欄位顯示相對於前一筆成交的方向：Up、Down 或 Neutral +longbridge trades TSLA.US --count 50 --format json +``` + +每條記錄包含 `direction` 欄位，表示本筆成交價格相對於前一筆是上漲、下跌還是持平，可用於判斷短期動能。 diff --git a/docs/zh-HK/docs/cli/market-data/trading.md b/docs/zh-HK/docs/cli/market-data/trading.md new file mode 100644 index 00000000..bf223760 --- /dev/null +++ b/docs/zh-HK/docs/cli/market-data/trading.md @@ -0,0 +1,78 @@ +--- +title: 'trading' +sidebar_label: 'trading' +sidebar_position: 11 +--- + +# longbridge trading + +查詢任意市場的交易時段安排和交易日曆。 + +## 基本用法 + +```bash +longbridge trading session +``` + +``` +| Market | Session | Open | Close | +|--------|----------|----------|----------| +| US | Pre | 04:00:00 | 09:30:00 | +| US | Intraday | 09:30:00 | 16:00:00 | +| US | Post | 16:00:00 | 20:00:00 | +| HK | Intraday | 09:30:00 | 12:00:00 | +| HK | Intraday | 13:00:00 | 16:00:00 | +``` + +## 示例 + +### 查看所有市場的交易時段 + +```bash +longbridge trading session --format json +``` + +```json +[ + { + "market": "US", + "sessions": [ + { "close": "9:30:00.0", "open": "4:00:00.0", "session": "Pre" }, + { "close": "16:00:00.0", "open": "9:30:00.0", "session": "Intraday" }, + { "close": "20:00:00.0", "open": "16:00:00.0", "session": "Post" } + ] + }, + { + "market": "HK", + "sessions": [ + { "close": "12:00:00.0", "open": "9:30:00.0", "session": "Intraday" }, + { "close": "16:00:00.0", "open": "13:00:00.0", "session": "Intraday" } + ] + } +] +``` + +美股有三個交易時段（盤前、盤中、盤後）；港股有兩個盤中時段，中間有午休間隔。 + +### 查詢日期範圍內的交易日曆 + +```bash +longbridge trading days HK --start 2026-04-01 --end 2026-04-10 --format json +``` + +```json +{ + "half_trading_days": [], + "trading_days": ["2026-04-01", "2026-04-02", "2026-04-08", "2026-04-09", "2026-04-10"] +} +``` + +返回指定範圍內的完整交易日列表及半日市列表，公眾假期自動排除。 + +### 查看今天是否為交易日 + +```bash +longbridge trading days US +``` + +省略 `--start` 和 `--end` 返回今日交易狀態。若今天是交易日，則出現在 `trading_days` 列表中。 diff --git a/docs/zh-HK/docs/cli/orders/_category_.json b/docs/zh-HK/docs/cli/orders/_category_.json new file mode 100644 index 00000000..bc69b965 --- /dev/null +++ b/docs/zh-HK/docs/cli/orders/_category_.json @@ -0,0 +1 @@ +{ "label": "委託與交易", "icon": "arrow-right-left", "position": 8, "collapsed": true } diff --git a/docs/zh-HK/docs/cli/orders/exchange-rate.md b/docs/zh-HK/docs/cli/orders/exchange-rate.md new file mode 100644 index 00000000..7092a1e1 --- /dev/null +++ b/docs/zh-HK/docs/cli/orders/exchange-rate.md @@ -0,0 +1,39 @@ +--- +title: 'exchange-rate' +sidebar_label: 'exchange-rate' +sidebar_position: 4 +--- + +# longbridge exchange-rate + +取得 Longbridge 帳戶中所有貨幣對的當前匯率。 + +## 基本用法 + +```bash +longbridge exchange-rate +``` + +``` +| pair | average_rate | bid_rate | offer_rate | +|-----------|--------------|----------|------------| +| HKD → CNH | 1.1465 | 1.1465 | 1.1465 | +| HKD → HKD | 1 | 1 | 1 | +| HKD → USD | 7.7925 | 7.7925 | 7.7925 | +| HKD → CNY | 1.1465 | 1.1465 | 1.1465 | +``` + +## 示例 + +### 查看所有匯率 + +```bash +longbridge exchange-rate +longbridge exchange-rate --format json +``` + +顯示帳戶中所有可用貨幣對（如 HKD/USD、HKD/CNH）的買入價、賣出價和中間價。所有匯率以港幣（HKD）為基準貨幣報價。 + +## 權限要求 + +無需登錄，此命令無需鑑權即可使用。 diff --git a/docs/zh-HK/docs/cli/orders/margin-ratio.md b/docs/zh-HK/docs/cli/orders/margin-ratio.md new file mode 100644 index 00000000..85ec66cd --- /dev/null +++ b/docs/zh-HK/docs/cli/orders/margin-ratio.md @@ -0,0 +1,48 @@ +--- +title: 'margin-ratio' +sidebar_label: 'margin-ratio' +sidebar_position: 2 +--- + +# longbridge margin-ratio + +查詢某標的的保證金要求——初始保證金比率、維持保證金比率和強平比率。 + +## 基本用法 + +```bash +longbridge margin-ratio TSLA.US +``` + +``` +| Field | Value | +|--------------------------|---------| +| Symbol | TSLA.US | +| Initial Margin Ratio | 0.35 | +| Maintenance Margin Ratio | 0.33 | +| Forced Liquidation Ratio | 0.25 | +``` + +## 示例 + +### 融資買入前查看保證金要求 + +```bash +longbridge margin-ratio TSLA.US +# JSON 輸出，適合腳本使用 +longbridge margin-ratio TSLA.US --format json +``` + +顯示該標的的初始保證金比率、維持保證金比率和強平比率。在進行融資買入前使用，了解所需資金要求。 + +### 對比多個標的 + +```bash +longbridge margin-ratio TSLA.US NVDA.US +``` + +傳入多個標的，並排對比各自的保證金要求。 + +## 權限要求 + +查詢保證金比率需要 OAuth 交易或帳戶權限。詳見 [交易權限](/zh-HK/docs/trade/) 設定說明。 diff --git a/docs/zh-HK/docs/cli/orders/max-qty.md b/docs/zh-HK/docs/cli/orders/max-qty.md new file mode 100644 index 00000000..97c0c4fa --- /dev/null +++ b/docs/zh-HK/docs/cli/orders/max-qty.md @@ -0,0 +1,47 @@ +--- +title: 'max-qty' +sidebar_label: 'max-qty' +sidebar_position: 3 +--- + +# longbridge max-qty + +根據當前帳戶餘額和指定價格，估算最大可買入或賣出數量。 + +## 基本用法 + +```bash +longbridge max-qty TSLA.US --side buy --price 340.00 +``` + +``` +| Field | Value | +|----------------|---------| +| Symbol | TSLA.US | +| Cash Max Qty | 0 | +| Margin Max Qty | 896 | +``` + +## 示例 + +### 查詢指定價格下的最大買入數量 + +```bash +longbridge max-qty TSLA.US --side buy --price 340.00 +# JSON 輸出，適合腳本使用 +longbridge max-qty TSLA.US --side buy --price 340.00 --format json +``` + +返回按給定價格可買入的最大股數，分別按現金和融資購買力拆分顯示。 + +### 查詢最大賣出數量 + +```bash +longbridge max-qty TSLA.US --side sell +``` + +根據當前持倉返回最大可賣出股數。 + +## 權限要求 + +查詢最大可委託數量需要 OAuth 交易或帳戶權限。詳見 [交易權限](/zh-HK/docs/trade/) 設定說明。 diff --git a/docs/zh-HK/docs/cli/orders/order.md b/docs/zh-HK/docs/cli/orders/order.md new file mode 100644 index 00000000..373a25ca --- /dev/null +++ b/docs/zh-HK/docs/cli/orders/order.md @@ -0,0 +1,100 @@ +--- +title: 'order' +sidebar_label: 'order' +sidebar_position: 1 +--- + +# longbridge order + +查看委託記錄和成交明細，或直接在終端提交買入/賣出委託。 + +## 基本用法 + +```bash +longbridge order +``` + +``` +| Order ID | Symbol | Side | Order Type | Status | Qty | Price | Exec Qty | Exec Price | Created At | +|--------------------|---------|------|------------|---------------|-----|--------|----------|------------|---------------------| +| 701276261045858304 | TSLA.US | Buy | LO | Filled | 10 | 340.00 | 10 | 339.85 | 2026-04-10 09:32:14 | +| 701276261045858305 | NVDA.US | Sell | LO | PartialFilled | 20 | 185.00 | 12 | 185.00 | 2026-04-10 09:45:01 | +| 701276261045858306 | AAPL.US | Buy | MO | New | 5 | - | 0 | - | 2026-04-10 10:01:33 | +``` + +## 示例 + +### 查看今日委託 + +```bash +longbridge order +``` + +列出今日所有委託及其狀態、標的代碼、數量、價格和委託 ID。 + +### 查詢指定標的的歷史委託 + +```bash +longbridge order --history --start 2026-01-01 --symbol TSLA.US +``` + +按標的和日期範圍篩選歷史委託。使用 `--start` 和 `--end` 設定日期窗口。 + +### 提交限價買入委託 + +```bash +longbridge order buy TSLA.US 10 --price 340.00 +``` + +以 340.00 美元的價格對 TSLA 提交 10 股限價買入委託。命令在提交前會提示確認。 + +### 提交限價賣出委託 + +```bash +longbridge order sell TSLA.US 5 --price 360.00 +``` + +以 360.00 美元的價格對 TSLA 提交 5 股限價賣出委託。命令在提交前會提示確認。 + +### 查看成交記錄 + +```bash +longbridge order executions +``` + +列出當日所有已成交的委託，包括成交價格、數量和時間。 + +### 查看委託詳情 + +```bash +# 查詢指定委託的完整詳情 +longbridge order detail 701276261045858304 +``` + +返回該委託的成交明細、時間戳和成交資訊。 + +### 撤銷待成交委託 + +```bash +# 撤單前會提示確認 +longbridge order cancel 701276261045858304 +``` + +僅接受處於可撤狀態的委託（New、PartialFilled 等）。在腳本中使用 `-y` 跳過確認提示。 + +### 修改未成交委託 + +```bash +# 修改待成交委託的數量或價格 +longbridge order replace 701276261045858304 --qty 5 --price 350.00 +``` + +`--qty` 為必填項。省略 `--price` 則保持當前限價不變。在腳本中使用 `-y` 跳過確認提示。 + +## 權限要求 + +提交、撤銷或修改委託需要 OAuth 交易權限。詳見 [交易權限設定](/zh-HK/docs/trade/) 指南以開啟交易存取。 + +## 說明 + +`buy` 和 `sell` 在提交前始終提示確認。在腳本場景中使用 `cancel` 和 `replace` 時，可加 `-y` 跳過確認。 diff --git a/docs/zh-HK/docs/cli/release-notes.md b/docs/zh-HK/docs/cli/release-notes.md new file mode 100644 index 00000000..9105e17d --- /dev/null +++ b/docs/zh-HK/docs/cli/release-notes.md @@ -0,0 +1,45 @@ +--- +title: 'Release Notes' +sidebar_label: 'Release Notes' +sidebar_position: 100 +--- + +# Release Notes + +### [v0.15.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.15.0) + +- **新增：`portfolio` 命令** — 顯示總盈虧、各市場資產分佈（美股/港股/A 股/新加坡/現金）、持倉明細和現金餘額 +- **新增：`investors` 命令** — 基於 SEC 13F 的活躍基金經理排行榜；透過 CIK 查看任意投資者的持倉及即時價格 +- **新增：`insider-trades`** — 任意標的的 SEC Form 4 內部人交易歷史 +- **新增：`watchlist pin/unpin`** — 將證券置頂到自選股分組頂部 +- **增強：`assets`** — 從 `balance` 更名；現在顯示完整資產概覽：淨資產、購買力、保證金、風險等級及各幣種現金明細 + +### [v0.14.2](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.2) + +- **新增：`--lang` 全域參數** — 為所有命令設定內容語言（`zh-CN`、`zh-HK`、`en`）；未設定時依次回退到系統 `LANG` 環境變數，最終預設 `en` + +### [v0.14.1](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.1) + +- **新增：中國區登入** — `longbridge login` 現在支援中國區路由 +- **新增：`-v` 參數** — 無需輸入完整命令即可查看版本號 + +### [v0.14.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.14.0) + +- **新增：裝置授權登入** — `longbridge login` 改用 OAuth 裝置流程；顯示 URL 和授權碼，可在任意裝置上完成授權，支援 SSH 和無頭環境；移除了 `--headless` 參數 +- **新增：訂單增強** — 新增追蹤止損和 AO 訂單類型；訂單命令新增 `--expire-date`、`--outside-rth`、`--remark` 參數 +- **修復：Linux 段錯誤** — 預編譯 Linux 二進位檔案改用 musl，修復在部分發行版上的崩潰問題 + +### [v0.13.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.13.0) + +- **新增：基本面與分析命令** — `financial-report`、`valuation`、`forecast-eps`、`consensus`、`institution-rating`、`shareholder`、`fund-holder`、`dividend`、`finance-calendar`、`exchange-rate` +- **破壞性變更：命令重構** — 19 個獨立命令合併為子命令樹（例如 `news-detail` → `news detail`、`kline-history` → `kline history`、`warrant-list` → `warrant list`） +- **支援中國區** — 設定 `LONGBRIDGE_REGION=cn` 以透過中國區端點路由 + +### [v0.12.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.12.0) + +- **新增：`statement` 命令** — 列出並匯出日/月帳戶結單 +- **TUI** — 修復 `q` 退出；在自選股內新增資訊列表和詳情視圖 + +--- + +完整更新日誌：[github.com/longbridge/longbridge-terminal/releases](https://github.com/longbridge/longbridge-terminal/releases) diff --git a/docs/zh-HK/docs/cli/research/_category_.json b/docs/zh-HK/docs/cli/research/_category_.json new file mode 100644 index 00000000..9d8812a5 --- /dev/null +++ b/docs/zh-HK/docs/cli/research/_category_.json @@ -0,0 +1 @@ +{ "label": "研究分析", "icon": "search", "position": 6, "collapsed": true } diff --git a/docs/zh-HK/docs/cli/research/insider-trades.md b/docs/zh-HK/docs/cli/research/insider-trades.md new file mode 100644 index 00000000..f0055e71 --- /dev/null +++ b/docs/zh-HK/docs/cli/research/insider-trades.md @@ -0,0 +1,49 @@ +--- +title: 'insider-trades' +sidebar_label: 'insider-trades' +sidebar_position: 2 +--- + +# longbridge insider-trades + +查看任意美股的 [SEC Form 4](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40) 內幕交易歷史——公司內部人士的買入、賣出及期權行權記錄。 + +## 基本用法 + +```bash +longbridge insider-trades TSLA.US +``` + +``` +| date | filer | title | type | shares | price | value | owned_after | +|------------|--------------|---------------|----------|--------|---------|----------|-------------| +| 2026-03-31 | Zhu Xiaotong | SVP | EXERCISE | 20.00K | $20.57 | $411.40K | 20.00K | +| 2025-09-11 | Zhu Xiaotong | SVP, APAC and | SELL | 20.00K | $363.75 | $7.28M | 47.60K | +| 2025-06-12 | Zhu Xiaotong | SVP, APAC | EXERCISE | 15.00K | $20.57 | $308.55K | 82.60K | +| 2025-06-12 | Zhu Xiaotong | SVP, APAC | SELL | 15.00K | $323.81 | $4.86M | 67.60K | +``` + +## 示例 + +### 查看內幕交易動態 + +```bash +longbridge insider-trades TSLA.US +longbridge insider-trades TSLA.US --format json +``` + +列出最新內幕交易記錄，包含內部人士姓名、職務、交易日期、類型、股數及價格。 + +### 擴展申報歷史範圍 + +```bash +# 取得更多申報文件以覆蓋更寬泛的日期範圍 +longbridge insider-trades TSLA.US --count 100 +longbridge insider-trades AAPL.US --count 100 --format json +``` + +使用 `--count` 取得更多 Form 4 申報文件，覆蓋更長時間窗口。適用於追蹤財報公告前後或重大公司事件期間的內幕交易活動。 + +## 說明 + +僅限美股市場。數據來源：[SEC EDGAR Form 4 申報](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=4&dateb=&owner=include&count=40)。 diff --git a/docs/zh-HK/docs/cli/research/investors.md b/docs/zh-HK/docs/cli/research/investors.md new file mode 100644 index 00000000..87112b2e --- /dev/null +++ b/docs/zh-HK/docs/cli/research/investors.md @@ -0,0 +1,56 @@ +--- +title: 'investors' +sidebar_label: 'investors' +sidebar_position: 3 +--- + +# longbridge investors + +瀏覽按 AUM 排名的活躍機構基金經理（數據來自 [SEC 13F 申報](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=13F&dateb=&owner=include&count=40)），並深入查看任意基金經理的當前持倉。 + +## 基本用法 + +```bash +longbridge investors +``` + +``` +| # | name | AUM | period | cik | +|----|-----------------------------------|----------|-------------|------------| +| 1 | Capital International Investors | $637.97B | 31-DEC-2025 | 0001562230 | +| 2 | Capital Research Global Investors | $541.73B | 31-DEC-2025 | 0001422848 | +| 3 | CTC LLC | $404.44B | 31-DEC-2025 | 0001445893 | +| 4 | BERKSHIRE HATHAWAY INC | $274.16B | 31-DEC-2025 | 0001067983 | +| 5 | DODGE & COX | $185.26B | 31-DEC-2025 | 0000200217 | +... +``` + +## 示例 + +### 瀏覽頂級基金經理 + +列出按 AUM 排名的最大機構投資者，包含 CIK 標識符、名稱、報告 AUM 及最新 [13F 申報](https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&type=13F&dateb=&owner=include&count=40)的報告期。 + +### 查看基金經理持倉 + +```bash +# 使用投資者列表中的 CIK 深入查看持倉 +longbridge investors 0001067983 +longbridge investors 0001067983 --format json +``` + +``` +BERKSHIRE HATHAWAY INC (period: 2025-12-31) +Portfolio: 42 positions, total value ~$274.16B + +| company | value | shares | weight | +|-----------------------|---------|---------|--------| +| APPLE INC | $61.96B | 227.92M | 22.6% | +| AMERICAN EXPRESS CO | $56.09B | 151.61M | 20.5% | +| BANK AMERICA CORP | $28.45B | 517.30M | 10.4% | +| COCA COLA CO | $27.96B | 400.00M | 10.2% | +| CHEVRON CORP NEW | $19.84B | 130.16M | 7.2% | +... +``` + +傳入 CIK 可查看該基金經理申報的完整股票持倉列表。CIK `0001067983` 為伯克希爾·哈撒韋。 diff --git a/docs/zh-HK/docs/cli/research/shareholder.md b/docs/zh-HK/docs/cli/research/shareholder.md new file mode 100644 index 00000000..bcb1a95d --- /dev/null +++ b/docs/zh-HK/docs/cli/research/shareholder.md @@ -0,0 +1,36 @@ +--- +title: 'shareholder' +sidebar_label: 'shareholder' +sidebar_position: 1 +--- + +# longbridge shareholder + +查看公司主要股東——機構和個人——及其持股比例和最新持股變動。 + +## 基本用法 + +```bash +longbridge shareholder TSLA.US +``` + +``` +| shareholder | symbol | % shares | chg shares | report_date | +|------------------------------------|--------|----------|------------|-------------| +| Elon R. Musk | - | 24.86% | +423.53M | 2025-12-30 | +| The Vanguard Group, Inc. | - | 6.90% | +6.54M | 2025-12-31 | +| BlackRock, Inc. | BLK.US | 5.57% | +2.81M | 2025-12-31 | +| State Street Global Advisors, Inc. | - | 3.06% | +1.08M | 2025-12-31 | +| Geode Capital Management, LLC | - | 1.75% | +375.95K | 2025-12-31 | +``` + +## 示例 + +### 查看主要股東 + +```bash +longbridge shareholder TSLA.US +longbridge shareholder TSLA.US --format json +``` + +按持股比例列出最大股東，包括機構投資者和個人內部人士。 diff --git a/docs/zh-HK/docs/cli/tui.md b/docs/zh-HK/docs/cli/tui.md new file mode 100644 index 00000000..71e2c5e2 --- /dev/null +++ b/docs/zh-HK/docs/cli/tui.md @@ -0,0 +1,39 @@ +--- +title: 'tui' +sidebar_label: 'TUI' +sidebar_position: 99 +--- + +# longbridge tui + +啟動互動式全螢幕終端介面（TUI）——即時交易看板，包含自選股管理、即時 K 線圖表、持倉視圖和股票搜尋。支援 Vim 風格快捷鍵。 + +## 基本用法 + +```bash +longbridge tui +``` + + + longbridge tui demo + + +## 示例 + +### 即時監控自選股 + +TUI 打開後展示自選股列表，即時顯示價格、漲跌幅和成交量。使用 `j`/`k` 或方向鍵在股票間導航。 + +### 查看 K 線圖表 + +在任意標的上按 `Enter` 進入股票詳情頁，顯示即時 K 線圖。使用 `1m`、`5m`、`1h`、`1d` 快捷鍵切換時間週期。 + +### 搜尋並添加標的 + +按 `/` 打開搜尋浮層，輸入名稱或代碼即可查找並添加到自選股。 + +## 注意事項 + +- 需要有效的 `longbridge login` 登入會話 +- TUI 與 CLI 命令共用同一個 token +- 按 `q` 或 `Ctrl+C` 退出 diff --git a/docs/zh-HK/docs/cli/watchlist/_category_.json b/docs/zh-HK/docs/cli/watchlist/_category_.json new file mode 100644 index 00000000..6e0a2251 --- /dev/null +++ b/docs/zh-HK/docs/cli/watchlist/_category_.json @@ -0,0 +1 @@ +{ "label": "自選", "icon": "star", "position": 9, "collapsed": true } diff --git a/docs/zh-HK/docs/cli/watchlist/watchlist.md b/docs/zh-HK/docs/cli/watchlist/watchlist.md new file mode 100644 index 00000000..2510e0af --- /dev/null +++ b/docs/zh-HK/docs/cli/watchlist/watchlist.md @@ -0,0 +1,102 @@ +--- +title: 'watchlist' +sidebar_label: 'watchlist' +sidebar_position: 1 +--- + +# longbridge watchlist + +查看和管理 Longbridge 自選股——列出分組、添加或刪除標的、創建新分組，以及將標的置頂。 + +## 基本用法 + +```bash +longbridge watchlist +``` + +``` +Group: all (ID: 2630) +| Symbol | Name | Market | Pinned | +|------------|------------------------------------|--------|--------| +| SPY.US | SPDR S&P 500 | US | yes | +| QQQ.US | Invesco QQQ Trust | US | yes | +| TSLA.US | Tesla | US | | +| AAPL.US | Apple | US | | +| QQQI.US | NEOS Nasdaq-100(R) High Income ETF | US | | +``` + +## 示例 + +### 查看所有自選分組及其標的 + +```bash +longbridge watchlist +``` + +```json +[ + { + "id": 2630, + "name": "all", + "securities": [ + { "is_pinned": true, "market": "US", "name": "SPDR S&P 500", "symbol": "SPY.US" }, + { "is_pinned": true, "market": "US", "name": "Invesco QQQ Trust", "symbol": "QQQ.US" }, + { "is_pinned": false, "market": "US", "name": "Tesla", "symbol": "TSLA.US" } + ] + } +] +``` + +列出所有自選分組及其 ID、名稱和標的。`update`、`pin`、`delete` 子命令均需要分組 ID。 + +### 向分組添加標的 + +```bash +longbridge watchlist update 2630 --add NVDA.US --add AAPL.US +``` + +向已有分組添加一個或多個標的。先運行 `longbridge watchlist` 查找分組 ID。 + +### 從分組移除標的 + +```bash +longbridge watchlist update 2630 --remove NVDA.US --remove AAPL.US +``` + +從已有分組移除一個或多個標的。先運行 `longbridge watchlist` 確認分組 ID 及當前標的列表。 + +### 創建新自選分組 + +```bash +longbridge watchlist create "Tech Stocks" +``` + +以指定名稱創建一個新的空自選分組，之後使用 `update` 添加標的。 + +### 重命名分組 + +```bash +longbridge watchlist update 2630 --name "New Name" +``` + +重命名已有自選分組。先運行 `longbridge watchlist` 查找分組 ID。 + +### 將標的置頂 + +```bash +longbridge watchlist pin 2630 TSLA.US +``` + +將標的置頂顯示在自選分組頂部。已置頂的標的在輸出中顯示 `is_pinned: true`。對已置頂標的再次執行此命令可取消置頂。 + +### 刪除分組 + +```bash +longbridge watchlist delete 2630 +``` + +永久刪除自選分組及其所有標的。刪除前先運行 `longbridge watchlist` 確認分組 ID。 + +## 權限要求 + +需要有效的 OAuth 登入。未登入時請先運行 `longbridge login`。 diff --git a/docs/zh-HK/docs/content/_category_.json b/docs/zh-HK/docs/content/_category_.json index df08de50..ae4dd416 100644 --- a/docs/zh-HK/docs/content/_category_.json +++ b/docs/zh-HK/docs/content/_category_.json @@ -1 +1,8 @@ -{ "label": "社區", "collapsible": true, "collapsed": true, "link": null, "position": 4.5 } +{ + "label": "社區", + "collapsible": true, + "collapsed": true, + "link": null, + "position": 4.5, + "icon": "newspaper" +} diff --git a/docs/zh-HK/docs/qa/_category_.json b/docs/zh-HK/docs/qa/_category_.json index 5fbb875c..7b212186 100644 --- a/docs/zh-HK/docs/qa/_category_.json +++ b/docs/zh-HK/docs/qa/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": true, "link": null, - "position": 6.5 + "position": 6.5, + "icon": "book-open" } diff --git a/docs/zh-HK/docs/quote/_category_.json b/docs/zh-HK/docs/quote/_category_.json index 4a190eb5..85c561b2 100644 --- a/docs/zh-HK/docs/quote/_category_.json +++ b/docs/zh-HK/docs/quote/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": false, "link": null, - "position": 3 + "position": 3, + "icon": "bar-chart-2" } diff --git a/docs/zh-HK/docs/socket/_category_.json b/docs/zh-HK/docs/socket/_category_.json index 8f1227b8..edd00b9b 100644 --- a/docs/zh-HK/docs/socket/_category_.json +++ b/docs/zh-HK/docs/socket/_category_.json @@ -3,5 +3,6 @@ "label": "Socket 即時推送", "collapsible": true, "collapsed": true, - "link": null + "link": null, + "icon": "zap" } diff --git a/docs/zh-HK/docs/trade/_category_.json b/docs/zh-HK/docs/trade/_category_.json index 0cf4aee6..5257d9a3 100644 --- a/docs/zh-HK/docs/trade/_category_.json +++ b/docs/zh-HK/docs/trade/_category_.json @@ -3,5 +3,6 @@ "collapsible": true, "collapsed": false, "position": 4, - "link": null + "link": null, + "icon": "trending-up" }