@clear-street/clearstreet 0.74.0 → 0.75.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/CHANGELOG.md +13 -0
- package/package.json +1 -1
- package/resources/v1/accounts.d.mts +20 -2
- package/resources/v1/accounts.d.mts.map +1 -1
- package/resources/v1/accounts.d.ts +20 -2
- package/resources/v1/accounts.d.ts.map +1 -1
- package/resources/v1/index.d.mts +1 -1
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -1
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/instrument-data/instrument-data.d.mts +3 -4
- package/resources/v1/instrument-data/instrument-data.d.mts.map +1 -1
- package/resources/v1/instrument-data/instrument-data.d.ts +3 -4
- package/resources/v1/instrument-data/instrument-data.d.ts.map +1 -1
- package/resources/v1/instrument-data/instrument-data.js.map +1 -1
- package/resources/v1/instrument-data/instrument-data.mjs.map +1 -1
- package/resources/v1/instrument-data/market-data.d.mts +9 -14
- package/resources/v1/instrument-data/market-data.d.mts.map +1 -1
- package/resources/v1/instrument-data/market-data.d.ts +9 -14
- package/resources/v1/instrument-data/market-data.d.ts.map +1 -1
- package/resources/v1/instrument-data/market-data.js +3 -8
- package/resources/v1/instrument-data/market-data.js.map +1 -1
- package/resources/v1/instrument-data/market-data.mjs +3 -8
- package/resources/v1/instrument-data/market-data.mjs.map +1 -1
- package/resources/v1/instrument-data/news.d.mts +4 -4
- package/resources/v1/instrument-data/news.d.ts +4 -4
- package/resources/v1/instruments.d.mts +13 -19
- package/resources/v1/instruments.d.mts.map +1 -1
- package/resources/v1/instruments.d.ts +13 -19
- package/resources/v1/instruments.d.ts.map +1 -1
- package/resources/v1/instruments.js +3 -5
- package/resources/v1/instruments.js.map +1 -1
- package/resources/v1/instruments.mjs +3 -5
- package/resources/v1/instruments.mjs.map +1 -1
- package/resources/v1/orders.d.mts +12 -12
- package/resources/v1/orders.d.ts +12 -12
- package/resources/v1/positions.d.mts +9 -11
- package/resources/v1/positions.d.mts.map +1 -1
- package/resources/v1/positions.d.ts +9 -11
- package/resources/v1/positions.d.ts.map +1 -1
- package/resources/v1/v1.d.mts +2 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -2
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/resources/v1/watchlist.d.mts +1 -1
- package/resources/v1/watchlist.d.ts +1 -1
- package/src/resources/v1/accounts.ts +24 -1
- package/src/resources/v1/index.ts +1 -0
- package/src/resources/v1/instrument-data/instrument-data.ts +3 -4
- package/src/resources/v1/instrument-data/market-data.ts +9 -14
- package/src/resources/v1/instrument-data/news.ts +4 -4
- package/src/resources/v1/instruments.ts +13 -19
- package/src/resources/v1/orders.ts +12 -12
- package/src/resources/v1/positions.ts +9 -11
- package/src/resources/v1/v1.ts +2 -0
- package/src/resources/v1/watchlist.ts +1 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"market-data.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,MAAM,yBAAqB;AACvC,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAEnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"market-data.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,MAAM,yBAAqB;AACvC,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAEnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,YAAY,CACV,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -7,19 +7,14 @@ import { RequestOptions } from "../../../internal/request-options.js";
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class MarketData extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Returns the most recent OHLV and current price for the
|
|
11
|
-
* instruments.
|
|
10
|
+
* Returns the most recent open, high, low, volume (OHLV) and current price for the
|
|
11
|
+
* requested instruments.
|
|
12
12
|
*
|
|
13
13
|
* Response contract: every request returns one row per **unique** `instrument_id`,
|
|
14
14
|
* in first-seen request order. Unresolvable IDs come back with `symbol = null` and
|
|
15
|
-
* every market-data field `null`; resolvable IDs with no
|
|
15
|
+
* every market-data field `null`; resolvable IDs with no available data come back
|
|
16
16
|
* with `symbol` populated but market-data fields `null`.
|
|
17
17
|
*
|
|
18
|
-
* **Note (temporary):** ID resolution currently goes through the supplemental
|
|
19
|
-
* screener (OEMS instrument_id → FMP fmp_symbol → metadata_id → realtime cache).
|
|
20
|
-
* Removed when the market-data service serves daily aggregates directly, or when
|
|
21
|
-
* Polygon symbology is loaded into the instrument cache.
|
|
22
|
-
*
|
|
23
18
|
* @example
|
|
24
19
|
* ```ts
|
|
25
20
|
* const response =
|
|
@@ -54,7 +49,7 @@ export declare class MarketData extends APIResource {
|
|
|
54
49
|
*/
|
|
55
50
|
export interface DailySummary {
|
|
56
51
|
/**
|
|
57
|
-
*
|
|
52
|
+
* Unique instrument identifier. Always populated; echoes the request ID.
|
|
58
53
|
*/
|
|
59
54
|
instrument_id: string;
|
|
60
55
|
/**
|
|
@@ -88,7 +83,7 @@ export type DailySummaryList = Array<DailySummary>;
|
|
|
88
83
|
*/
|
|
89
84
|
export interface MarketDataSnapshot {
|
|
90
85
|
/**
|
|
91
|
-
*
|
|
86
|
+
* Unique instrument identifier.
|
|
92
87
|
*/
|
|
93
88
|
instrument_id: string;
|
|
94
89
|
/**
|
|
@@ -125,7 +120,7 @@ export interface MarketDataSnapshot {
|
|
|
125
120
|
export type MarketDataSnapshotList = Array<MarketDataSnapshot>;
|
|
126
121
|
/**
|
|
127
122
|
* Theoretical price and Greeks for an options snapshot. All values are **per
|
|
128
|
-
* share
|
|
123
|
+
* share**; no contract multiplier is applied.
|
|
129
124
|
*/
|
|
130
125
|
export interface SnapshotGreeks {
|
|
131
126
|
/**
|
|
@@ -153,7 +148,7 @@ export interface SnapshotGreeks {
|
|
|
153
148
|
*/
|
|
154
149
|
theta: string;
|
|
155
150
|
/**
|
|
156
|
-
*
|
|
151
|
+
* Timestamp when the Greeks were calculated.
|
|
157
152
|
*/
|
|
158
153
|
timestamp: string;
|
|
159
154
|
/**
|
|
@@ -224,13 +219,13 @@ export interface MarketDataGetSnapshotsResponse extends Shared.BaseResponse {
|
|
|
224
219
|
}
|
|
225
220
|
export interface MarketDataGetDailySummariesParams {
|
|
226
221
|
/**
|
|
227
|
-
* Comma-separated
|
|
222
|
+
* Comma-separated instrument identifiers (required, 1..=100)
|
|
228
223
|
*/
|
|
229
224
|
instrument_ids: string;
|
|
230
225
|
}
|
|
231
226
|
export interface MarketDataGetSnapshotsParams {
|
|
232
227
|
/**
|
|
233
|
-
* Comma-separated
|
|
228
|
+
* Comma-separated instrument identifiers.
|
|
234
229
|
*/
|
|
235
230
|
instrument_ids?: Array<string>;
|
|
236
231
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"market-data.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,MAAM,wBAAqB;AACvC,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAEnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"market-data.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,MAAM,wBAAqB;AACvC,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAEnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,YAAY,CACV,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -8,19 +8,14 @@ const resource_1 = require("../../../core/resource.js");
|
|
|
8
8
|
*/
|
|
9
9
|
class MarketData extends resource_1.APIResource {
|
|
10
10
|
/**
|
|
11
|
-
* Returns the most recent OHLV and current price for the
|
|
12
|
-
* instruments.
|
|
11
|
+
* Returns the most recent open, high, low, volume (OHLV) and current price for the
|
|
12
|
+
* requested instruments.
|
|
13
13
|
*
|
|
14
14
|
* Response contract: every request returns one row per **unique** `instrument_id`,
|
|
15
15
|
* in first-seen request order. Unresolvable IDs come back with `symbol = null` and
|
|
16
|
-
* every market-data field `null`; resolvable IDs with no
|
|
16
|
+
* every market-data field `null`; resolvable IDs with no available data come back
|
|
17
17
|
* with `symbol` populated but market-data fields `null`.
|
|
18
18
|
*
|
|
19
|
-
* **Note (temporary):** ID resolution currently goes through the supplemental
|
|
20
|
-
* screener (OEMS instrument_id → FMP fmp_symbol → metadata_id → realtime cache).
|
|
21
|
-
* Removed when the market-data service serves daily aggregates directly, or when
|
|
22
|
-
* Polygon symbology is loaded into the instrument cache.
|
|
23
|
-
*
|
|
24
19
|
* @example
|
|
25
20
|
* ```ts
|
|
26
21
|
* const response =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"market-data.js","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC
|
|
1
|
+
{"version":3,"file":"market-data.js","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AAxCD,gCAwCC"}
|
|
@@ -5,19 +5,14 @@ import { APIResource } from "../../../core/resource.mjs";
|
|
|
5
5
|
*/
|
|
6
6
|
export class MarketData extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Returns the most recent OHLV and current price for the
|
|
9
|
-
* instruments.
|
|
8
|
+
* Returns the most recent open, high, low, volume (OHLV) and current price for the
|
|
9
|
+
* requested instruments.
|
|
10
10
|
*
|
|
11
11
|
* Response contract: every request returns one row per **unique** `instrument_id`,
|
|
12
12
|
* in first-seen request order. Unresolvable IDs come back with `symbol = null` and
|
|
13
|
-
* every market-data field `null`; resolvable IDs with no
|
|
13
|
+
* every market-data field `null`; resolvable IDs with no available data come back
|
|
14
14
|
* with `symbol` populated but market-data fields `null`.
|
|
15
15
|
*
|
|
16
|
-
* **Note (temporary):** ID resolution currently goes through the supplemental
|
|
17
|
-
* screener (OEMS instrument_id → FMP fmp_symbol → metadata_id → realtime cache).
|
|
18
|
-
* Removed when the market-data service serves daily aggregates directly, or when
|
|
19
|
-
* Polygon symbology is loaded into the instrument cache.
|
|
20
|
-
*
|
|
21
16
|
* @example
|
|
22
17
|
* ```ts
|
|
23
18
|
* const response =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"market-data.mjs","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAKrD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC
|
|
1
|
+
{"version":3,"file":"market-data.mjs","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAKrD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}
|
|
@@ -23,15 +23,15 @@ export declare class News extends APIResource {
|
|
|
23
23
|
*/
|
|
24
24
|
export interface NewsInstrument {
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Instrument identifier.
|
|
27
27
|
*/
|
|
28
28
|
instrument_id: string;
|
|
29
29
|
/**
|
|
30
|
-
* Instrument name/description, if available
|
|
30
|
+
* Instrument name/description, if available.
|
|
31
31
|
*/
|
|
32
32
|
name?: string | null;
|
|
33
33
|
/**
|
|
34
|
-
* Trading symbol, if available
|
|
34
|
+
* Trading symbol, if available.
|
|
35
35
|
*/
|
|
36
36
|
symbol?: string | null;
|
|
37
37
|
}
|
|
@@ -100,7 +100,7 @@ export interface NewsGetNewsParams {
|
|
|
100
100
|
*/
|
|
101
101
|
include_publishers?: string;
|
|
102
102
|
/**
|
|
103
|
-
* Comma-delimited
|
|
103
|
+
* Comma-delimited instrument identifiers to filter by.
|
|
104
104
|
*/
|
|
105
105
|
instrument_ids?: Array<string>;
|
|
106
106
|
/**
|
|
@@ -23,15 +23,15 @@ export declare class News extends APIResource {
|
|
|
23
23
|
*/
|
|
24
24
|
export interface NewsInstrument {
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Instrument identifier.
|
|
27
27
|
*/
|
|
28
28
|
instrument_id: string;
|
|
29
29
|
/**
|
|
30
|
-
* Instrument name/description, if available
|
|
30
|
+
* Instrument name/description, if available.
|
|
31
31
|
*/
|
|
32
32
|
name?: string | null;
|
|
33
33
|
/**
|
|
34
|
-
* Trading symbol, if available
|
|
34
|
+
* Trading symbol, if available.
|
|
35
35
|
*/
|
|
36
36
|
symbol?: string | null;
|
|
37
37
|
}
|
|
@@ -100,7 +100,7 @@ export interface NewsGetNewsParams {
|
|
|
100
100
|
*/
|
|
101
101
|
include_publishers?: string;
|
|
102
102
|
/**
|
|
103
|
-
* Comma-delimited
|
|
103
|
+
* Comma-delimited instrument identifiers to filter by.
|
|
104
104
|
*/
|
|
105
105
|
instrument_ids?: Array<string>;
|
|
106
106
|
/**
|
|
@@ -47,11 +47,9 @@ export declare class Instruments extends APIResource {
|
|
|
47
47
|
* Search instruments by symbol, alternate identifier, or company name.
|
|
48
48
|
*
|
|
49
49
|
* The `q` parameter is case-insensitive and supports ticker symbols, alternate
|
|
50
|
-
* identifiers such as CUSIP, ISIN, OPRA root, and
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* marginability, easy-to-borrow status, and OTC, restricted, and liquidation-only
|
|
54
|
-
* penalties. Defaults to the `EQUITY` asset class (common stocks, preferred
|
|
50
|
+
* identifiers such as CUSIP, ISIN, and OPRA root, and company names for non-option
|
|
51
|
+
* instruments. Results are ranked by match quality plus instrument quality signals
|
|
52
|
+
* and relevance. Defaults to the `EQUITY` asset class (common stocks, preferred
|
|
55
53
|
* shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
|
|
56
54
|
* to search option contracts: by full OSI symbol, by an OSI prefix (root +
|
|
57
55
|
* `YYMMDD` expiry, e.g. `AAPL 261217`), or by a root-scoped phrase such as
|
|
@@ -78,7 +76,7 @@ export type ExerciseStyle = 'AMERICAN' | 'EUROPEAN';
|
|
|
78
76
|
*/
|
|
79
77
|
export interface Instrument {
|
|
80
78
|
/**
|
|
81
|
-
* Unique
|
|
79
|
+
* Unique instrument identifier (UUID)
|
|
82
80
|
*/
|
|
83
81
|
id: string;
|
|
84
82
|
/**
|
|
@@ -151,9 +149,7 @@ export interface Instrument {
|
|
|
151
149
|
*/
|
|
152
150
|
name?: string | null;
|
|
153
151
|
/**
|
|
154
|
-
* Notional
|
|
155
|
-
* `/instruments/search` ranking. Computed at response time so it stays consistent
|
|
156
|
-
* with whatever `adv` and `previous_close` show.
|
|
152
|
+
* Notional average daily volume (ADV multiplied by previous close price).
|
|
157
153
|
*/
|
|
158
154
|
notional_adv?: string | null;
|
|
159
155
|
/**
|
|
@@ -176,7 +172,7 @@ export interface Instrument {
|
|
|
176
172
|
}
|
|
177
173
|
export interface InstrumentCore {
|
|
178
174
|
/**
|
|
179
|
-
* Unique
|
|
175
|
+
* Unique instrument identifier (UUID)
|
|
180
176
|
*/
|
|
181
177
|
id: string;
|
|
182
178
|
/**
|
|
@@ -249,9 +245,7 @@ export interface InstrumentCore {
|
|
|
249
245
|
*/
|
|
250
246
|
name?: string | null;
|
|
251
247
|
/**
|
|
252
|
-
* Notional
|
|
253
|
-
* `/instruments/search` ranking. Computed at response time so it stays consistent
|
|
254
|
-
* with whatever `adv` and `previous_close` show.
|
|
248
|
+
* Notional average daily volume (ADV multiplied by previous close price).
|
|
255
249
|
*/
|
|
256
250
|
notional_adv?: string | null;
|
|
257
251
|
/**
|
|
@@ -277,7 +271,7 @@ export type ListingType = 'STANDARD' | 'FLEX' | 'OTC';
|
|
|
277
271
|
*/
|
|
278
272
|
export interface OptionsContract {
|
|
279
273
|
/**
|
|
280
|
-
*
|
|
274
|
+
* Instrument identifier
|
|
281
275
|
*/
|
|
282
276
|
id: string;
|
|
283
277
|
/**
|
|
@@ -329,7 +323,7 @@ export interface OptionsContract {
|
|
|
329
323
|
*/
|
|
330
324
|
open_interest?: number | null;
|
|
331
325
|
/**
|
|
332
|
-
*
|
|
326
|
+
* Instrument ID of the underlying instrument, when available
|
|
333
327
|
*/
|
|
334
328
|
underlying_instrument_id?: string | null;
|
|
335
329
|
}
|
|
@@ -361,7 +355,7 @@ export interface InstrumentGetInstrumentsParams {
|
|
|
361
355
|
*/
|
|
362
356
|
easy_to_borrow?: boolean;
|
|
363
357
|
/**
|
|
364
|
-
* Comma-separated
|
|
358
|
+
* Comma-separated instrument identifiers
|
|
365
359
|
*/
|
|
366
360
|
instrument_ids?: Array<string>;
|
|
367
361
|
/**
|
|
@@ -423,15 +417,15 @@ export interface InstrumentGetOptionContractsParams {
|
|
|
423
417
|
*/
|
|
424
418
|
underlier?: string;
|
|
425
419
|
/**
|
|
426
|
-
*
|
|
420
|
+
* Instrument identifier or symbol of the underlying equity/index
|
|
427
421
|
*/
|
|
428
422
|
underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
|
|
429
423
|
}
|
|
430
424
|
export interface InstrumentSearchInstrumentsParams {
|
|
431
425
|
/**
|
|
432
426
|
* Search term applied case-insensitively to ticker symbols, alternate identifiers
|
|
433
|
-
* (CUSIP, ISIN, OPRA root
|
|
434
|
-
*
|
|
427
|
+
* (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option
|
|
428
|
+
* searches match symbols and alternate identifiers.
|
|
435
429
|
*/
|
|
436
430
|
q: string;
|
|
437
431
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"instruments.d.mts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD
|
|
1
|
+
{"version":3,"file":"instruments.d.mts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAEzD,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,MAAM,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
|
|
@@ -47,11 +47,9 @@ export declare class Instruments extends APIResource {
|
|
|
47
47
|
* Search instruments by symbol, alternate identifier, or company name.
|
|
48
48
|
*
|
|
49
49
|
* The `q` parameter is case-insensitive and supports ticker symbols, alternate
|
|
50
|
-
* identifiers such as CUSIP, ISIN, OPRA root, and
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* marginability, easy-to-borrow status, and OTC, restricted, and liquidation-only
|
|
54
|
-
* penalties. Defaults to the `EQUITY` asset class (common stocks, preferred
|
|
50
|
+
* identifiers such as CUSIP, ISIN, and OPRA root, and company names for non-option
|
|
51
|
+
* instruments. Results are ranked by match quality plus instrument quality signals
|
|
52
|
+
* and relevance. Defaults to the `EQUITY` asset class (common stocks, preferred
|
|
55
53
|
* shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
|
|
56
54
|
* to search option contracts: by full OSI symbol, by an OSI prefix (root +
|
|
57
55
|
* `YYMMDD` expiry, e.g. `AAPL 261217`), or by a root-scoped phrase such as
|
|
@@ -78,7 +76,7 @@ export type ExerciseStyle = 'AMERICAN' | 'EUROPEAN';
|
|
|
78
76
|
*/
|
|
79
77
|
export interface Instrument {
|
|
80
78
|
/**
|
|
81
|
-
* Unique
|
|
79
|
+
* Unique instrument identifier (UUID)
|
|
82
80
|
*/
|
|
83
81
|
id: string;
|
|
84
82
|
/**
|
|
@@ -151,9 +149,7 @@ export interface Instrument {
|
|
|
151
149
|
*/
|
|
152
150
|
name?: string | null;
|
|
153
151
|
/**
|
|
154
|
-
* Notional
|
|
155
|
-
* `/instruments/search` ranking. Computed at response time so it stays consistent
|
|
156
|
-
* with whatever `adv` and `previous_close` show.
|
|
152
|
+
* Notional average daily volume (ADV multiplied by previous close price).
|
|
157
153
|
*/
|
|
158
154
|
notional_adv?: string | null;
|
|
159
155
|
/**
|
|
@@ -176,7 +172,7 @@ export interface Instrument {
|
|
|
176
172
|
}
|
|
177
173
|
export interface InstrumentCore {
|
|
178
174
|
/**
|
|
179
|
-
* Unique
|
|
175
|
+
* Unique instrument identifier (UUID)
|
|
180
176
|
*/
|
|
181
177
|
id: string;
|
|
182
178
|
/**
|
|
@@ -249,9 +245,7 @@ export interface InstrumentCore {
|
|
|
249
245
|
*/
|
|
250
246
|
name?: string | null;
|
|
251
247
|
/**
|
|
252
|
-
* Notional
|
|
253
|
-
* `/instruments/search` ranking. Computed at response time so it stays consistent
|
|
254
|
-
* with whatever `adv` and `previous_close` show.
|
|
248
|
+
* Notional average daily volume (ADV multiplied by previous close price).
|
|
255
249
|
*/
|
|
256
250
|
notional_adv?: string | null;
|
|
257
251
|
/**
|
|
@@ -277,7 +271,7 @@ export type ListingType = 'STANDARD' | 'FLEX' | 'OTC';
|
|
|
277
271
|
*/
|
|
278
272
|
export interface OptionsContract {
|
|
279
273
|
/**
|
|
280
|
-
*
|
|
274
|
+
* Instrument identifier
|
|
281
275
|
*/
|
|
282
276
|
id: string;
|
|
283
277
|
/**
|
|
@@ -329,7 +323,7 @@ export interface OptionsContract {
|
|
|
329
323
|
*/
|
|
330
324
|
open_interest?: number | null;
|
|
331
325
|
/**
|
|
332
|
-
*
|
|
326
|
+
* Instrument ID of the underlying instrument, when available
|
|
333
327
|
*/
|
|
334
328
|
underlying_instrument_id?: string | null;
|
|
335
329
|
}
|
|
@@ -361,7 +355,7 @@ export interface InstrumentGetInstrumentsParams {
|
|
|
361
355
|
*/
|
|
362
356
|
easy_to_borrow?: boolean;
|
|
363
357
|
/**
|
|
364
|
-
* Comma-separated
|
|
358
|
+
* Comma-separated instrument identifiers
|
|
365
359
|
*/
|
|
366
360
|
instrument_ids?: Array<string>;
|
|
367
361
|
/**
|
|
@@ -423,15 +417,15 @@ export interface InstrumentGetOptionContractsParams {
|
|
|
423
417
|
*/
|
|
424
418
|
underlier?: string;
|
|
425
419
|
/**
|
|
426
|
-
*
|
|
420
|
+
* Instrument identifier or symbol of the underlying equity/index
|
|
427
421
|
*/
|
|
428
422
|
underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
|
|
429
423
|
}
|
|
430
424
|
export interface InstrumentSearchInstrumentsParams {
|
|
431
425
|
/**
|
|
432
426
|
* Search term applied case-insensitively to ticker symbols, alternate identifiers
|
|
433
|
-
* (CUSIP, ISIN, OPRA root
|
|
434
|
-
*
|
|
427
|
+
* (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option
|
|
428
|
+
* searches match symbols and alternate identifiers.
|
|
435
429
|
*/
|
|
436
430
|
q: string;
|
|
437
431
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD
|
|
1
|
+
{"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAEzD,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,MAAM,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
|
|
@@ -53,11 +53,9 @@ class Instruments extends resource_1.APIResource {
|
|
|
53
53
|
* Search instruments by symbol, alternate identifier, or company name.
|
|
54
54
|
*
|
|
55
55
|
* The `q` parameter is case-insensitive and supports ticker symbols, alternate
|
|
56
|
-
* identifiers such as CUSIP, ISIN, OPRA root, and
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
* marginability, easy-to-borrow status, and OTC, restricted, and liquidation-only
|
|
60
|
-
* penalties. Defaults to the `EQUITY` asset class (common stocks, preferred
|
|
56
|
+
* identifiers such as CUSIP, ISIN, and OPRA root, and company names for non-option
|
|
57
|
+
* instruments. Results are ranked by match quality plus instrument quality signals
|
|
58
|
+
* and relevance. Defaults to the `EQUITY` asset class (common stocks, preferred
|
|
61
59
|
* shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
|
|
62
60
|
* to search option contracts: by full OSI symbol, by an OSI prefix (root +
|
|
63
61
|
* `YYMMDD` expiry, e.g. `AAPL 261217`), or by a root-scoped phrase such as
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"instruments.js","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAA4C,EAC5C,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CACZ,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"instruments.js","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAA4C,EAC5C,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CACZ,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AA/ED,kCA+EC"}
|
|
@@ -50,11 +50,9 @@ export class Instruments extends APIResource {
|
|
|
50
50
|
* Search instruments by symbol, alternate identifier, or company name.
|
|
51
51
|
*
|
|
52
52
|
* The `q` parameter is case-insensitive and supports ticker symbols, alternate
|
|
53
|
-
* identifiers such as CUSIP, ISIN, OPRA root, and
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
* marginability, easy-to-borrow status, and OTC, restricted, and liquidation-only
|
|
57
|
-
* penalties. Defaults to the `EQUITY` asset class (common stocks, preferred
|
|
53
|
+
* identifiers such as CUSIP, ISIN, and OPRA root, and company names for non-option
|
|
54
|
+
* instruments. Results are ranked by match quality plus instrument quality signals
|
|
55
|
+
* and relevance. Defaults to the `EQUITY` asset class (common stocks, preferred
|
|
58
56
|
* shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
|
|
59
57
|
* to search option contracts: by full OSI symbol, by an OSI prefix (root +
|
|
60
58
|
* `YYMMDD` expiry, e.g. `AAPL 261217`), or by a root-scoped phrase such as
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"instruments.mjs","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAMlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAA4C,EAC5C,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CACZ,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"instruments.mjs","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAMlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAA4C,EAC5C,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CACZ,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF"}
|
|
@@ -133,7 +133,7 @@ export interface Execution {
|
|
|
133
133
|
*/
|
|
134
134
|
id: string;
|
|
135
135
|
/**
|
|
136
|
-
*
|
|
136
|
+
* Unique instrument identifier.
|
|
137
137
|
*/
|
|
138
138
|
instrument_id: string;
|
|
139
139
|
/**
|
|
@@ -163,7 +163,7 @@ export interface Execution {
|
|
|
163
163
|
}
|
|
164
164
|
export type ExecutionList = Array<Execution>;
|
|
165
165
|
/**
|
|
166
|
-
*
|
|
166
|
+
* Instrument identifier
|
|
167
167
|
*/
|
|
168
168
|
export type InstrumentIDOrSymbol = string;
|
|
169
169
|
/**
|
|
@@ -203,7 +203,7 @@ export interface NewOrderRequest {
|
|
|
203
203
|
*/
|
|
204
204
|
extended_hours?: boolean | null;
|
|
205
205
|
/**
|
|
206
|
-
*
|
|
206
|
+
* Instrument identifier
|
|
207
207
|
*/
|
|
208
208
|
instrument_id?: InstrumentIDOrSymbol | null;
|
|
209
209
|
/**
|
|
@@ -254,7 +254,7 @@ export interface Order {
|
|
|
254
254
|
*/
|
|
255
255
|
account_id: number;
|
|
256
256
|
/**
|
|
257
|
-
* Client-provided identifier echoed back
|
|
257
|
+
* Client-provided identifier echoed back.
|
|
258
258
|
*/
|
|
259
259
|
client_order_id: string;
|
|
260
260
|
/**
|
|
@@ -266,7 +266,7 @@ export interface Order {
|
|
|
266
266
|
*/
|
|
267
267
|
filled_quantity: string;
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
* Instrument identifier for the traded instrument.
|
|
270
270
|
*/
|
|
271
271
|
instrument_id: string;
|
|
272
272
|
/**
|
|
@@ -372,9 +372,9 @@ export interface Order {
|
|
|
372
372
|
*/
|
|
373
373
|
trailing_watermark_ts?: string | null;
|
|
374
374
|
/**
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
* resolved
|
|
375
|
+
* Instrument ID of the option's underlying instrument. Populated only for options
|
|
376
|
+
* orders; `null` for non-options and for options whose underlier cannot be
|
|
377
|
+
* resolved.
|
|
378
378
|
*/
|
|
379
379
|
underlying_instrument_id?: string | null;
|
|
380
380
|
}
|
|
@@ -459,7 +459,7 @@ export interface OrderSubmitOrdersResponse extends Shared.BaseResponse {
|
|
|
459
459
|
}
|
|
460
460
|
export interface OrderCancelAllOpenOrdersParams {
|
|
461
461
|
/**
|
|
462
|
-
* Comma-separated
|
|
462
|
+
* Comma-separated instrument identifiers
|
|
463
463
|
*/
|
|
464
464
|
instrument_ids?: Array<string>;
|
|
465
465
|
/**
|
|
@@ -488,7 +488,7 @@ export interface OrderGetExecutionsParams {
|
|
|
488
488
|
from?: string;
|
|
489
489
|
/**
|
|
490
490
|
* Optional instrument to filter by. Accepts either a symbol (e.g. `AAPL`) or an
|
|
491
|
-
*
|
|
491
|
+
* instrument identifier.
|
|
492
492
|
*/
|
|
493
493
|
instrument_id?: InstrumentIDOrSymbol;
|
|
494
494
|
/**
|
|
@@ -518,7 +518,7 @@ export interface OrderGetOrdersParams {
|
|
|
518
518
|
*/
|
|
519
519
|
from?: string;
|
|
520
520
|
/**
|
|
521
|
-
* Comma-separated
|
|
521
|
+
* Comma-separated instrument identifiers
|
|
522
522
|
*/
|
|
523
523
|
instrument_ids?: Array<string>;
|
|
524
524
|
/**
|
|
@@ -548,7 +548,7 @@ export interface OrderGetOrdersParams {
|
|
|
548
548
|
*/
|
|
549
549
|
to?: string;
|
|
550
550
|
/**
|
|
551
|
-
* Comma-separated
|
|
551
|
+
* Comma-separated instrument identifiers. Matches options orders whose resolved
|
|
552
552
|
* underlier is any of the given IDs.
|
|
553
553
|
*/
|
|
554
554
|
underlying_instrument_ids?: Array<string>;
|