financialdatasets-cli
v0.0.3
Published
CLI for Financial Datasets API - command-line interface for accessing financial market data
Maintainers
Readme
@simonxabris/financialdatasets-cli
A command-line interface for the Financial Datasets API. Query stock prices, crypto data, financial statements, earnings reports, news, SEC filings, insider trades, and more.
Installation
# npm
npm install -g @simonxabris/financialdatasets-cli
# pnpm
pnpm add -g @simonxabris/financialdatasets-cli
# bun
bun add -g @simonxabris/financialdatasets-cliSetup
Get an API key at financialdatasets.ai.
Make sure it's available in the environment as FINANCIAL_DATASETS_API_KEY
Usage
financialdatasets <command> [options]Commands
Prices
# Historical stock prices
financialdatasets prices historical --ticker AAPL --start-date 2024-01-01 --end-date 2024-01-31
# Latest price snapshot
financialdatasets prices snapshot --ticker AAPLCrypto
# Historical crypto prices
financialdatasets crypto historical --ticker BTC-USD --start-date 2024-01-01 --end-date 2024-01-31
# Latest crypto snapshot
financialdatasets crypto snapshot --ticker BTC-USDCompany
# Company facts and information
financialdatasets company facts --ticker AAPLEarnings
# Earnings press releases
financialdatasets earnings press-releases --ticker AAPLFinancials
# All financial statements
financialdatasets financials all --ticker AAPL --period annual --limit 5
# Income statements only
financialdatasets financials income-statements --ticker AAPL --period annual --limit 5
# Balance sheets
financialdatasets financials balance-sheets --ticker AAPL --period quarterly
# Cash flow statements
financialdatasets financials cash-flow-statements --ticker AAPL --period ttmNews
# Company news
financialdatasets news --ticker AAPL --limit 20SEC Filings
# List filings
financialdatasets filings list --ticker AAPL --filing-type 10-K
# Get specific filing items
financialdatasets filings items --ticker AAPL --filing-type 10-K --year 2024 --item Item-1Insider Trades
financialdatasets insider-trades --ticker AAPL --limit 50Institutional Ownership
financialdatasets institutional-ownership --ticker AAPL --limit 20Financial Metrics
# Historical metrics
financialdatasets financial-metrics historical --ticker AAPL --period annual --limit 5
# Latest metrics snapshot
financialdatasets financial-metrics snapshot --ticker AAPLHelp
Get help for any command:
financialdatasets --help
financialdatasets prices --help
financialdatasets prices historical --helpOutput
All commands return raw JSON responses from the API.
Requirements
- Node.js >= 18.0.0
- FINANCIAL_DATASETS_API_KEY environment variable
