@investoday/investoday-api
v1.9.4
Published
CLI for accessing InvestToday China market financial data via investoday-api.
Maintainers
Readme
@investoday/investoday-api
Official CLI for accessing InvestToday China market financial data.
Install
npm install -g @investoday/investoday-apiAPI key
Configure the API key once:
investoday-api initNon-interactive one-shot initialization:
investoday-api init --api-key "<API_KEY>" --auto-update --skip-verifyEnable or disable background auto update during initialization:
investoday-api init --auto-update
investoday-api init --no-auto-updateGet an API key from:
- https://data-api.investoday.net/user/api-key
API base URL
The default API base URL is:
https://data-api.investoday.net/dataTemporarily override it with an environment variable:
INVESTODAY_API_BASE_URL="https://data-api.investoday.net/data" investoday-api listPersist a custom value in the local config:
investoday-api config set-base-url "https://data-api.investoday.net/data"
investoday-api config reset-base-urlUsage
investoday-api --help
investoday-api init
investoday-api config status
investoday-api config path
investoday-api config remove
investoday-api config set-base-url "https://data-api.investoday.net/data"
investoday-api config reset-base-url
investoday-api update status
investoday-api update run
investoday-api update enable
investoday-api update disable
investoday-api update register
investoday-api update unregister
investoday-api skill list
investoday-api skill search 股票
investoday-api skill target list
investoday-api skill install investoday-finance-data --target "<SKILLS_DIR>"
investoday-api skill install investoday-finance-data --target-code "<TARGET_CODE>"
investoday-api list
investoday-api list 沪深京数据
investoday-api search-api query=违规处罚 tool_ids=list_stock_violation_penalt
investoday-api search-api query=股票,基本面分析
investoday-api search-api query=股票 --text
investoday-api <endpoint> [key=value ...]
investoday-api <endpoint> --method POST [key=value ...]
investoday-api <endpoint> --method POST [queryKey=value ...] --body-json '{"bodyKey":[]}'Examples:
investoday-api list 沪深京数据/股票行情
investoday-api search-api query=stockCodes
investoday-api search-api query=股票,基本面分析
investoday-api search-api tool_ids=list_stock_violation_penalt,list_stock_report_schema
investoday-api search-api query=股票 --text
investoday-api skill list --page 1 --page-size 20
investoday-api skill list --api-key "<API_KEY>"
investoday-api skill search 股票 --json
investoday-api skill target list --json
investoday-api skill install investoday-finance-data --target "<SKILLS_DIR>"
investoday-api skill install investoday-finance-data --target-code "<TARGET_CODE>"
investoday-api stock/basic-info stockCode=600519
investoday-api search key=贵州茅台 type=11
investoday-api fund/daily-quotes --method POST fundCode=000001 beginDate=2024-01-01 endDate=2024-12-31
investoday-api industry-quote/realtime-v2 --method POST industryLevel=1 industryType=SW sortColumn=changeRatio order=desc pageSize=10 --body-json '{"industryCodes":[]}'Background updates
investoday-api can periodically update the CLI package and installed skills after user authorization.
# Show task registration status, last run, errors, next run, and local/remote versions
investoday-api update status
# Run one update immediately; skips when auto update is disabled
investoday-api update run
# Enable auto update and register the user-level scheduled task
investoday-api update enable
# Disable auto update and unregister the scheduled task
investoday-api update disable
# Register or repair the scheduled task without changing the enabled flag
investoday-api update register
# Unregister only the scheduled task without changing the enabled flag
investoday-api update unregisterThe default manifest URL is:
https://storage.txyun.investoday.net/application/skill-store/configs/investoday-api.manifest.jsonFor debugging, staging, or private deployments, override it with:
INVESTODAY_API_UPDATE_MANIFEST_URL=https://example.com/investoday-api.manifest.json investoday-api update statusConfig commands
# Show whether the API key is configured and where it is loaded from
investoday-api config status
# Print the local config file path
investoday-api config path
# Remove the local config and legacy credential files
investoday-api config removeNotes
- Uses the local JSON config created by
investoday-api init - Only calls
https://data-api.investoday.net/data - Bundles endpoint metadata for
listandsearch-api search-apidefaults to JSON output and includes params, response fields, andexampleCommand; use--textfor a human-readable summarysearch-apionly accepts structured inputs such asquery=andtool_ids=;query=accepts one value and supports comma-separated keywords- For POST endpoints with JSON body parameters, pass query parameters as
key=valueand pass body parameters with--body-json - Background update settings are stored in the local JSON config and can be inspected with
investoday-api update status - Prints the API response
datafield as formatted JSON
