massive-cli 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +63 -0
  2. package/dist/SKILL.md +55 -0
  3. package/dist/cli.js +20593 -0
  4. package/dist/references/crypto_commands.md +142 -0
  5. package/dist/references/forex_commands.md +237 -0
  6. package/dist/references/indices_commands.md +174 -0
  7. package/dist/references/market_commands.md +37 -0
  8. package/dist/references/news_commands.md +33 -0
  9. package/dist/references/options_commands.md +258 -0
  10. package/dist/references/reference_commands.md +216 -0
  11. package/dist/references/stocks_commands.md +273 -0
  12. package/package.json +27 -0
package/dist/references/crypto_commands.md ADDED
@@ -0,0 +1,142 @@
1
+ # Crypto Commands Reference
2
+
3
+ This document provides details on the parameters and enums used in the Polygon/Massive Crypto CLI commands.
4
+
5
+ ## Enums
6
+
7
+ ### Timespans
8
+ Used in `crypto-aggs`, `crypto-sma`, `crypto-ema`, `crypto-rsi`, `crypto-macd`:
9
+ - **GetCryptoAggregatesTimespanEnum**: `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`
10
+ - **GetCryptoSMATimespanEnum**: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`
11
+ - **GetCryptoEMATimespanEnum**: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`
12
+ - **GetCryptoRSITimespanEnum**: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`
13
+ - **GetCryptoMACDTimespanEnum**: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`
14
+
15
+ ### Series Type
16
+ Used in technical indicators (`crypto-sma`, `crypto-ema`, `crypto-rsi`, `crypto-macd`) to specify which price to use:
17
+ - `open`, `high`, `low`, `close`
18
+
19
+ ### Order / Sort
20
+ - **Sort**: `asc` (ascending), `desc` (descending)
21
+ - **Order**: `asc`, `desc`
22
+ - **Crypto Trades Sort**: `timestamp`
23
+
24
+ ### Snapshot Direction
25
+ - `gainers`, `losers`
26
+
27
+ ## Commands and Parameters
28
+
29
+ ### `crypto-aggs`
30
+ - `ticker` (string, required): Crypto ticker (e.g., X:BTCUSD)
31
+ - `multiplier` (number): Timespan multiplier (default 1)
32
+ - `timespan` (enum): See Timespans above (default 'day')
33
+ - `from` (string, required): Start date (YYYY-MM-DD)
34
+ - `to` (string, required): End date (YYYY-MM-DD)
35
+ - `adjusted` (boolean): Adjust for splits (default true)
36
+ - `sort` (enum): Sort order (default 'asc')
37
+ - `limit` (number): Max results (default 120)
38
+
39
+ **Example**:
40
+ ```bash
41
+ bun cli.js crypto-aggs --ticker X:BTCUSD --from 2023-01-01 --to 2023-01-31 --timespan day
42
+ ```
43
+
44
+ ### `crypto-trades`
45
+ - `ticker` (string, required): Crypto ticker
46
+ - `timestamp` (string): Specific timestamp
47
+ - `timestamp-gte`, `timestamp-gt`, `timestamp-lte`, `timestamp-lt`: Timestamp range filters
48
+ - `order` (enum): Order of results
49
+ - `limit` (number): Max results
50
+ - `sort` (enum): Sort field
51
+
52
+ **Example**:
53
+ ```bash
54
+ bun cli.js crypto-trades --ticker X:BTCUSD --limit 5
55
+ ```
56
+
57
+ ### `crypto-snapshot`
58
+ - `ticker` (string, required): Crypto ticker
59
+
60
+ **Example**:
61
+ ```bash
62
+ bun cli.js crypto-snapshot --ticker X:BTCUSD
63
+ ```
64
+
65
+ ### `crypto-snapshot-direction`
66
+ - `direction` (enum, required): `gainers` or `losers`
67
+
68
+ **Example**:
69
+ ```bash
70
+ bun cli.js crypto-snapshot-direction --direction gainers
71
+ ```
72
+
73
+ ### `crypto-snapshot-tickers`
74
+ - `tickers` (comma-separated strings): List of tickers
75
+
76
+ **Example**:
77
+ ```bash
78
+ bun cli.js crypto-snapshot-tickers --tickers X:BTCUSD,X:ETHUSD
79
+ ```
80
+
81
+ ### `crypto-open-close`
82
+ - `from` (string, required): From symbol (e.g., BTC)
83
+ - `to` (string, required): To symbol (e.g., USD)
84
+ - `date` (string, required): Date (YYYY-MM-DD)
85
+ - `adjusted` (boolean): Adjust for splits
86
+
87
+ **Example**:
88
+ ```bash
89
+ bun cli.js crypto-open-close --from BTC --to USD --date 2023-01-01
90
+ ```
91
+
92
+ ### `crypto-previous`
93
+ - `ticker` (string, required): Crypto ticker
94
+ - `adjusted` (boolean): Adjust for splits
95
+
96
+ **Example**:
97
+ ```bash
98
+ bun cli.js crypto-previous --ticker X:BTCUSD
99
+ ```
100
+
101
+ ### `crypto-grouped`
102
+ - `date` (string, required): Date (YYYY-MM-DD)
103
+ - `adjusted` (boolean): Adjust for splits
104
+
105
+ **Example**:
106
+ ```bash
107
+ bun cli.js crypto-grouped --date 2023-01-01
108
+ ```
109
+
110
+ ### Technical Indicators (`crypto-sma`, `crypto-ema`, `crypto-rsi`, `crypto-macd`)
111
+ Common parameters:
112
+ - `ticker` (string, required)
113
+ - `timespan` (enum)
114
+ - `window` (number)
115
+ - `series-type` (enum)
116
+ - `expand-underlying` (boolean)
117
+ - `order` (enum)
118
+ - `limit` (number)
119
+ - Timestamp filters: `timestamp`, `timestamp-gte`, `timestamp-gt`, `timestamp-lte`, `timestamp-lt`
120
+
121
+ Specific to `crypto-macd`:
122
+ - `short-window` (number)
123
+ - `long-window` (number)
124
+ - `signal-window` (number)
125
+
126
+ **Example**:
127
+ ```bash
128
+ # SMA
129
+ bun cli.js crypto-sma --ticker X:BTCUSD --timespan day --window 50
130
+
131
+ # MACD
132
+ bun cli.js crypto-macd --ticker X:BTCUSD --timespan day --short-window 12 --long-window 26 --signal-window 9
133
+ ```
134
+
135
+ ### `last-crypto-trade`
136
+ - `from` (string, required)
137
+ - `to` (string, required)
138
+
139
+ **Example**:
140
+ ```bash
141
+ bun cli.js last-crypto-trade --from BTC --to USD
142
+ ```
package/dist/references/forex_commands.md ADDED
@@ -0,0 +1,237 @@
1
+ # Forex Commands Reference
2
+
3
+ This document provides a reference for the forex-related commands available in the Polygon CLI.
4
+
5
+ ## Commands
6
+
7
+ ### forex-aggs
8
+ Get aggregate bars (OHLCV) for a forex pair over a given date range.
9
+
10
+ **Usage:**
11
+ ```bash
12
+ bun cli.js forex-aggs --ticker <ticker> --from <YYYY-MM-DD> --to <YYYY-MM-DD> [options]
13
+ ```
14
+
15
+ **Parameters:**
16
+ - `--ticker` (required): Forex ticker symbol (e.g., C:EURUSD).
17
+ - `--from` (required): Start date (YYYY-MM-DD).
18
+ - `--to` (required): End date (YYYY-MM-DD).
19
+ - `--multiplier` (number): Timespan multiplier (default: 1).
20
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
21
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
22
+ - `--sort` (string): Sort order (default: 'asc'). Values: `asc`, `desc`.
23
+ - `--limit` (number): Max results (default: 120).
24
+
25
+ **Example:**
26
+ ```bash
27
+ bun cli.js forex-aggs --ticker C:EURUSD --from 2025-01-01 --to 2025-01-31 --timespan day --limit 10
28
+ ```
29
+
30
+ ### forex-quotes
31
+ Get quotes for a forex pair.
32
+
33
+ **Usage:**
34
+ ```bash
35
+ bun cli.js forex-quotes --ticker <ticker> [options]
36
+ ```
37
+
38
+ **Parameters:**
39
+ - `--ticker` (required): Forex ticker symbol.
40
+ - `--timestamp` (string): Query by specific timestamp.
41
+ - `--timestamp-gte`, `--timestamp-gt`, `--timestamp-lte`, `--timestamp-lt` (string): Timestamp range filters.
42
+ - `--limit` (number): Max results (default: 10).
43
+ - `--sort` (string): Sort field (default: 'timestamp'). Values: `timestamp`.
44
+ - `--order` (string): Sort order (default: 'asc'). Values: `asc`, `desc`.
45
+
46
+ **Example:**
47
+ ```bash
48
+ bun cli.js forex-quotes --ticker C:EURUSD --limit 5
49
+ ```
50
+
51
+ ### forex-snapshot
52
+ Get the most recent snapshot for a forex pair.
53
+
54
+ **Usage:**
55
+ ```bash
56
+ bun cli.js forex-snapshot --ticker <ticker>
57
+ ```
58
+
59
+ **Parameters:**
60
+ - `--ticker` (required): Forex ticker symbol.
61
+
62
+ **Example:**
63
+ ```bash
64
+ bun cli.js forex-snapshot --ticker C:EURUSD
65
+ ```
66
+
67
+ ### forex-previous
68
+ Get the previous day's open, high, low, and close (OHLC) for a forex pair.
69
+
70
+ **Usage:**
71
+ ```bash
72
+ bun cli.js forex-previous --ticker <ticker> [options]
73
+ ```
74
+
75
+ **Parameters:**
76
+ - `--ticker` (required): Forex ticker symbol.
77
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
78
+
79
+ **Example:**
80
+ ```bash
81
+ bun cli.js forex-previous --ticker C:EURUSD
82
+ ```
83
+
84
+ ### forex-grouped
85
+ Get the daily open, high, low, and close (OHLC) for the entire forex market.
86
+
87
+ **Usage:**
88
+ ```bash
89
+ bun cli.js forex-grouped --date <YYYY-MM-DD> [options]
90
+ ```
91
+
92
+ **Parameters:**
93
+ - `--date` (required): Date of the requested aggregates (YYYY-MM-DD).
94
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
95
+
96
+ **Example:**
97
+ ```bash
98
+ bun cli.js forex-grouped --date 2025-01-15
99
+ ```
100
+
101
+ ### forex-sma
102
+ Get Simple Moving Average (SMA) for a forex pair.
103
+
104
+ **Usage:**
105
+ ```bash
106
+ bun cli.js forex-sma --ticker <ticker> [options]
107
+ ```
108
+
109
+ **Parameters:**
110
+ - `--ticker` (required): Forex ticker symbol.
111
+ - `--timestamp` (string): Query by specific timestamp.
112
+ - `--timestamp-gte`, `--timestamp-gt`, `--timestamp-lte`, `--timestamp-lt` (string): Timestamp range filters.
113
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
114
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
115
+ - `--window` (number): Window size (default: 50).
116
+ - `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
117
+ - `--expand-underlying` (boolean): Include underlying aggregates.
118
+ - `--order` (string): Sort order. Values: `asc`, `desc`.
119
+ - `--limit` (number): Max results (default: 10).
120
+
121
+ **Example:**
122
+ ```bash
123
+ bun cli.js forex-sma --ticker C:EURUSD --window 50
124
+ ```
125
+
126
+ ### forex-ema
127
+ Get Exponential Moving Average (EMA) for a forex pair.
128
+
129
+ **Usage:**
130
+ ```bash
131
+ bun cli.js forex-ema --ticker <ticker> [options]
132
+ ```
133
+
134
+ **Parameters:**
135
+ - `--ticker` (required): Forex ticker symbol.
136
+ - `--timestamp` (string): Query by specific timestamp.
137
+ - `--timestamp-gte`, `--timestamp-gt`, `--timestamp-lte`, `--timestamp-lt` (string): Timestamp range filters.
138
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
139
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
140
+ - `--window` (number): Window size (default: 50).
141
+ - `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
142
+ - `--expand-underlying` (boolean): Include underlying aggregates.
143
+ - `--order` (string): Sort order. Values: `asc`, `desc`.
144
+ - `--limit` (number): Max results (default: 10).
145
+
146
+ **Example:**
147
+ ```bash
148
+ bun cli.js forex-ema --ticker C:EURUSD --window 50
149
+ ```
150
+
151
+ ### forex-rsi
152
+ Get Relative Strength Index (RSI) for a forex pair.
153
+
154
+ **Usage:**
155
+ ```bash
156
+ bun cli.js forex-rsi --ticker <ticker> [options]
157
+ ```
158
+
159
+ **Parameters:**
160
+ - `--ticker` (required): Forex ticker symbol.
161
+ - `--timestamp` (string): Query by specific timestamp.
162
+ - `--timestamp-gte`, `--timestamp-gt`, `--timestamp-lte`, `--timestamp-lt` (string): Timestamp range filters.
163
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
164
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
165
+ - `--window` (number): Window size (default: 14).
166
+ - `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
167
+ - `--expand-underlying` (boolean): Include underlying aggregates.
168
+ - `--order` (string): Sort order. Values: `asc`, `desc`.
169
+ - `--limit` (number): Max results (default: 10).
170
+
171
+ **Example:**
172
+ ```bash
173
+ bun cli.js forex-rsi --ticker C:EURUSD --window 14
174
+ ```
175
+
176
+ ### forex-macd
177
+ Get Moving Average Convergence/Divergence (MACD) for a forex pair.
178
+
179
+ **Usage:**
180
+ ```bash
181
+ bun cli.js forex-macd --ticker <ticker> [options]
182
+ ```
183
+
184
+ **Parameters:**
185
+ - `--ticker` (required): Forex ticker symbol.
186
+ - `--timestamp` (string): Query by specific timestamp.
187
+ - `--timestamp-gte`, `--timestamp-gt`, `--timestamp-lte`, `--timestamp-lt` (string): Timestamp range filters.
188
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
189
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
190
+ - `--short-window` (number): Short window size.
191
+ - `--long-window` (number): Long window size.
192
+ - `--signal-window` (number): Signal window size.
193
+ - `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
194
+ - `--expand-underlying` (boolean): Include underlying aggregates.
195
+ - `--order` (string): Sort order. Values: `asc`, `desc`.
196
+ - `--limit` (number): Max results (default: 10).
197
+
198
+ **Example:**
199
+ ```bash
200
+ bun cli.js forex-macd --ticker C:EURUSD
201
+ ```
202
+
203
+ ### currency-conversion
204
+ Get currency conversion.
205
+
206
+ **Usage:**
207
+ ```bash
208
+ bun cli.js currency-conversion --from <currency> --to <currency> [options]
209
+ ```
210
+
211
+ **Parameters:**
212
+ - `--from` (required): From currency (e.g., USD).
213
+ - `--to` (required): To currency (e.g., EUR).
214
+ - `--amount` (number): Amount to convert.
215
+ - `--precision` (number): Decimal precision.
216
+
217
+ **Example:**
218
+ ```bash
219
+ bun cli.js currency-conversion --from USD --to EUR --amount 100
220
+ ```
221
+
222
+ ### last-forex-quote
223
+ Get the last quote for a forex pair.
224
+
225
+ **Usage:**
226
+ ```bash
227
+ bun cli.js last-forex-quote --from <currency> --to <currency>
228
+ ```
229
+
230
+ **Parameters:**
231
+ - `--from` (required): From currency (e.g., EUR).
232
+ - `--to` (required): To currency (e.g., USD).
233
+
234
+ **Example:**
235
+ ```bash
236
+ bun cli.js last-forex-quote --from EUR --to USD
237
+ ```
package/dist/references/indices_commands.md ADDED
@@ -0,0 +1,174 @@
1
+ # Indices Commands Reference
2
+
3
+ This document provides a reference for the indices-related commands available in the Polygon CLI.
4
+
5
+ ## Commands
6
+
7
+ ### indices-aggs
8
+ Get aggregate bars (OHLCV) for an index over a given date range.
9
+
10
+ **Usage:**
11
+ ```bash
12
+ bun cli.js indices-aggs --ticker <ticker> --from <YYYY-MM-DD> --to <YYYY-MM-DD> [options]
13
+ ```
14
+
15
+ **Parameters:**
16
+ - `--ticker` (required): Index ticker symbol (e.g., I:SPX).
17
+ - `--from` (required): Start date (YYYY-MM-DD).
18
+ - `--to` (required): End date (YYYY-MM-DD).
19
+ - `--multiplier` (number): Timespan multiplier (default: 1).
20
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
21
+ - `--sort` (string): Sort order (default: 'asc'). Values: `asc`, `desc`.
22
+ - `--limit` (number): Max results (default: 120).
23
+
24
+ **Example:**
25
+ ```bash
26
+ bun cli.js indices-aggs --ticker I:SPX --from 2025-01-01 --to 2025-01-31 --timespan day --limit 10
27
+ ```
28
+
29
+ ### indices-open-close
30
+ Get the daily open, close, and after-hours prices for an index on a specific date.
31
+
32
+ **Usage:**
33
+ ```bash
34
+ bun cli.js indices-open-close --ticker <ticker> --date <YYYY-MM-DD>
35
+ ```
36
+
37
+ **Parameters:**
38
+ - `--ticker` (required): Index ticker symbol.
39
+ - `--date` (required): Date of the requested open/close (YYYY-MM-DD).
40
+
41
+ **Example:**
42
+ ```bash
43
+ bun cli.js indices-open-close --ticker I:SPX --date 2025-01-15
44
+ ```
45
+
46
+ ### indices-snapshot
47
+ Get the most recent snapshot for an index.
48
+
49
+ **Usage:**
50
+ ```bash
51
+ bun cli.js indices-snapshot [--ticker <ticker>]
52
+ ```
53
+
54
+ **Parameters:**
55
+ - `--ticker`: Index ticker symbol (e.g., I:SPX).
56
+
57
+ **Example:**
58
+ ```bash
59
+ bun cli.js indices-snapshot --ticker I:SPX
60
+ ```
61
+
62
+ ### indices-previous
63
+ Get the previous day's open, high, low, and close (OHLC) for an index.
64
+
65
+ **Usage:**
66
+ ```bash
67
+ bun cli.js indices-previous --ticker <ticker>
68
+ ```
69
+
70
+ **Parameters:**
71
+ - `--ticker` (required): Index ticker symbol.
72
+
73
+ **Example:**
74
+ ```bash
75
+ bun cli.js indices-previous --ticker I:SPX
76
+ ```
77
+
78
+ ### indices-sma
79
+ Get Simple Moving Average (SMA) for an index.
80
+
81
+ **Usage:**
82
+ ```bash
83
+ bun cli.js indices-sma --ticker <ticker> [options]
84
+ ```
85
+
86
+ **Parameters:**
87
+ - `--ticker` (required): Index ticker symbol.
88
+ - `--timestamp` (string): Query by specific timestamp.
89
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
90
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
91
+ - `--window` (number): Window size (default: 50).
92
+ - `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
93
+ - `--expand-underlying` (boolean): Include underlying aggregates.
94
+ - `--order` (string): Sort order. Values: `asc`, `desc`.
95
+ - `--limit` (number): Max results (default: 10).
96
+
97
+ **Example:**
98
+ ```bash
99
+ bun cli.js indices-sma --ticker I:SPX --window 50
100
+ ```
101
+
102
+ ### indices-ema
103
+ Get Exponential Moving Average (EMA) for an index.
104
+
105
+ **Usage:**
106
+ ```bash
107
+ bun cli.js indices-ema --ticker <ticker> [options]
108
+ ```
109
+
110
+ **Parameters:**
111
+ - `--ticker` (required): Index ticker symbol.
112
+ - `--timestamp` (string): Query by specific timestamp.
113
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
114
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
115
+ - `--window` (number): Window size (default: 50).
116
+ - `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
117
+ - `--expand-underlying` (boolean): Include underlying aggregates.
118
+ - `--order` (string): Sort order. Values: `asc`, `desc`.
119
+ - `--limit` (number): Max results (default: 10).
120
+
121
+ **Example:**
122
+ ```bash
123
+ bun cli.js indices-ema --ticker I:SPX --window 50
124
+ ```
125
+
126
+ ### indices-rsi
127
+ Get Relative Strength Index (RSI) for an index.
128
+
129
+ **Usage:**
130
+ ```bash
131
+ bun cli.js indices-rsi --ticker <ticker> [options]
132
+ ```
133
+
134
+ **Parameters:**
135
+ - `--ticker` (required): Index ticker symbol.
136
+ - `--timestamp` (string): Query by specific timestamp.
137
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
138
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
139
+ - `--window` (number): Window size (default: 14).
140
+ - `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
141
+ - `--expand-underlying` (boolean): Include underlying aggregates.
142
+ - `--order` (string): Sort order. Values: `asc`, `desc`.
143
+ - `--limit` (number): Max results (default: 10).
144
+
145
+ **Example:**
146
+ ```bash
147
+ bun cli.js indices-rsi --ticker I:SPX --window 14
148
+ ```
149
+
150
+ ### indices-macd
151
+ Get Moving Average Convergence/Divergence (MACD) for an index.
152
+
153
+ **Usage:**
154
+ ```bash
155
+ bun cli.js indices-macd --ticker <ticker> [options]
156
+ ```
157
+
158
+ **Parameters:**
159
+ - `--ticker` (required): Index ticker symbol.
160
+ - `--timestamp` (string): Query by specific timestamp.
161
+ - `--timespan` (string): Timespan unit (default: 'day'). Values: `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`.
162
+ - `--adjusted` (boolean): Whether to adjust for splits (default: true).
163
+ - `--short-window` (number): Short window size.
164
+ - `--long-window` (number): Long window size.
165
+ - `--signal-window` (number): Signal window size.
166
+ - `--series-type` (string): Price type to use. Values: `open`, `high`, `low`, `close`.
167
+ - `--expand-underlying` (boolean): Include underlying aggregates.
168
+ - `--order` (string): Sort order. Values: `asc`, `desc`.
169
+ - `--limit` (number): Max results (default: 10).
170
+
171
+ **Example:**
172
+ ```bash
173
+ bun cli.js indices-macd --ticker I:SPX
174
+ ```
package/dist/references/market_commands.md ADDED
@@ -0,0 +1,37 @@
1
+ # Market Data Commands Reference
2
+
3
+ This document provides a reference for the market data commands available in the Polygon CLI.
4
+
5
+ ## Commands
6
+
7
+ ### market-status
8
+ Get the prompt status of the market.
9
+
10
+ **Usage:**
11
+ ```bash
12
+ bun cli.js market-status
13
+ ```
14
+
15
+ **Parameters:**
16
+ None.
17
+
18
+ **Example:**
19
+ ```bash
20
+ bun cli.js market-status
21
+ ```
22
+
23
+ ### market-holidays
24
+ Get upcoming market holidays.
25
+
26
+ **Usage:**
27
+ ```bash
28
+ bun cli.js market-holidays
29
+ ```
30
+
31
+ **Parameters:**
32
+ None.
33
+
34
+ **Example:**
35
+ ```bash
36
+ bun cli.js market-holidays
37
+ ```
package/dist/references/news_commands.md ADDED
@@ -0,0 +1,33 @@
1
+ # News Commands Reference
2
+
3
+ This document provides a reference for the news commands available in the Polygon CLI.
4
+
5
+ ## Commands
6
+
7
+ ### news
8
+ Get the most recent news articles relating to a stock ticker symbol, including a summary of the article and a link to the original source.
9
+
10
+ **Usage:**
11
+ ```bash
12
+ bun cli.js news [options]
13
+ ```
14
+
15
+ **Parameters:**
16
+ - `--ticker` (string): Filter by ticker.
17
+ - `--published-utc` (string): Filter by publication date.
18
+ - `--ticker-gte` (string): Range by ticker.
19
+ - `--ticker-gt` (string): Range by ticker.
20
+ - `--ticker-lte` (string): Range by ticker.
21
+ - `--ticker-lt` (string): Range by ticker.
22
+ - `--published-utc-gte` (string): Range by publication date.
23
+ - `--published-utc-gt` (string): Range by publication date.
24
+ - `--published-utc-lte` (string): Range by publication date.
25
+ - `--published-utc-lt` (string): Range by publication date.
26
+ - `--sort` (string): Sort field.
27
+ - `--order` (string): Sort order.
28
+ - `--limit` (number): Max results.
29
+
30
+ **Example:**
31
+ ```bash
32
+ bun cli.js news --ticker AAPL --limit 5
33
+ ```