@clear-street/clearstreet 0.0.0 → 0.73.0

package/resources/v1/orders.js

@@ -0,0 +1,134 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Orders = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Place, monitor, and manage trading orders.
+ */
+class Orders extends resource_1.APIResource {
+    /**
+     * Cancel all orders for an account
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.cancelAllOpenOrders(
+     *   0,
+     * );
+     * ```
+     */
+    cancelAllOpenOrders(accountID, params = {}, options) {
+        const { instrument_ids, instrument_type, side, type } = params ?? {};
+        return this._client.delete((0, path_1.path) `/v1/accounts/${accountID}/orders`, {
+            query: { instrument_ids, instrument_type, side, type },
+            ...options,
+        });
+    }
+    /**
+     * Cancel a specific order
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.cancelOpenOrder(
+     *   'order_id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    cancelOpenOrder(orderID, params, options) {
+        const { account_id } = params;
+        return this._client.delete((0, path_1.path) `/v1/accounts/${account_id}/orders/${orderID}`, options);
+    }
+    /**
+     * Retrieves filled and partially-filled execution reports for the specified
+     * trading account, ordered by transaction time (nanosecond precision) descending.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.getExecutions(0);
+     * ```
+     */
+    getExecutions(accountID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/accounts/${accountID}/executions`, { query, ...options });
+    }
+    /**
+     * Get Order By ID
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.getOrderByID(
+     *   'order_id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    getOrderByID(orderID, params, options) {
+        const { account_id } = params;
+        return this._client.get((0, path_1.path) `/v1/accounts/${account_id}/orders/${orderID}`, options);
+    }
+    /**
+     * List orders for an account with optional filtering
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.getOrders(0);
+     * ```
+     */
+    getOrders(accountID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/accounts/${accountID}/orders`, { query, ...options });
+    }
+    /**
+     * Replace an order with new parameters
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.replaceOrder(
+     *   'order_id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    replaceOrder(orderID, params, options) {
+        const { account_id, ...body } = params;
+        return this._client.patch((0, path_1.path) `/v1/accounts/${account_id}/orders/${orderID}`, { body, ...options });
+    }
+    /**
+     * Submit new orders
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.submitOrders(0, {
+     *   orders: [
+     *     {
+     *       legs: [
+     *         {
+     *           ratio: 'ratio',
+     *           security: '0193bb84-447a-706f-996f-097254663f02',
+     *           side: 'BUY',
+     *         },
+     *         {
+     *           ratio: 'ratio',
+     *           security: '0193bb84-4db4-78ec-b4fd-cba8be61cf8a',
+     *           side: 'SELL',
+     *         },
+     *         {
+     *           ratio: 'ratio',
+     *           security: '0193bb84-5264-7f20-8fd3-35df82cd6ef0',
+     *           side: 'BUY',
+     *         },
+     *       ],
+     *       order_type: 'LIMIT',
+     *       time_in_force: 'DAY',
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    submitOrders(accountID, params, options) {
+        const { orders } = params;
+        return this._client.post((0, path_1.path) `/v1/accounts/${accountID}/orders`, { body: orders, ...options });
+    }
+}
+exports.Orders = Orders;
+//# sourceMappingURL=orders.js.map

package/resources/v1/orders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orders.js","sourceRoot":"","sources":["../../src/resources/v1/orders.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;OASG;IACH,mBAAmB,CACjB,SAAiB,EACjB,SAA4D,EAAE,EAC9D,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,SAAS,EAAE;YACjE,KAAK,EAAE,EAAE,cAAc,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE;YACtD,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CACb,OAAe,EACf,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CACX,SAAiB,EACjB,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,OAAe,EACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,SAAiB,EACjB,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,OAAe,EACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,YAAY,CACV,SAAiB,EACjB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF;AA5JD,wBA4JC"}

package/resources/v1/orders.mjs

@@ -0,0 +1,130 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Place, monitor, and manage trading orders.
+ */
+export class Orders extends APIResource {
+    /**
+     * Cancel all orders for an account
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.cancelAllOpenOrders(
+     *   0,
+     * );
+     * ```
+     */
+    cancelAllOpenOrders(accountID, params = {}, options) {
+        const { instrument_ids, instrument_type, side, type } = params ?? {};
+        return this._client.delete(path `/v1/accounts/${accountID}/orders`, {
+            query: { instrument_ids, instrument_type, side, type },
+            ...options,
+        });
+    }
+    /**
+     * Cancel a specific order
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.cancelOpenOrder(
+     *   'order_id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    cancelOpenOrder(orderID, params, options) {
+        const { account_id } = params;
+        return this._client.delete(path `/v1/accounts/${account_id}/orders/${orderID}`, options);
+    }
+    /**
+     * Retrieves filled and partially-filled execution reports for the specified
+     * trading account, ordered by transaction time (nanosecond precision) descending.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.getExecutions(0);
+     * ```
+     */
+    getExecutions(accountID, query = {}, options) {
+        return this._client.get(path `/v1/accounts/${accountID}/executions`, { query, ...options });
+    }
+    /**
+     * Get Order By ID
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.getOrderByID(
+     *   'order_id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    getOrderByID(orderID, params, options) {
+        const { account_id } = params;
+        return this._client.get(path `/v1/accounts/${account_id}/orders/${orderID}`, options);
+    }
+    /**
+     * List orders for an account with optional filtering
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.getOrders(0);
+     * ```
+     */
+    getOrders(accountID, query = {}, options) {
+        return this._client.get(path `/v1/accounts/${accountID}/orders`, { query, ...options });
+    }
+    /**
+     * Replace an order with new parameters
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.replaceOrder(
+     *   'order_id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    replaceOrder(orderID, params, options) {
+        const { account_id, ...body } = params;
+        return this._client.patch(path `/v1/accounts/${account_id}/orders/${orderID}`, { body, ...options });
+    }
+    /**
+     * Submit new orders
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.orders.submitOrders(0, {
+     *   orders: [
+     *     {
+     *       legs: [
+     *         {
+     *           ratio: 'ratio',
+     *           security: '0193bb84-447a-706f-996f-097254663f02',
+     *           side: 'BUY',
+     *         },
+     *         {
+     *           ratio: 'ratio',
+     *           security: '0193bb84-4db4-78ec-b4fd-cba8be61cf8a',
+     *           side: 'SELL',
+     *         },
+     *         {
+     *           ratio: 'ratio',
+     *           security: '0193bb84-5264-7f20-8fd3-35df82cd6ef0',
+     *           side: 'BUY',
+     *         },
+     *       ],
+     *       order_type: 'LIMIT',
+     *       time_in_force: 'DAY',
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    submitOrders(accountID, params, options) {
+        const { orders } = params;
+        return this._client.post(path `/v1/accounts/${accountID}/orders`, { body: orders, ...options });
+    }
+}
+//# sourceMappingURL=orders.mjs.map

package/resources/v1/orders.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"orders.mjs","sourceRoot":"","sources":["../../src/resources/v1/orders.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAMlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,mBAAmB,CACjB,SAAiB,EACjB,SAA4D,EAAE,EAC9D,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE;YACjE,KAAK,EAAE,EAAE,cAAc,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE;YACtD,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CACb,OAAe,EACf,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CACX,SAAiB,EACjB,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,OAAe,EACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,SAAiB,EACjB,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,OAAe,EACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,UAAU,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,YAAY,CACV,SAAiB,EACjB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF"}

package/resources/v1/positions.d.mts

@@ -0,0 +1,385 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as PositionsAPI from "./positions.mjs";
+import * as Shared from "../shared.mjs";
+import * as OrdersAPI from "./orders.mjs";
+import * as V1API from "./v1.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * View positions and manage position instructions.
+ */
+export declare class Positions extends APIResource {
+    /**
+     * Cancel an outstanding position instruction by its server-assigned `id`. Returns
+     * the updated instruction with status `CANCEL_REQUESTED`. The terminal `CANCELLED`
+     * or `CANCEL_FAILED` state arrives asynchronously and is observable via subsequent
+     * GETs.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.positions.cancelPositionInstruction(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { account_id: 0 },
+     *   );
+     * ```
+     */
+    cancelPositionInstruction(instructionID: string, params: PositionCancelPositionInstructionParams, options?: RequestOptions): APIPromise<PositionCancelPositionInstructionResponse>;
+    /**
+     * Delete a position within an account for an instrument.
+     *
+     * Retrieves orders generated to close the position.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.positions.closePosition(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    closePosition(instrumentID: OrdersAPI.InstrumentIDOrSymbol, params: PositionClosePositionParams, options?: RequestOptions): APIPromise<PositionClosePositionResponse>;
+    /**
+     * Delete all positions within an account.
+     *
+     * Closes all positions for the specified trading account.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.positions.closePositions(
+     *   0,
+     * );
+     * ```
+     */
+    closePositions(accountID: number, body?: PositionClosePositionsParams | null | undefined, options?: RequestOptions): APIPromise<PositionClosePositionsResponse>;
+    /**
+     * Returns the current lifecycle state of the account's position instructions.
+     * Optionally filter by a specific contract.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.positions.getPositionInstructions(0);
+     * ```
+     */
+    getPositionInstructions(accountID: number, query?: PositionGetPositionInstructionsParams | null | undefined, options?: RequestOptions): APIPromise<PositionGetPositionInstructionsResponse>;
+    /**
+     * Retrieves all positions for the specified trading account.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.positions.getPositions(0);
+     * ```
+     */
+    getPositions(accountID: number, query?: PositionGetPositionsParams | null | undefined, options?: RequestOptions): APIPromise<PositionGetPositionsResponse>;
+    /**
+     * Submit one or more position instructions (Exercise, Do-Not-Exercise, Contrary
+     * Exercise Advice) against the account.
+     *
+     * Batch semantics:
+     *
+     * - **All rows accepted** → `200 OK`. Every row is in `data` with `status = SENT`.
+     * - **Partial success** → `207 Multi-Status`. `data` contains every row; rejected
+     *   rows carry `status = ENGINE_REJECTED` (or `REJECTED`) and `rejection_reason`.
+     *   The top-level `error` summarizes the batch failure.
+     * - **All rows rejected** → `4xx`/`5xx`. The HTTP status reflects the aggregate
+     *   cause: `409` when every row was a duplicate, `400` for validation failures
+     *   like DNE/CEA on a non-expiry day, `503` if the clearing service is
+     *   unavailable. `data` still contains every row carrying
+     *   `status = ENGINE_REJECTED` and `rejection_reason` so callers can attribute
+     *   failures by `instruction_id`; the top-level `error` summarizes the batch.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.positions.submitPositionInstructions(0, {
+     *     instructions: [
+     *       {
+     *         instruction_type: 'EXERCISE',
+     *         instrument_id:
+     *           '0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e02',
+     *         quantity: '1',
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    submitPositionInstructions(accountID: number, params: PositionSubmitPositionInstructionsParams, options?: RequestOptions): APIPromise<PositionSubmitPositionInstructionsResponse>;
+}
+/**
+ * Represents a holding of a particular instrument in an account
+ */
+export interface Position {
+    /**
+     * The account this position belongs to
+     */
+    account_id: number;
+    /**
+     * The quantity of a position that is free to be operated on.
+     */
+    available_quantity: string;
+    /**
+     * OEMS instrument UUID
+     */
+    instrument_id: string;
+    /**
+     * Type of security
+     */
+    instrument_type: V1API.SecurityType;
+    /**
+     * The current market value of the position
+     */
+    market_value: string;
+    /**
+     * The type of position
+     */
+    position_type: PositionType;
+    /**
+     * The number of shares or contracts. Can be positive (long) or negative (short)
+     */
+    quantity: string;
+    /**
+     * The trading symbol for the instrument
+     */
+    symbol: string;
+    /**
+     * The average price paid per share or contract for this position
+     */
+    avg_price?: string | null;
+    /**
+     * The closing price used to value the position for the last trading day
+     */
+    closing_price?: string | null;
+    /**
+     * The market date associated with `closing_price`
+     */
+    closing_price_date?: string | null;
+    /**
+     * The total cost basis for this position
+     */
+    cost_basis?: string | null;
+    /**
+     * The unrealized profit or loss for this position relative to the previous close
+     */
+    daily_unrealized_pnl?: string | null;
+    /**
+     * The unrealized profit/loss for the position for the current day, expressed as a
+     * percentage of the baseline value (range: 0-100).
+     */
+    daily_unrealized_pnl_pct?: string | null;
+    /**
+     * The current market price of the instrument
+     */
+    instrument_price?: string | null;
+    /**
+     * OEMS instrument identifier of the underlying instrument, if resolvable
+     */
+    underlying_instrument_id?: string | null;
+    /**
+     * The total unrealized profit or loss for this position based on current market
+     * value
+     */
+    unrealized_pnl?: string | null;
+    /**
+     * The unrealized profit/loss for the position, expressed as a percentage of the
+     * position's cost basis (range: 0-100).
+     */
+    unrealized_pnl_pct?: string | null;
+}
+/**
+ * A position instruction and its current lifecycle state.
+ */
+export interface PositionInstruction {
+    /**
+     * Server-assigned id. Used as the path parameter on cancel.
+     */
+    id: string;
+    /**
+     * Account the instruction belongs to.
+     */
+    account_id: number;
+    /**
+     * Caller-supplied idempotency key echoed from the submit request; the
+     * server-assigned fallback when none was supplied.
+     */
+    instruction_id: string;
+    /**
+     * The action this instruction requests.
+     */
+    instruction_type: PositionInstructionType;
+    /**
+     * Identifier of the options contract this instruction acts on.
+     */
+    instrument_id: string;
+    /**
+     * Number of contracts included in the instruction.
+     */
+    quantity: string;
+    /**
+     * Current lifecycle status.
+     */
+    status: PositionInstructionStatus;
+    /**
+     * Options symbol (OSI) for display.
+     */
+    symbol: string;
+    /**
+     * Number of contracts accepted by the clearing venue. Populated once the
+     * instruction reaches `ACCEPTED`.
+     */
+    accepted_quantity?: string | null;
+    /**
+     * When the instruction was first accepted by the service.
+     */
+    created_at?: string | null;
+    /**
+     * Human-readable explanation populated on any non-success terminal status —
+     * `REJECTED`, `ENGINE_REJECTED`, or `CANCEL_FAILED`. On a `207 Multi-Status` batch
+     * submit the top-level `error` field summarizes the batch; per-row detail
+     * continues to live here.
+     */
+    rejection_reason?: string | null;
+    /**
+     * When the instruction's lifecycle state last changed.
+     */
+    updated_at?: string | null;
+}
+export type PositionInstructionList = Array<PositionInstruction>;
+/**
+ * Lifecycle status of a position instruction.
+ *
+ * - `SENT`: accepted and forwarded to the clearing venue.
+ * - `ACCEPTED`: terminal — accepted by the clearing venue.
+ * - `REJECTED`: terminal rejection from the clearing venue; `rejection_reason`
+ *   carries the venue-reported detail.
+ * - `ENGINE_REJECTED`: terminal rejection raised before the instruction reached
+ *   the clearing venue; `rejection_reason` carries the detail. Typical causes:
+ *   duplicate `instruction_id`, `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` submitted
+ *   on a non-expiry day, insufficient position, or an instrument that does not
+ *   resolve.
+ * - `CANCEL_REQUESTED`: cancel accepted; final cancel state pending.
+ * - `CANCELLED`: terminal — cancel completed.
+ * - `CANCEL_FAILED`: cancel could not be completed; operator attention required.
+ *   `rejection_reason` carries the detail.
+ * - `UNKNOWN`: status could not be mapped from the upstream service. Not expected
+ *   in practice; surfaces a service version skew.
+ */
+export type PositionInstructionStatus = 'SENT' | 'ACCEPTED' | 'REJECTED' | 'ENGINE_REJECTED' | 'CANCEL_REQUESTED' | 'CANCELLED' | 'CANCEL_FAILED' | 'UNKNOWN';
+/**
+ * The action to take against an options position.
+ */
+export type PositionInstructionType = 'EXERCISE' | 'DO_NOT_EXERCISE' | 'CONTRARY_EXERCISE';
+export type PositionList = Array<Position>;
+/**
+ * Position type classification
+ */
+export type PositionType = 'LONG' | 'SHORT' | 'LONG_CALL' | 'SHORT_CALL' | 'LONG_PUT' | 'SHORT_PUT';
+export interface PositionCancelPositionInstructionResponse extends Shared.BaseResponse {
+    /**
+     * A position instruction and its current lifecycle state.
+     */
+    data: PositionInstruction;
+}
+export interface PositionClosePositionResponse extends Shared.BaseResponse {
+    data: OrdersAPI.OrderList;
+}
+export interface PositionClosePositionsResponse extends Shared.BaseResponse {
+    data: OrdersAPI.OrderList;
+}
+export interface PositionGetPositionInstructionsResponse extends Shared.BaseResponse {
+    data: PositionInstructionList;
+}
+export interface PositionGetPositionsResponse extends Shared.BaseResponse {
+    data: PositionList;
+}
+export interface PositionSubmitPositionInstructionsResponse extends Shared.BaseResponse {
+    data: PositionInstructionList;
+}
+export interface PositionCancelPositionInstructionParams {
+    /**
+     * Account identifier
+     */
+    account_id: number;
+}
+export interface PositionClosePositionParams {
+    /**
+     * Path param: Account identifier
+     */
+    account_id: number;
+    /**
+     * Body param: Whether to cancel existing open orders for the position before
+     * submitting closing orders.
+     */
+    cancel_orders?: boolean | null;
+}
+export interface PositionClosePositionsParams {
+    /**
+     * Whether to cancel existing open orders for the position before submitting
+     * closing orders.
+     */
+    cancel_orders?: boolean | null;
+}
+export interface PositionGetPositionInstructionsParams {
+    /**
+     * Limit results to a single contract. Accepts the instrument id or the OSI symbol.
+     */
+    instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
+}
+export interface PositionGetPositionsParams {
+    /**
+     * Comma-separated OEMS instrument UUIDs
+     */
+    instrument_ids?: Array<string>;
+    /**
+     * The number of items to return per page. Only used when page_token is not
+     * provided.
+     */
+    page_size?: number;
+    /**
+     * Token for retrieving the next or previous page of results. Contains encoded
+     * pagination state; when provided, page_size is ignored.
+     */
+    page_token?: string;
+    /**
+     * Field to sort by
+     */
+    sort_by?: 'SYMBOL' | 'INSTRUMENT_TYPE' | 'QUANTITY' | 'MARKET_VALUE' | 'POSITION_TYPE' | 'UNREALIZED_PNL' | 'DAILY_UNREALIZED_PNL';
+    /**
+     * Sort direction
+     */
+    sort_direction?: 'ASC' | 'DESC';
+}
+export interface PositionSubmitPositionInstructionsParams {
+    instructions: Array<PositionSubmitPositionInstructionsParams.Instruction>;
+}
+export declare namespace PositionSubmitPositionInstructionsParams {
+    /**
+     * A position instruction to submit.
+     *
+     * Use `DELETE /accounts/{account_id}/positions/instructions/{instruction_id}` to
+     * cancel an outstanding instruction.
+     */
+    interface Instruction {
+        /**
+         * The action to take.
+         */
+        instruction_type: PositionsAPI.PositionInstructionType;
+        /**
+         * Identifier of the options contract to act on. Unknown ids return 404.
+         */
+        instrument_id: string;
+        /**
+         * Number of contracts to include in the instruction.
+         */
+        quantity: string;
+        /**
+         * Caller-supplied idempotency key. Echoed on the response. The server generates a
+         * unique id when omitted.
+         */
+        instruction_id?: string | null;
+    }
+}
+export declare namespace Positions {
+    export { 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, };
+}
+//# sourceMappingURL=positions.d.mts.map

package/resources/v1/positions.d.mts.map

@@ -0,0 +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;;;;;;;;;OASG;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;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,iBAAiB,GACjB,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"}