sentisense 0.38.0 → 0.39.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/dist/index.d.mts CHANGED
@@ -6,15 +6,21 @@ interface SentiSenseOptions {
6
6
  }
7
7
  interface StockPrice {
8
8
  ticker: string;
9
- /** Regular-session price. During RTH: live last trade. Otherwise: most recent RTH close. */
9
+ /** Regular-session price, delayed 15 minutes. During RTH: the most recent regular-session value. Otherwise: most recent RTH close. */
10
10
  currentPrice: number;
11
11
  change: number;
12
12
  changePercent: number;
13
13
  previousClose: number;
14
14
  /** Regular-session volume. */
15
15
  volume: number;
16
- /** Unix timestamp in milliseconds of the price quote. */
16
+ /** Unix timestamp in milliseconds of when this response was served. Not the age of the price: it tracks the current clock regardless of how old the value is. */
17
17
  timestamp: number;
18
+ /**
19
+ * Unix timestamp in milliseconds of the market data behind `currentPrice`. Read this for
20
+ * freshness rather than `timestamp`. Absent outside regular hours, and whenever the upstream
21
+ * data carries no time of its own, so treat an absent value as unknown age, not as fresh.
22
+ */
23
+ priceAsOf?: number;
18
24
  /** Extended-hours view (pre-market or after-hours). Null/absent during RTH, overnight, and weekends. */
19
25
  extendedHours?: ExtendedHoursInfo | null;
20
26
  /**
@@ -48,7 +54,7 @@ interface ExtendedHoursInfo {
48
54
  /** Aggregate quote snapshot from GET /api/v1/stocks/{ticker}/quote. */
49
55
  interface StockQuote {
50
56
  ticker: string;
51
- /** Regular-session price. During RTH: live last trade. Otherwise: most recent RTH close. */
57
+ /** Regular-session price, delayed 15 minutes. During RTH: the most recent regular-session value. Otherwise: most recent RTH close. */
52
58
  currentPrice: number | null;
53
59
  change: number | null;
54
60
  changePercent: number | null;
@@ -92,7 +98,14 @@ interface StockQuote {
92
98
  delistedDate?: string;
93
99
  /** Why it delisted. Absent unless `listingStatus` is `DELISTED`. */
94
100
  delistingReason?: 'acquired' | 'take_private' | 'bankruptcy' | 'exchange_rule' | 'merged';
101
+ /** Unix timestamp in milliseconds of when this response was served. Not the age of the price. */
95
102
  timestamp: number | null;
103
+ /**
104
+ * Unix timestamp in milliseconds of the market data behind `currentPrice`. Read this for
105
+ * freshness rather than `timestamp`. Absent outside regular hours, and whenever the upstream
106
+ * data carries no time of its own, so treat an absent value as unknown age, not as fresh.
107
+ */
108
+ priceAsOf?: number;
96
109
  /** Extended-hours view (pre-market or after-hours). Null/absent during RTH, overnight, and weekends. */
97
110
  extendedHours?: ExtendedHoursInfo | null;
98
111
  }
package/dist/index.d.ts CHANGED
@@ -6,15 +6,21 @@ interface SentiSenseOptions {
6
6
  }
7
7
  interface StockPrice {
8
8
  ticker: string;
9
- /** Regular-session price. During RTH: live last trade. Otherwise: most recent RTH close. */
9
+ /** Regular-session price, delayed 15 minutes. During RTH: the most recent regular-session value. Otherwise: most recent RTH close. */
10
10
  currentPrice: number;
11
11
  change: number;
12
12
  changePercent: number;
13
13
  previousClose: number;
14
14
  /** Regular-session volume. */
15
15
  volume: number;
16
- /** Unix timestamp in milliseconds of the price quote. */
16
+ /** Unix timestamp in milliseconds of when this response was served. Not the age of the price: it tracks the current clock regardless of how old the value is. */
17
17
  timestamp: number;
18
+ /**
19
+ * Unix timestamp in milliseconds of the market data behind `currentPrice`. Read this for
20
+ * freshness rather than `timestamp`. Absent outside regular hours, and whenever the upstream
21
+ * data carries no time of its own, so treat an absent value as unknown age, not as fresh.
22
+ */
23
+ priceAsOf?: number;
18
24
  /** Extended-hours view (pre-market or after-hours). Null/absent during RTH, overnight, and weekends. */
19
25
  extendedHours?: ExtendedHoursInfo | null;
20
26
  /**
@@ -48,7 +54,7 @@ interface ExtendedHoursInfo {
48
54
  /** Aggregate quote snapshot from GET /api/v1/stocks/{ticker}/quote. */
49
55
  interface StockQuote {
50
56
  ticker: string;
51
- /** Regular-session price. During RTH: live last trade. Otherwise: most recent RTH close. */
57
+ /** Regular-session price, delayed 15 minutes. During RTH: the most recent regular-session value. Otherwise: most recent RTH close. */
52
58
  currentPrice: number | null;
53
59
  change: number | null;
54
60
  changePercent: number | null;
@@ -92,7 +98,14 @@ interface StockQuote {
92
98
  delistedDate?: string;
93
99
  /** Why it delisted. Absent unless `listingStatus` is `DELISTED`. */
94
100
  delistingReason?: 'acquired' | 'take_private' | 'bankruptcy' | 'exchange_rule' | 'merged';
101
+ /** Unix timestamp in milliseconds of when this response was served. Not the age of the price. */
95
102
  timestamp: number | null;
103
+ /**
104
+ * Unix timestamp in milliseconds of the market data behind `currentPrice`. Read this for
105
+ * freshness rather than `timestamp`. Absent outside regular hours, and whenever the upstream
106
+ * data carries no time of its own, so treat an absent value as unknown age, not as fresh.
107
+ */
108
+ priceAsOf?: number;
96
109
  /** Extended-hours view (pre-market or after-hours). Null/absent during RTH, overnight, and weekends. */
97
110
  extendedHours?: ExtendedHoursInfo | null;
98
111
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sentisense",
3
- "version": "0.38.0",
3
+ "version": "0.39.0",
4
4
  "description": "Official JavaScript/TypeScript SDK for the SentiSense market intelligence API",
5
5
  "author": "SentiSense <support@sentisense.ai>",
6
6
  "license": "MIT",