@clear-street/clearstreet 0.74.1 → 0.76.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 +19 -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 -2
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -2
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +1 -3
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +0 -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 +25 -22
- package/resources/v1/positions.d.mts.map +1 -1
- package/resources/v1/positions.d.ts +25 -22
- package/resources/v1/positions.d.ts.map +1 -1
- package/resources/v1/positions.js +11 -5
- package/resources/v1/positions.js.map +1 -1
- package/resources/v1/positions.mjs +11 -5
- package/resources/v1/positions.mjs.map +1 -1
- package/resources/v1/v1.d.mts +2 -6
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -6
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +0 -4
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +0 -4
- 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 -1
- 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 +24 -22
- package/src/resources/v1/v1.ts +2 -6
- 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
- package/resources/v1/websocket.d.mts +0 -18
- package/resources/v1/websocket.d.mts.map +0 -1
- package/resources/v1/websocket.d.ts +0 -18
- package/resources/v1/websocket.d.ts.map +0 -1
- package/resources/v1/websocket.js +0 -27
- package/resources/v1/websocket.js.map +0 -1
- package/resources/v1/websocket.mjs +0 -23
- package/resources/v1/websocket.mjs.map +0 -1
- package/src/resources/v1/websocket.ts +0 -26
|
@@ -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>;
|
package/resources/v1/orders.d.ts
CHANGED
|
@@ -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>;
|
|
@@ -56,6 +56,12 @@ export declare class Positions extends APIResource {
|
|
|
56
56
|
* Returns the current lifecycle state of the account's position instructions.
|
|
57
57
|
* Optionally filter by a specific contract.
|
|
58
58
|
*
|
|
59
|
+
* Note: instructions that fail pre-acceptance validation on `POST` — duplicates,
|
|
60
|
+
* `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` on a non-expiry day, insufficient
|
|
61
|
+
* position, or an unresolvable instrument — are rejected (with `status = REJECTED`
|
|
62
|
+
* and a `rejection_reason`) without being persisted, so they surface only in the
|
|
63
|
+
* `POST` response and never appear in this list.
|
|
64
|
+
*
|
|
59
65
|
* @example
|
|
60
66
|
* ```ts
|
|
61
67
|
* const response =
|
|
@@ -80,14 +86,14 @@ export declare class Positions extends APIResource {
|
|
|
80
86
|
*
|
|
81
87
|
* - **All rows accepted** → `200 OK`. Every row is in `data` with `status = SENT`.
|
|
82
88
|
* - **Partial success** → `207 Multi-Status`. `data` contains every row; rejected
|
|
83
|
-
* rows carry `status =
|
|
84
|
-
*
|
|
89
|
+
* rows carry `status = REJECTED` and `rejection_reason`. The top-level `error`
|
|
90
|
+
* summarizes the batch failure.
|
|
85
91
|
* - **All rows rejected** → `4xx`/`5xx`. The HTTP status reflects the aggregate
|
|
86
92
|
* cause: `409` when every row was a duplicate, `400` for validation failures
|
|
87
93
|
* like DNE/CEA on a non-expiry day, `503` if the clearing service is
|
|
88
|
-
* unavailable. `data` still contains every row carrying
|
|
89
|
-
* `
|
|
90
|
-
*
|
|
94
|
+
* unavailable. `data` still contains every row carrying `status = REJECTED` and
|
|
95
|
+
* `rejection_reason` so callers can attribute failures by `instruction_id`; the
|
|
96
|
+
* top-level `error` summarizes the batch.
|
|
91
97
|
*
|
|
92
98
|
* @example
|
|
93
99
|
* ```ts
|
|
@@ -119,7 +125,7 @@ export interface Position {
|
|
|
119
125
|
*/
|
|
120
126
|
available_quantity: string;
|
|
121
127
|
/**
|
|
122
|
-
*
|
|
128
|
+
* Unique instrument identifier
|
|
123
129
|
*/
|
|
124
130
|
instrument_id: string;
|
|
125
131
|
/**
|
|
@@ -172,7 +178,7 @@ export interface Position {
|
|
|
172
178
|
*/
|
|
173
179
|
instrument_price?: string | null;
|
|
174
180
|
/**
|
|
175
|
-
*
|
|
181
|
+
* Identifier of the underlying instrument, when available
|
|
176
182
|
*/
|
|
177
183
|
underlying_instrument_id?: string | null;
|
|
178
184
|
/**
|
|
@@ -234,9 +240,9 @@ export interface PositionInstruction {
|
|
|
234
240
|
created_at?: string | null;
|
|
235
241
|
/**
|
|
236
242
|
* Human-readable explanation populated on any non-success terminal status —
|
|
237
|
-
* `REJECTED
|
|
238
|
-
*
|
|
239
|
-
*
|
|
243
|
+
* `REJECTED` or `CANCEL_FAILED`. On a `207 Multi-Status` batch submit the
|
|
244
|
+
* top-level `error` field summarizes the batch; per-row detail continues to live
|
|
245
|
+
* here.
|
|
240
246
|
*/
|
|
241
247
|
rejection_reason?: string | null;
|
|
242
248
|
/**
|
|
@@ -248,23 +254,20 @@ export type PositionInstructionList = Array<PositionInstruction>;
|
|
|
248
254
|
/**
|
|
249
255
|
* Lifecycle status of a position instruction.
|
|
250
256
|
*
|
|
251
|
-
* - `SENT`: accepted and
|
|
257
|
+
* - `SENT`: accepted and submitted to the clearing venue.
|
|
252
258
|
* - `ACCEPTED`: terminal — accepted by the clearing venue.
|
|
253
|
-
* - `REJECTED`: terminal rejection
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
*
|
|
258
|
-
* on a non-expiry day, insufficient position, or an instrument that does not
|
|
259
|
-
* resolve.
|
|
259
|
+
* - `REJECTED`: terminal rejection; `rejection_reason` carries the detail. Covers
|
|
260
|
+
* both venue-reported rejections and rejections raised before the instruction
|
|
261
|
+
* reached the clearing venue (e.g. duplicate `instruction_id`, `DO_NOT_EXERCISE`
|
|
262
|
+
* / `CONTRARY_EXERCISE` submitted on a non-expiry day, insufficient position, or
|
|
263
|
+
* an instrument that does not resolve).
|
|
260
264
|
* - `CANCEL_REQUESTED`: cancel accepted; final cancel state pending.
|
|
261
265
|
* - `CANCELLED`: terminal — cancel completed.
|
|
262
266
|
* - `CANCEL_FAILED`: cancel could not be completed; operator attention required.
|
|
263
267
|
* `rejection_reason` carries the detail.
|
|
264
|
-
* - `UNKNOWN`: status could not be
|
|
265
|
-
* in practice; surfaces a service version skew.
|
|
268
|
+
* - `UNKNOWN`: status could not be determined.
|
|
266
269
|
*/
|
|
267
|
-
export type PositionInstructionStatus = 'SENT' | 'ACCEPTED' | 'REJECTED' | '
|
|
270
|
+
export type PositionInstructionStatus = 'SENT' | 'ACCEPTED' | 'REJECTED' | 'CANCEL_REQUESTED' | 'CANCELLED' | 'CANCEL_FAILED' | 'UNKNOWN';
|
|
268
271
|
/**
|
|
269
272
|
* The action to take against an options position.
|
|
270
273
|
*/
|
|
@@ -327,7 +330,7 @@ export interface PositionGetPositionInstructionsParams {
|
|
|
327
330
|
}
|
|
328
331
|
export interface PositionGetPositionsParams {
|
|
329
332
|
/**
|
|
330
|
-
* Comma-separated
|
|
333
|
+
* Comma-separated instrument identifiers
|
|
331
334
|
*/
|
|
332
335
|
instrument_ids?: Array<string>;
|
|
333
336
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"positions.d.mts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C
|
|
1
|
+
{"version":3,"file":"positions.d.mts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAEpG,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAChD;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
|
|
@@ -56,6 +56,12 @@ export declare class Positions extends APIResource {
|
|
|
56
56
|
* Returns the current lifecycle state of the account's position instructions.
|
|
57
57
|
* Optionally filter by a specific contract.
|
|
58
58
|
*
|
|
59
|
+
* Note: instructions that fail pre-acceptance validation on `POST` — duplicates,
|
|
60
|
+
* `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` on a non-expiry day, insufficient
|
|
61
|
+
* position, or an unresolvable instrument — are rejected (with `status = REJECTED`
|
|
62
|
+
* and a `rejection_reason`) without being persisted, so they surface only in the
|
|
63
|
+
* `POST` response and never appear in this list.
|
|
64
|
+
*
|
|
59
65
|
* @example
|
|
60
66
|
* ```ts
|
|
61
67
|
* const response =
|
|
@@ -80,14 +86,14 @@ export declare class Positions extends APIResource {
|
|
|
80
86
|
*
|
|
81
87
|
* - **All rows accepted** → `200 OK`. Every row is in `data` with `status = SENT`.
|
|
82
88
|
* - **Partial success** → `207 Multi-Status`. `data` contains every row; rejected
|
|
83
|
-
* rows carry `status =
|
|
84
|
-
*
|
|
89
|
+
* rows carry `status = REJECTED` and `rejection_reason`. The top-level `error`
|
|
90
|
+
* summarizes the batch failure.
|
|
85
91
|
* - **All rows rejected** → `4xx`/`5xx`. The HTTP status reflects the aggregate
|
|
86
92
|
* cause: `409` when every row was a duplicate, `400` for validation failures
|
|
87
93
|
* like DNE/CEA on a non-expiry day, `503` if the clearing service is
|
|
88
|
-
* unavailable. `data` still contains every row carrying
|
|
89
|
-
* `
|
|
90
|
-
*
|
|
94
|
+
* unavailable. `data` still contains every row carrying `status = REJECTED` and
|
|
95
|
+
* `rejection_reason` so callers can attribute failures by `instruction_id`; the
|
|
96
|
+
* top-level `error` summarizes the batch.
|
|
91
97
|
*
|
|
92
98
|
* @example
|
|
93
99
|
* ```ts
|
|
@@ -119,7 +125,7 @@ export interface Position {
|
|
|
119
125
|
*/
|
|
120
126
|
available_quantity: string;
|
|
121
127
|
/**
|
|
122
|
-
*
|
|
128
|
+
* Unique instrument identifier
|
|
123
129
|
*/
|
|
124
130
|
instrument_id: string;
|
|
125
131
|
/**
|
|
@@ -172,7 +178,7 @@ export interface Position {
|
|
|
172
178
|
*/
|
|
173
179
|
instrument_price?: string | null;
|
|
174
180
|
/**
|
|
175
|
-
*
|
|
181
|
+
* Identifier of the underlying instrument, when available
|
|
176
182
|
*/
|
|
177
183
|
underlying_instrument_id?: string | null;
|
|
178
184
|
/**
|
|
@@ -234,9 +240,9 @@ export interface PositionInstruction {
|
|
|
234
240
|
created_at?: string | null;
|
|
235
241
|
/**
|
|
236
242
|
* Human-readable explanation populated on any non-success terminal status —
|
|
237
|
-
* `REJECTED
|
|
238
|
-
*
|
|
239
|
-
*
|
|
243
|
+
* `REJECTED` or `CANCEL_FAILED`. On a `207 Multi-Status` batch submit the
|
|
244
|
+
* top-level `error` field summarizes the batch; per-row detail continues to live
|
|
245
|
+
* here.
|
|
240
246
|
*/
|
|
241
247
|
rejection_reason?: string | null;
|
|
242
248
|
/**
|
|
@@ -248,23 +254,20 @@ export type PositionInstructionList = Array<PositionInstruction>;
|
|
|
248
254
|
/**
|
|
249
255
|
* Lifecycle status of a position instruction.
|
|
250
256
|
*
|
|
251
|
-
* - `SENT`: accepted and
|
|
257
|
+
* - `SENT`: accepted and submitted to the clearing venue.
|
|
252
258
|
* - `ACCEPTED`: terminal — accepted by the clearing venue.
|
|
253
|
-
* - `REJECTED`: terminal rejection
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
*
|
|
258
|
-
* on a non-expiry day, insufficient position, or an instrument that does not
|
|
259
|
-
* resolve.
|
|
259
|
+
* - `REJECTED`: terminal rejection; `rejection_reason` carries the detail. Covers
|
|
260
|
+
* both venue-reported rejections and rejections raised before the instruction
|
|
261
|
+
* reached the clearing venue (e.g. duplicate `instruction_id`, `DO_NOT_EXERCISE`
|
|
262
|
+
* / `CONTRARY_EXERCISE` submitted on a non-expiry day, insufficient position, or
|
|
263
|
+
* an instrument that does not resolve).
|
|
260
264
|
* - `CANCEL_REQUESTED`: cancel accepted; final cancel state pending.
|
|
261
265
|
* - `CANCELLED`: terminal — cancel completed.
|
|
262
266
|
* - `CANCEL_FAILED`: cancel could not be completed; operator attention required.
|
|
263
267
|
* `rejection_reason` carries the detail.
|
|
264
|
-
* - `UNKNOWN`: status could not be
|
|
265
|
-
* in practice; surfaces a service version skew.
|
|
268
|
+
* - `UNKNOWN`: status could not be determined.
|
|
266
269
|
*/
|
|
267
|
-
export type PositionInstructionStatus = 'SENT' | 'ACCEPTED' | 'REJECTED' | '
|
|
270
|
+
export type PositionInstructionStatus = 'SENT' | 'ACCEPTED' | 'REJECTED' | 'CANCEL_REQUESTED' | 'CANCELLED' | 'CANCEL_FAILED' | 'UNKNOWN';
|
|
268
271
|
/**
|
|
269
272
|
* The action to take against an options position.
|
|
270
273
|
*/
|
|
@@ -327,7 +330,7 @@ export interface PositionGetPositionInstructionsParams {
|
|
|
327
330
|
}
|
|
328
331
|
export interface PositionGetPositionsParams {
|
|
329
332
|
/**
|
|
330
|
-
* Comma-separated
|
|
333
|
+
* Comma-separated instrument identifiers
|
|
331
334
|
*/
|
|
332
335
|
instrument_ids?: Array<string>;
|
|
333
336
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"positions.d.ts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C
|
|
1
|
+
{"version":3,"file":"positions.d.ts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAEpG,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAChD;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
|
|
@@ -66,6 +66,12 @@ class Positions extends resource_1.APIResource {
|
|
|
66
66
|
* Returns the current lifecycle state of the account's position instructions.
|
|
67
67
|
* Optionally filter by a specific contract.
|
|
68
68
|
*
|
|
69
|
+
* Note: instructions that fail pre-acceptance validation on `POST` — duplicates,
|
|
70
|
+
* `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` on a non-expiry day, insufficient
|
|
71
|
+
* position, or an unresolvable instrument — are rejected (with `status = REJECTED`
|
|
72
|
+
* and a `rejection_reason`) without being persisted, so they surface only in the
|
|
73
|
+
* `POST` response and never appear in this list.
|
|
74
|
+
*
|
|
69
75
|
* @example
|
|
70
76
|
* ```ts
|
|
71
77
|
* const response =
|
|
@@ -94,14 +100,14 @@ class Positions extends resource_1.APIResource {
|
|
|
94
100
|
*
|
|
95
101
|
* - **All rows accepted** → `200 OK`. Every row is in `data` with `status = SENT`.
|
|
96
102
|
* - **Partial success** → `207 Multi-Status`. `data` contains every row; rejected
|
|
97
|
-
* rows carry `status =
|
|
98
|
-
*
|
|
103
|
+
* rows carry `status = REJECTED` and `rejection_reason`. The top-level `error`
|
|
104
|
+
* summarizes the batch failure.
|
|
99
105
|
* - **All rows rejected** → `4xx`/`5xx`. The HTTP status reflects the aggregate
|
|
100
106
|
* cause: `409` when every row was a duplicate, `400` for validation failures
|
|
101
107
|
* like DNE/CEA on a non-expiry day, `503` if the clearing service is
|
|
102
|
-
* unavailable. `data` still contains every row carrying
|
|
103
|
-
* `
|
|
104
|
-
*
|
|
108
|
+
* unavailable. `data` still contains every row carrying `status = REJECTED` and
|
|
109
|
+
* `rejection_reason` so callers can attribute failures by `instruction_id`; the
|
|
110
|
+
* top-level `error` summarizes the batch.
|
|
105
111
|
*
|
|
106
112
|
* @example
|
|
107
113
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"positions.js","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAqB,EACrB,MAA+C,EAC/C,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,IAAA,WAAI,EAAA,gBAAgB,UAAU,2BAA2B,aAAa,EAAE,EACxE,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAA4C,EAC5C,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,cAAc,YAAY,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAiB,EACjB,OAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"positions.js","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAqB,EACrB,MAA+C,EAC/C,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,IAAA,WAAI,EAAA,gBAAgB,UAAU,2BAA2B,aAAa,EAAE,EACxE,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAA4C,EAC5C,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,cAAc,YAAY,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAiB,EACjB,OAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAiB,EACjB,QAAkE,EAAE,EACpE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,SAAiB,EACjB,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAiB,EACjB,MAAgD,EAChD,OAAwB;QAExB,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,yBAAyB,EAAE;YAC/E,IAAI,EAAE,YAAY;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA5JD,8BA4JC"}
|
|
@@ -63,6 +63,12 @@ export class Positions extends APIResource {
|
|
|
63
63
|
* Returns the current lifecycle state of the account's position instructions.
|
|
64
64
|
* Optionally filter by a specific contract.
|
|
65
65
|
*
|
|
66
|
+
* Note: instructions that fail pre-acceptance validation on `POST` — duplicates,
|
|
67
|
+
* `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` on a non-expiry day, insufficient
|
|
68
|
+
* position, or an unresolvable instrument — are rejected (with `status = REJECTED`
|
|
69
|
+
* and a `rejection_reason`) without being persisted, so they surface only in the
|
|
70
|
+
* `POST` response and never appear in this list.
|
|
71
|
+
*
|
|
66
72
|
* @example
|
|
67
73
|
* ```ts
|
|
68
74
|
* const response =
|
|
@@ -91,14 +97,14 @@ export class Positions extends APIResource {
|
|
|
91
97
|
*
|
|
92
98
|
* - **All rows accepted** → `200 OK`. Every row is in `data` with `status = SENT`.
|
|
93
99
|
* - **Partial success** → `207 Multi-Status`. `data` contains every row; rejected
|
|
94
|
-
* rows carry `status =
|
|
95
|
-
*
|
|
100
|
+
* rows carry `status = REJECTED` and `rejection_reason`. The top-level `error`
|
|
101
|
+
* summarizes the batch failure.
|
|
96
102
|
* - **All rows rejected** → `4xx`/`5xx`. The HTTP status reflects the aggregate
|
|
97
103
|
* cause: `409` when every row was a duplicate, `400` for validation failures
|
|
98
104
|
* like DNE/CEA on a non-expiry day, `503` if the clearing service is
|
|
99
|
-
* unavailable. `data` still contains every row carrying
|
|
100
|
-
* `
|
|
101
|
-
*
|
|
105
|
+
* unavailable. `data` still contains every row carrying `status = REJECTED` and
|
|
106
|
+
* `rejection_reason` so callers can attribute failures by `instruction_id`; the
|
|
107
|
+
* top-level `error` summarizes the batch.
|
|
102
108
|
*
|
|
103
109
|
* @example
|
|
104
110
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"positions.mjs","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAOlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAqB,EACrB,MAA+C,EAC/C,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,IAAI,CAAA,gBAAgB,UAAU,2BAA2B,aAAa,EAAE,EACxE,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAA4C,EAC5C,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,UAAU,cAAc,YAAY,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAiB,EACjB,OAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"positions.mjs","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAOlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAqB,EACrB,MAA+C,EAC/C,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,IAAI,CAAA,gBAAgB,UAAU,2BAA2B,aAAa,EAAE,EACxE,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAA4C,EAC5C,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,UAAU,cAAc,YAAY,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAiB,EACjB,OAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAiB,EACjB,QAAkE,EAAE,EACpE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,SAAiB,EACjB,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAiB,EACjB,MAAgD,EAChD,OAAwB;QAExB,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,SAAS,yBAAyB,EAAE;YAC/E,IAAI,EAAE,YAAY;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/resources/v1/v1.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
2
|
import * as AccountsAPI from "./accounts.mjs";
|
|
3
|
-
import { Account, AccountBalances, AccountBalancesSod, AccountGetAccountBalancesParams, AccountGetAccountBalancesResponse, AccountGetAccountByIDResponse, AccountGetAccountsParams, AccountGetAccountsResponse, AccountGetPortfolioHistoryParams, AccountGetPortfolioHistoryResponse, AccountList, AccountPatchAccountByIDParams, AccountPatchAccountByIDResponse, AccountSettings, AccountStatus, AccountSubtype, AccountType, Accounts, MarginDetails, MarginDetailsUsage, MarginTopContributor, MarginType, PortfolioHistoryResponse, PortfolioHistorySegment, RiskSettings } from "./accounts.mjs";
|
|
3
|
+
import { Account, AccountBalances, AccountBalancesSod, AccountGetAccountBalancesParams, AccountGetAccountBalancesResponse, AccountGetAccountByIDResponse, AccountGetAccountsParams, AccountGetAccountsResponse, AccountGetPortfolioHistoryParams, AccountGetPortfolioHistoryResponse, AccountList, AccountPatchAccountByIDParams, AccountPatchAccountByIDResponse, AccountSettings, AccountStatus, AccountSubtype, AccountType, Accounts, MarginDetails, MarginDetailsUsage, MarginSessionDetails, MarginTopContributor, MarginType, PortfolioHistoryResponse, PortfolioHistorySegment, RiskSettings } from "./accounts.mjs";
|
|
4
4
|
import * as APIVersionAPI from "./api-version.mjs";
|
|
5
5
|
import { APIVersion, APIVersionGetVersionResponse, Version } from "./api-version.mjs";
|
|
6
6
|
import * as CalendarAPI from "./calendar.mjs";
|
|
@@ -13,8 +13,6 @@ import * as PositionsAPI from "./positions.mjs";
|
|
|
13
13
|
import { Position, PositionCancelPositionInstructionParams, PositionCancelPositionInstructionResponse, PositionClosePositionParams, PositionClosePositionResponse, PositionClosePositionsParams, PositionClosePositionsResponse, PositionGetPositionInstructionsParams, PositionGetPositionInstructionsResponse, PositionGetPositionsParams, PositionGetPositionsResponse, PositionInstruction, PositionInstructionList, PositionInstructionStatus, PositionInstructionType, PositionList, PositionSubmitPositionInstructionsParams, PositionSubmitPositionInstructionsResponse, PositionType, Positions } from "./positions.mjs";
|
|
14
14
|
import * as WatchlistAPI from "./watchlist.mjs";
|
|
15
15
|
import { AddWatchlistItemData, Watchlist, WatchlistAddWatchlistItemParams, WatchlistAddWatchlistItemResponse, WatchlistCreateWatchlistParams, WatchlistCreateWatchlistResponse, WatchlistDeleteWatchlistItemParams, WatchlistDeleteWatchlistItemResponse, WatchlistDeleteWatchlistResponse, WatchlistDetail, WatchlistEntry, WatchlistEntryList, WatchlistGetWatchlistByIDResponse, WatchlistGetWatchlistsParams, WatchlistGetWatchlistsResponse, WatchlistItemEntry } from "./watchlist.mjs";
|
|
16
|
-
import * as WebsocketAPI from "./websocket.mjs";
|
|
17
|
-
import { Websocket } from "./websocket.mjs";
|
|
18
16
|
import * as InstrumentDataAPI from "./instrument-data/instrument-data.mjs";
|
|
19
17
|
import { AllEventsEventType, AnalystDistribution, AnalystRating, FiscalPeriodType, InstrumentAllEventsData, InstrumentAnalystConsensus, InstrumentBalanceSheetStatement, InstrumentBalanceSheetStatementList, InstrumentCashFlowStatement, InstrumentCashFlowStatementList, InstrumentData, InstrumentDataGetAllInstrumentEventsParams, InstrumentDataGetAllInstrumentEventsResponse, InstrumentDataGetInstrumentAnalystConsensusParams, InstrumentDataGetInstrumentAnalystConsensusResponse, InstrumentDataGetInstrumentBalanceSheetStatementsParams, InstrumentDataGetInstrumentBalanceSheetStatementsResponse, InstrumentDataGetInstrumentCashFlowStatementsParams, InstrumentDataGetInstrumentCashFlowStatementsResponse, InstrumentDataGetInstrumentEventsParams, InstrumentDataGetInstrumentEventsResponse, InstrumentDataGetInstrumentFundamentalsResponse, InstrumentDataGetInstrumentIncomeStatementsParams, InstrumentDataGetInstrumentIncomeStatementsResponse, InstrumentDividendEvent, InstrumentEarnings, InstrumentEventEnvelope, InstrumentEventIpoItem, InstrumentEventsByDate, InstrumentEventsData, InstrumentFundamentals, InstrumentIncomeStatement, InstrumentIncomeStatementList, InstrumentSplitEvent, PriceTarget } from "./instrument-data/instrument-data.mjs";
|
|
20
18
|
import * as OmniAIAPI from "./omni-ai/omni-ai.mjs";
|
|
@@ -29,7 +27,6 @@ export declare class V1 extends APIResource {
|
|
|
29
27
|
orders: OrdersAPI.Orders;
|
|
30
28
|
positions: PositionsAPI.Positions;
|
|
31
29
|
watchlist: WatchlistAPI.Watchlist;
|
|
32
|
-
websocket: WebsocketAPI.Websocket;
|
|
33
30
|
}
|
|
34
31
|
/**
|
|
35
32
|
* Security type
|
|
@@ -37,7 +34,7 @@ export declare class V1 extends APIResource {
|
|
|
37
34
|
export type SecurityType = 'COMMON_STOCK' | 'OPTION' | 'CASH';
|
|
38
35
|
export declare namespace V1 {
|
|
39
36
|
export { type SecurityType as SecurityType };
|
|
40
|
-
export { Accounts as Accounts, type Account as Account, type AccountBalances as AccountBalances, type AccountBalancesSod as AccountBalancesSod, type AccountList as AccountList, type AccountSettings as AccountSettings, type AccountStatus as AccountStatus, type AccountSubtype as AccountSubtype, type AccountType as AccountType, type MarginDetails as MarginDetails, type MarginDetailsUsage as MarginDetailsUsage, type MarginTopContributor as MarginTopContributor, type MarginType as MarginType, type PortfolioHistoryResponse as PortfolioHistoryResponse, type PortfolioHistorySegment as PortfolioHistorySegment, type RiskSettings as RiskSettings, type AccountGetAccountBalancesResponse as AccountGetAccountBalancesResponse, type AccountGetAccountByIDResponse as AccountGetAccountByIDResponse, type AccountGetAccountsResponse as AccountGetAccountsResponse, type AccountGetPortfolioHistoryResponse as AccountGetPortfolioHistoryResponse, type AccountPatchAccountByIDResponse as AccountPatchAccountByIDResponse, type AccountGetAccountBalancesParams as AccountGetAccountBalancesParams, type AccountGetAccountsParams as AccountGetAccountsParams, type AccountGetPortfolioHistoryParams as AccountGetPortfolioHistoryParams, type AccountPatchAccountByIDParams as AccountPatchAccountByIDParams, };
|
|
37
|
+
export { Accounts as Accounts, type Account as Account, type AccountBalances as AccountBalances, type AccountBalancesSod as AccountBalancesSod, type AccountList as AccountList, type AccountSettings as AccountSettings, type AccountStatus as AccountStatus, type AccountSubtype as AccountSubtype, type AccountType as AccountType, type MarginDetails as MarginDetails, type MarginDetailsUsage as MarginDetailsUsage, type MarginSessionDetails as MarginSessionDetails, type MarginTopContributor as MarginTopContributor, type MarginType as MarginType, type PortfolioHistoryResponse as PortfolioHistoryResponse, type PortfolioHistorySegment as PortfolioHistorySegment, type RiskSettings as RiskSettings, type AccountGetAccountBalancesResponse as AccountGetAccountBalancesResponse, type AccountGetAccountByIDResponse as AccountGetAccountByIDResponse, type AccountGetAccountsResponse as AccountGetAccountsResponse, type AccountGetPortfolioHistoryResponse as AccountGetPortfolioHistoryResponse, type AccountPatchAccountByIDResponse as AccountPatchAccountByIDResponse, type AccountGetAccountBalancesParams as AccountGetAccountBalancesParams, type AccountGetAccountsParams as AccountGetAccountsParams, type AccountGetPortfolioHistoryParams as AccountGetPortfolioHistoryParams, type AccountPatchAccountByIDParams as AccountPatchAccountByIDParams, };
|
|
41
38
|
export { APIVersion as APIVersion, type Version as Version, type APIVersionGetVersionResponse as APIVersionGetVersionResponse, };
|
|
42
39
|
export { Calendar as Calendar, type ClockDetail as ClockDetail, type DayType as DayType, type MarketHoursDetail as MarketHoursDetail, type MarketHoursDetailList as MarketHoursDetailList, type MarketSessionType as MarketSessionType, type MarketStatus as MarketStatus, type MarketType as MarketType, type SessionSchedule as SessionSchedule, type TradingSessions as TradingSessions, type CalendarGetClockResponse as CalendarGetClockResponse, type CalendarGetMarketHoursCalendarResponse as CalendarGetMarketHoursCalendarResponse, type CalendarGetMarketHoursCalendarParams as CalendarGetMarketHoursCalendarParams, };
|
|
43
40
|
export { InstrumentData as InstrumentData, type AllEventsEventType as AllEventsEventType, type AnalystDistribution as AnalystDistribution, type AnalystRating as AnalystRating, type FiscalPeriodType as FiscalPeriodType, type InstrumentAllEventsData as InstrumentAllEventsData, type InstrumentAnalystConsensus as InstrumentAnalystConsensus, type InstrumentBalanceSheetStatement as InstrumentBalanceSheetStatement, type InstrumentBalanceSheetStatementList as InstrumentBalanceSheetStatementList, type InstrumentCashFlowStatement as InstrumentCashFlowStatement, type InstrumentCashFlowStatementList as InstrumentCashFlowStatementList, type InstrumentDividendEvent as InstrumentDividendEvent, type InstrumentEarnings as InstrumentEarnings, type InstrumentEventEnvelope as InstrumentEventEnvelope, type InstrumentEventIpoItem as InstrumentEventIpoItem, type InstrumentEventsByDate as InstrumentEventsByDate, type InstrumentEventsData as InstrumentEventsData, type InstrumentFundamentals as InstrumentFundamentals, type InstrumentIncomeStatement as InstrumentIncomeStatement, type InstrumentIncomeStatementList as InstrumentIncomeStatementList, type InstrumentSplitEvent as InstrumentSplitEvent, type PriceTarget as PriceTarget, type InstrumentDataGetAllInstrumentEventsResponse as InstrumentDataGetAllInstrumentEventsResponse, type InstrumentDataGetInstrumentAnalystConsensusResponse as InstrumentDataGetInstrumentAnalystConsensusResponse, type InstrumentDataGetInstrumentBalanceSheetStatementsResponse as InstrumentDataGetInstrumentBalanceSheetStatementsResponse, type InstrumentDataGetInstrumentCashFlowStatementsResponse as InstrumentDataGetInstrumentCashFlowStatementsResponse, type InstrumentDataGetInstrumentEventsResponse as InstrumentDataGetInstrumentEventsResponse, type InstrumentDataGetInstrumentFundamentalsResponse as InstrumentDataGetInstrumentFundamentalsResponse, type InstrumentDataGetInstrumentIncomeStatementsResponse as InstrumentDataGetInstrumentIncomeStatementsResponse, type InstrumentDataGetAllInstrumentEventsParams as InstrumentDataGetAllInstrumentEventsParams, type InstrumentDataGetInstrumentAnalystConsensusParams as InstrumentDataGetInstrumentAnalystConsensusParams, type InstrumentDataGetInstrumentBalanceSheetStatementsParams as InstrumentDataGetInstrumentBalanceSheetStatementsParams, type InstrumentDataGetInstrumentCashFlowStatementsParams as InstrumentDataGetInstrumentCashFlowStatementsParams, type InstrumentDataGetInstrumentEventsParams as InstrumentDataGetInstrumentEventsParams, type InstrumentDataGetInstrumentIncomeStatementsParams as InstrumentDataGetInstrumentIncomeStatementsParams, };
|
|
@@ -46,6 +43,5 @@ export declare namespace V1 {
|
|
|
46
43
|
export { Orders as Orders, type CancelOrderRequest as CancelOrderRequest, type Execution as Execution, type ExecutionList as ExecutionList, type InstrumentIDOrSymbol as InstrumentIDOrSymbol, type NewOrderRequest as NewOrderRequest, type Order as Order, type OrderList as OrderList, type OrderStatus as OrderStatus, type OrderType as OrderType, type PositionEffect as PositionEffect, type QueueState as QueueState, type RequestOrderType as RequestOrderType, type RequestTimeInForce as RequestTimeInForce, type Side as Side, type TimeInForce as TimeInForce, type TrailingOffsetType as TrailingOffsetType, type OrderCancelAllOpenOrdersResponse as OrderCancelAllOpenOrdersResponse, type OrderCancelOpenOrderResponse as OrderCancelOpenOrderResponse, type OrderGetExecutionsResponse as OrderGetExecutionsResponse, type OrderGetOrderByIDResponse as OrderGetOrderByIDResponse, type OrderGetOrdersResponse as OrderGetOrdersResponse, type OrderReplaceOrderResponse as OrderReplaceOrderResponse, type OrderSubmitOrdersResponse as OrderSubmitOrdersResponse, type OrderCancelAllOpenOrdersParams as OrderCancelAllOpenOrdersParams, type OrderCancelOpenOrderParams as OrderCancelOpenOrderParams, type OrderGetExecutionsParams as OrderGetExecutionsParams, type OrderGetOrderByIDParams as OrderGetOrderByIDParams, type OrderGetOrdersParams as OrderGetOrdersParams, type OrderReplaceOrderParams as OrderReplaceOrderParams, type OrderSubmitOrdersParams as OrderSubmitOrdersParams, };
|
|
47
44
|
export { Positions as Positions, type Position as Position, type PositionInstruction as PositionInstruction, type PositionInstructionList as PositionInstructionList, type PositionInstructionStatus as PositionInstructionStatus, type PositionInstructionType as PositionInstructionType, type PositionList as PositionList, type PositionType as PositionType, type PositionCancelPositionInstructionResponse as PositionCancelPositionInstructionResponse, type PositionClosePositionResponse as PositionClosePositionResponse, type PositionClosePositionsResponse as PositionClosePositionsResponse, type PositionGetPositionInstructionsResponse as PositionGetPositionInstructionsResponse, type PositionGetPositionsResponse as PositionGetPositionsResponse, type PositionSubmitPositionInstructionsResponse as PositionSubmitPositionInstructionsResponse, type PositionCancelPositionInstructionParams as PositionCancelPositionInstructionParams, type PositionClosePositionParams as PositionClosePositionParams, type PositionClosePositionsParams as PositionClosePositionsParams, type PositionGetPositionInstructionsParams as PositionGetPositionInstructionsParams, type PositionGetPositionsParams as PositionGetPositionsParams, type PositionSubmitPositionInstructionsParams as PositionSubmitPositionInstructionsParams, };
|
|
48
45
|
export { Watchlist as Watchlist, type AddWatchlistItemData as AddWatchlistItemData, type WatchlistDetail as WatchlistDetail, type WatchlistEntry as WatchlistEntry, type WatchlistEntryList as WatchlistEntryList, type WatchlistItemEntry as WatchlistItemEntry, type WatchlistAddWatchlistItemResponse as WatchlistAddWatchlistItemResponse, type WatchlistCreateWatchlistResponse as WatchlistCreateWatchlistResponse, type WatchlistDeleteWatchlistResponse as WatchlistDeleteWatchlistResponse, type WatchlistDeleteWatchlistItemResponse as WatchlistDeleteWatchlistItemResponse, type WatchlistGetWatchlistByIDResponse as WatchlistGetWatchlistByIDResponse, type WatchlistGetWatchlistsResponse as WatchlistGetWatchlistsResponse, type WatchlistAddWatchlistItemParams as WatchlistAddWatchlistItemParams, type WatchlistCreateWatchlistParams as WatchlistCreateWatchlistParams, type WatchlistDeleteWatchlistItemParams as WatchlistDeleteWatchlistItemParams, type WatchlistGetWatchlistsParams as WatchlistGetWatchlistsParams, };
|
|
49
|
-
export { Websocket as Websocket };
|
|
50
46
|
}
|
|
51
47
|
//# sourceMappingURL=v1.d.mts.map
|