sentisense 0.80.0 → 0.82.0
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.
- package/README.md +12 -5
- package/dist/cli.cjs +564 -124
- package/dist/index.cjs +109 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +413 -26
- package/dist/index.d.ts +413 -26
- package/dist/index.mjs +109 -7
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -78,7 +78,7 @@ npx -y sentisense@latest health # checks your key and the connection
|
|
|
78
78
|
| `congress [ticker]` | Trades disclosed by members of Congress |
|
|
79
79
|
| `news [ticker]` | Stories with impact and tone |
|
|
80
80
|
| `flows [ticker]` | 13F flows, or one stock's holders |
|
|
81
|
-
| `options
|
|
81
|
+
| `options [ticker]` | The options Radar with no ticker (`--etfs` for the ETF board), or one ticker's end-of-day positioning. `--history` for its daily sessions, `--intraday` for the latest session's 15-minute series (PRO) |
|
|
82
82
|
| `screen --filter ...` | Screen stocks on Score, analysts, technicals, price and options |
|
|
83
83
|
| `search <name>` | Turn a name into a ticker and entity slug |
|
|
84
84
|
|
|
@@ -132,7 +132,7 @@ Most methods resolve to the data itself. Two kinds of response wrap it, and the
|
|
|
132
132
|
| `etfs` | `analystAggregate` `insiderAggregate` `sentimentAggregate` |
|
|
133
133
|
| `insider` | `getActivity` `getTrades` `getClusterBuys` |
|
|
134
134
|
| `insights` | `stock` `stockRange` `market` `latest` `user` |
|
|
135
|
-
| `institutional` | `getFlows` `getHolders` `getHoldersHistory` `getInstitutionHistory` `getActivists` |
|
|
135
|
+
| `institutional` | `getFlows` `getHolders` `getHoldersHistory` `getInstitutionHistory` `getActivists` `getBondFlows` `getOptionFlows` |
|
|
136
136
|
| `options` | `getOverview` |
|
|
137
137
|
| `politicians` | `getActivity` `getFilings` `getMembers` `getMember` |
|
|
138
138
|
| `stocks` | `getSentiment` `getKpis` `getOptionsSummary` `getOptionsHistory` `getOptionsIntradayHistory` |
|
|
@@ -203,6 +203,7 @@ client.entityMetrics.getMetrics("AAPL", { metricType: "sentiment" }) //
|
|
|
203
203
|
client.entityMetrics.getMetrics("AAPL", { metricType: "mentions", startTime: Date.now() - 7 * 86400000 })
|
|
204
204
|
client.entityMetrics.getDistribution("AAPL", "mentions", { dimension: "source" }) // share of mentions by source, valueType "SHARE_PERCENT"
|
|
205
205
|
client.entityMetrics.getDistribution("AAPL", "sentiment") // mean sentiment by source, valueType "MEAN"
|
|
206
|
+
client.entityMetrics.getSlices("AAPL", "mentions") // the dimensions and values a metric breaks down by
|
|
206
207
|
client.stocks.getSentiment("AAPL") // Score, mentions, tone by source
|
|
207
208
|
```
|
|
208
209
|
|
|
@@ -285,10 +286,13 @@ client.institutional.listInstitutions() // find fu
|
|
|
285
286
|
client.institutional.getInstitutionDetail("Berkshire-Hathaway", { limit: 10, sortBy: "estimatedFlowUsd" })
|
|
286
287
|
client.institutional.getInstitutionHistory("Renaissance-Technologies", { quarters: 8, tickers: ["NVDA"] })
|
|
287
288
|
client.institutional.getActivists("2026-06-30") // activist positions for a quarter
|
|
289
|
+
client.institutional.getBondFlows("2026-06-30") // convertible bonds institutions hold, by issuer
|
|
290
|
+
client.institutional.getOptionFlows("2026-06-30") // calls and puts institutions report, by stock
|
|
288
291
|
```
|
|
289
292
|
|
|
290
293
|
The newest quarter is often incomplete, so pick one by its `pending` flag rather than taking the first. A widely held stock has thousands of holders, so pass `limit`; `offset`, `sortBy` and `sortDir` only work alongside it.
|
|
291
294
|
`getInstitutionDetail` returns `unknown`, so cast it to `PreviewResponse<InstitutionDetail>`; its sort and filter options also need `limit`.
|
|
295
|
+
`getOptionFlows` is the option positions institutions file on Form 13F, not options trading; for that, see [Options](#options). A bond row's `bondTickers` is one comma-separated string.
|
|
292
296
|
|
|
293
297
|
```typescript
|
|
294
298
|
const quarter = (await client.institutional.getQuarters()).find((q) => !q.pending)?.reportDate;
|
|
@@ -320,6 +324,7 @@ client.analyst.calls("gil-luria", { limit: 25 }) // their price target
|
|
|
320
324
|
|
|
321
325
|
```typescript
|
|
322
326
|
client.calendar.getEarnings() // upcoming report dates and estimates
|
|
327
|
+
client.calendar.list() // which calendars exist (no quota cost)
|
|
323
328
|
client.earnings.getSummaries("AAPL", { limit: 4 }) // each quarter written up: headline, KPIs, guidance, call summary
|
|
324
329
|
client.earnings.getRecent({ days: 7 }) // who reported recently
|
|
325
330
|
client.earnings.getReactions("AAPL") // how the stock moved after its last reports
|
|
@@ -386,9 +391,11 @@ for (const row of res.results) console.log(row.ticker, row.sentiSenseScore7D, ro
|
|
|
386
391
|
### Market mood
|
|
387
392
|
|
|
388
393
|
```typescript
|
|
389
|
-
client.marketMood.get({ days: 30 })
|
|
390
|
-
client.
|
|
391
|
-
client.
|
|
394
|
+
client.marketMood.get({ days: 30 }) // Market Mood, from fear to greed, with its history
|
|
395
|
+
client.marketMood.getSentimentSectors() // each sector's tone against the market's own
|
|
396
|
+
client.marketMood.getSentimentBreadth() // the share of stocks leaning bullish, neutral, bearish, by day
|
|
397
|
+
client.indexes.list() // our indexes
|
|
398
|
+
client.indexes.history("ai-sentiment") // one index over time
|
|
392
399
|
```
|
|
393
400
|
|
|
394
401
|
[Market Mood API docs](https://sentisense.ai/docs/api/market-mood/)
|