massive-cli 0.0.1

package/dist/references/options_commands.md

@@ -0,0 +1,258 @@
+# Options Commands Reference
+
+This document provides a reference for the options-related commands available in the Polygon CLI.
+
+## Commands
+
+### options-aggs
+Get aggregate bars (OHLCV) for an options contract over a given date range.
+
+**Usage:**
+```bash
+bun cli.js options-aggs --ticker <ticker> --from <YYYY-MM-DD> --to <YYYY-MM-DD> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol (e.g., O:AAPL230616C00150000).
+- `--from` (required): Start date (YYYY-MM-DD).
+- `--to` (required): End date (YYYY-MM-DD).
+- `--multiplier` (number): Timespan multiplier (default: 1).
+- `--timespan` (string): Timespan unit (default: 'day'). Values: `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
+- `--adjusted` (boolean): Whether to adjust for splits (default: true).
+- `--sort` (string): Sort order (default: 'asc'). Values: `asc`, `desc`.
+- `--limit` (number): Max results (default: 120).
+
+**Example:**
+```bash
+bun cli.js options-aggs --ticker O:AAPL230616C00150000 --from 2025-01-01 --to 2025-01-31 --timespan day --limit 10
+```
+
+### options-trades
+Get trades for an options contract.
+
+**Usage:**
+```bash
+bun cli.js options-trades --ticker <ticker> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+- `--timestamp` (string): Query by specific timestamp.
+- `--timestamp-gte`, `--timestamp-gt`, `--timestamp-lte`, `--timestamp-lt` (string): Timestamp range filters.
+- `--limit` (number): Max results (default: 10).
+- `--sort` (string): Sort field (default: 'timestamp'). Values: `timestamp`.
+- `--order` (string): Sort order (default: 'asc'). Values: `asc`, `desc`.
+
+**Example:**
+```bash
+bun cli.js options-trades --ticker O:AAPL230616C00150000 --limit 5
+```
+
+### options-quotes
+Get quotes for an options contract.
+
+**Usage:**
+```bash
+bun cli.js options-quotes --ticker <ticker> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+- `--timestamp` (string): Query by specific timestamp.
+- `--timestamp-gte`, `--timestamp-gt`, `--timestamp-lte`, `--timestamp-lt` (string): Timestamp range filters.
+- `--limit` (number): Max results (default: 10).
+- `--sort` (string): Sort field (default: 'timestamp'). Values: `timestamp`.
+- `--order` (string): Sort order (default: 'asc'). Values: `asc`, `desc`.
+
+**Example:**
+```bash
+bun cli.js options-quotes --ticker O:AAPL230616C00150000 --limit 5
+```
+
+### options-open-close
+Get the daily open, close, and after-hours prices for an options contract on a specific date.
+
+**Usage:**
+```bash
+bun cli.js options-open-close --ticker <ticker> --date <YYYY-MM-DD> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+- `--date` (required): Date of the requested open/close (YYYY-MM-DD).
+- `--adjusted` (boolean): Whether to adjust for splits (default: true).
+
+**Example:**
+```bash
+bun cli.js options-open-close --ticker O:AAPL230616C00150000 --date 2025-01-15
+```
+
+### options-chain
+Get a snapshot of options chain for an underlying asset.
+
+**Usage:**
+```bash
+bun cli.js options-chain --underlying <ticker> [options]
+```
+
+**Parameters:**
+- `--underlying` (required): Underlying ticker symbol (e.g., AAPL).
+- `--strike` (number): Strike price.
+- `--expiration` (string): Expiration date (YYYY-MM-DD).
+- `--type` (string): Contract type. Values: `call`, `put`.
+- `--order` (string): Sort order. Values: `asc`, `desc`.
+- `--limit` (number): Max results (default: 10).
+- `--sort` (string): Sort field.
+
+**Example:**
+```bash
+bun cli.js options-chain --underlying AAPL --type call
+```
+
+### options-contract
+Get details for a specific options contract.
+
+**Usage:**
+```bash
+bun cli.js options-contract --underlying <ticker> --contract <contract_id>
+```
+
+**Parameters:**
+- `--underlying` (required): Underlying ticker symbol.
+- `--contract` (required): Options contract identifier (e.g., O:AAPL230616C00150000).
+
+**Example:**
+```bash
+bun cli.js options-contract --underlying AAPL --contract O:AAPL230616C00150000
+```
+
+### options-previous
+Get the previous day's open, high, low, and close (OHLC) for an options contract.
+
+**Usage:**
+```bash
+bun cli.js options-previous --ticker <ticker> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+- `--adjusted` (boolean): Whether to adjust for splits (default: true).
+
+**Example:**
+```bash
+bun cli.js options-previous --ticker O:AAPL230616C00150000
+```
+
+### options-sma
+Get Simple Moving Average (SMA) for an options contract.
+
+**Usage:**
+```bash
+bun cli.js options-sma --ticker <ticker> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+- `--timestamp` (string): Query by specific timestamp.
+- `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
+- `--adjusted` (boolean): Whether to adjust for splits (default: true).
+- `--window` (number): Window size (default: 50).
+- `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
+- `--expand-underlying` (boolean): Include underlying aggregates.
+- `--order` (string): Sort order. Values: `asc`, `desc`.
+- `--limit` (number): Max results (default: 10).
+
+**Example:**
+```bash
+bun cli.js options-sma --ticker O:AAPL230616C00150000 --window 50
+```
+
+### options-ema
+Get Exponential Moving Average (EMA) for an options contract.
+
+**Usage:**
+```bash
+bun cli.js options-ema --ticker <ticker> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+- `--timestamp` (string): Query by specific timestamp.
+- `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
+- `--adjusted` (boolean): Whether to adjust for splits (default: true).
+- `--window` (number): Window size (default: 50).
+- `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
+- `--expand-underlying` (boolean): Include underlying aggregates.
+- `--order` (string): Sort order. Values: `asc`, `desc`.
+- `--limit` (number): Max results (default: 10).
+
+**Example:**
+```bash
+bun cli.js options-ema --ticker O:AAPL230616C00150000 --window 50
+```
+
+### options-rsi
+Get Relative Strength Index (RSI) for an options contract.
+
+**Usage:**
+```bash
+bun cli.js options-rsi --ticker <ticker> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+- `--timestamp` (string): Query by specific timestamp.
+- `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
+- `--adjusted` (boolean): Whether to adjust for splits (default: true).
+- `--window` (number): Window size (default: 14).
+- `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
+- `--expand-underlying` (boolean): Include underlying aggregates.
+- `--order` (string): Sort order. Values: `asc`, `desc`.
+- `--limit` (number): Max results (default: 10).
+
+**Example:**
+```bash
+bun cli.js options-rsi --ticker O:AAPL230616C00150000 --window 14
+```
+
+### options-macd
+Get Moving Average Convergence/Divergence (MACD) for an options contract.
+
+**Usage:**
+```bash
+bun cli.js options-macd --ticker <ticker> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+- `--timestamp` (string): Query by specific timestamp.
+- `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
+- `--adjusted` (boolean): Whether to adjust for splits (default: true).
+- `--short-window` (number): Short window size.
+- `--long-window` (number): Long window size.
+- `--signal-window` (number): Signal window size.
+- `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
+- `--expand-underlying` (boolean): Include underlying aggregates.
+- `--order` (string): Sort order. Values: `asc`, `desc`.
+- `--limit` (number): Max results (default: 10).
+
+**Example:**
+```bash
+bun cli.js options-macd --ticker O:AAPL230616C00150000
+```
+
+### last-options-trade
+Get the most recent trade for an options contract.
+
+**Usage:**
+```bash
+bun cli.js last-options-trade --ticker <ticker>
+```
+
+**Parameters:**
+- `--ticker` (required): Options ticker symbol.
+
+**Example:**
+```bash
+bun cli.js last-options-trade --ticker O:AAPL230616C00150000
+```

package/dist/references/reference_commands.md

@@ -0,0 +1,216 @@
+# Reference Data Commands Reference
+
+This document provides a reference for the reference data commands available in the Polygon CLI.
+
+## Commands
+
+### tickers
+Query all ticker symbols which are supported by Polygon.io.
+
+**Usage:**
+```bash
+bun cli.js tickers [options]
+```
+
+**Parameters:**
+- `--ticker` (string): Specify a ticker symbol.
+- `--type` (string): Specify the type of the tickers (e.g., CS, ETF).
+- `--market` (string): Filter by market type (stocks, crypto, fx, otc, indices).
+- `--exchange` (string): Specify the primary exchange MIC.
+- `--cusip` (string): Search by CUSIP.
+- `--cik` (string): Search by CIK.
+- `--date` (string): Specify a date for the ticker search (YYYY-MM-DD).
+- `--search` (string): Search for terms within the ticker and/or company name.
+- `--active` (boolean): Filter for active/inactive tickers (default: true).
+- `--sort` (string): Sort field (ticker, type).
+- `--order` (string): Sort order (asc, desc).
+- `--limit` (number): Max results (default: 10).
+
+**Example:**
+```bash
+bun cli.js tickers --search apple --market stocks --active true
+```
+
+### ticker-details
+Get a single ticker supported by Polygon.io.
+
+**Usage:**
+```bash
+bun cli.js ticker-details --ticker <ticker> [options]
+```
+
+**Parameters:**
+- `--ticker` (required): The ticker symbol.
+- `--date` (string): Specify a point in time for the ticker details (YYYY-MM-DD).
+
+**Example:**
+```bash
+bun cli.js ticker-details --ticker AAPL
+```
+
+### ticker-types
+Get a mapping of ticker types to their type code.
+
+**Usage:**
+```bash
+bun cli.js ticker-types [options]
+```
+
+**Parameters:**
+- `--asset-class` (string): Filter by asset class (stocks, options, crypto, fx, indices).
+- `--locale` (string): Filter by locale (us, global).
+
+**Example:**
+```bash
+bun cli.js ticker-types --asset-class stocks
+```
+
+### exchanges
+List all exchanges that Polygon.io knows about.
+
+**Usage:**
+```bash
+bun cli.js exchanges [options]
+```
+
+**Parameters:**
+- `--asset-class` (string): Filter by asset class.
+- `--locale` (string): Filter by locale.
+
+**Example:**
+```bash
+bun cli.js exchanges --asset-class stocks
+```
+
+### conditions
+List all conditions that Polygon.io uses.
+
+**Usage:**
+```bash
+bun cli.js conditions [options]
+```
+
+**Parameters:**
+- `--asset-class` (string): Filter by asset class.
+- `--data-type` (string): Filter by data type (trade, bbo, nbbo).
+- `--id` (number): Filter by condition ID.
+- `--sip` (string): Filter by SIP (CTA, UTP, OPRA).
+- `--sort` (string): Sort field.
+- `--order` (string): Sort order.
+- `--limit` (number): Max results.
+
+**Example:**
+```bash
+bun cli.js conditions --asset-class stocks
+```
+
+### dividends
+Get a list of historical cash dividends, including the ticker symbol, declaration date, ex-dividend date, record date, pay date, frequency, and amount.
+
+**Usage:**
+```bash
+bun cli.js dividends [options]
+```
+
+**Parameters:**
+- `--ticker` (string): Filter by ticker.
+- `--ex-dividend-date` (string): Query by ex-dividend date.
+- `--record-date` (string): Query by record date.
+- `--declaration-date` (string): Query by declaration date.
+- `--pay-date` (string): Query by pay date.
+- `--frequency` (number): Frequency (0=one-time, 1=annually, 4=quarterly, etc.).
+- `--cash-amount` (number): Query by cash amount.
+- `--dividend-type` (string): Query by dividend type (CD, SC, LT, etc.).
+- `--sort` (string): Sort field.
+- `--order` (string): Sort order.
+- `--limit` (number): Max results.
+
+**Example:**
+```bash
+bun cli.js dividends --ticker AAPL
+```
+
+### stock-splits
+Get a list of historical stock splits, including the ticker symbol, the execution date, and the split ratio.
+
+**Usage:**
+```bash
+bun cli.js stock-splits [options]
+```
+
+**Parameters:**
+- `--ticker` (string): Filter by ticker.
+- `--execution-date` (string): Query by execution date.
+- `--reverse-split` (boolean): Filter for reverse splits.
+- `--sort` (string): Sort field.
+- `--order` (string): Sort order.
+- `--limit` (number): Max results.
+
+**Example:**
+```bash
+bun cli.js stock-splits --ticker AAPL
+```
+
+### financials
+Get historical financial data for a stock ticker.
+
+**Usage:**
+```bash
+bun cli.js financials [options]
+```
+
+**Parameters:**
+- `--ticker` (string): Query by ticker.
+- `--cik` (string): Query by CIK.
+- `--company-name` (string): Query by company name.
+- `--sic` (string): Query by SIC.
+- `--filing-date` (string): Query by filing date.
+- `--period-of-report-date` (string): Query by period of report date.
+- `--timeframe` (string): internal.
+- `--include-sources` (boolean): Include sources.
+- `--sort` (string): Sort field.
+- `--order` (string): Sort order.
+- `--limit` (number): Max results.
+
+**Example:**
+```bash
+bun cli.js financials --ticker AAPL
+```
+
+### ipos
+Get a list of upcoming IPOs.
+
+**Usage:**
+```bash
+bun cli.js ipos [options]
+```
+
+**Parameters:**
+- `--ticker` (string): Filter by ticker.
+- `--us-code` (string): Filter by US Code.
+- `--isin` (string): Filter by ISIN.
+- `--listing-date` (string): Filter by listing date.
+- `--sort` (string): Sort field.
+- `--order` (string): Sort order.
+- `--limit` (number): Max results.
+
+**Example:**
+```bash
+bun cli.js ipos --limit 5
+```
+
+### related-companies
+Get a list of tickers that are related to the given ticker.
+
+**Usage:**
+```bash
+bun cli.js related-companies --ticker <ticker>
+```
+
+**Parameters:**
+- `--ticker` (required): The ticker symbol.
+
+**Example:**
+```bash
+bun cli.js related-companies --ticker AAPL
+```