kalshi-typescript 2.1.0

package/dist/esm/api/portfolio-api.d.ts

@@ -0,0 +1,742 @@
+/**
+ * Kalshi Trading API
+ * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@kalshi.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { AmendOrderRequest } from '../models';
+import type { AmendOrderResponse } from '../models';
+import type { BatchCancelOrdersRequest } from '../models';
+import type { BatchCancelOrdersResponse } from '../models';
+import type { BatchCreateOrdersRequest } from '../models';
+import type { BatchCreateOrdersResponse } from '../models';
+import type { CancelOrderResponse } from '../models';
+import type { CreateOrderGroupRequest } from '../models';
+import type { CreateOrderGroupResponse } from '../models';
+import type { CreateOrderRequest } from '../models';
+import type { CreateOrderResponse } from '../models';
+import type { DecreaseOrderRequest } from '../models';
+import type { DecreaseOrderResponse } from '../models';
+import type { GetBalanceResponse } from '../models';
+import type { GetFillsResponse } from '../models';
+import type { GetOrderGroupsResponse } from '../models';
+import type { GetOrderQueuePositionResponse } from '../models';
+import type { GetOrderResponse } from '../models';
+import type { GetOrdersResponse } from '../models';
+import type { GetPositionsResponse } from '../models';
+import type { GetQueuePositionsRequest } from '../models';
+import type { GetQueuePositionsResponse } from '../models';
+import type { GetSettlementsResponse } from '../models';
+import type { GetTotalRestingOrderValueResponse } from '../models';
+/**
+ * PortfolioApi - axios parameter creator
+ */
+export declare const PortfolioApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Amend an existing order
+     * @summary Amend Order
+     * @param {string} orderId Order ID
+     * @param {AmendOrderRequest} amendOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    amendOrder: (orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Cancel multiple orders in a single request
+     * @summary Batch Cancel Orders
+     * @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchCancelOrders: (batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create multiple orders in a single request
+     * @summary Batch Create Orders
+     * @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchCreateOrders: (batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Cancel an order
+     * @summary Cancel Order
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new order
+     * @summary Create Order
+     * @param {CreateOrderRequest} createOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrder: (createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new order group
+     * @summary Create Order Group
+     * @param {CreateOrderGroupRequest} createOrderGroupRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrderGroup: (createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Decrease the size of an existing order
+     * @summary Decrease Order
+     * @param {string} orderId Order ID
+     * @param {DecreaseOrderRequest} decreaseOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    decreaseOrder: (orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete an order group
+     * @summary Delete Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteOrderGroup: (orderGroupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the user\'s current balance
+     * @summary Get Balance
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get fills for the logged-in user.  A fill represents a partial or complete execution of an order. When an order matches with another order in the orderbook, a fill is created for each side of the trade.
+     * @summary Get Fills
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [orderId] Filter by order ID
+     * @param {number} [minTs] Filter items after this Unix timestamp
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFills: (ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a single order by ID
+     * @summary Get Order
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get order groups for the logged-in user
+     * @summary Get Order Groups
+     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderGroups: (status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the queue position for an order
+     * @summary Get Order Queue Position
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderQueuePosition: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get orders for the logged-in user
+     * @summary Get Orders
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [eventTicker] Filter by event ticker
+     * @param {number} [minTs] Filter items after this Unix timestamp
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrders: (ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get positions for the logged-in user
+     * @summary Get Positions
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [eventTicker] Filter by event ticker
+     * @param {number} [countDown] Filter positions by minimum count down value
+     * @param {number} [countUp] Filter positions by minimum count up value
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPositions: (ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get queue positions for multiple orders
+     * @summary Get Queue Positions
+     * @param {GetQueuePositionsRequest} getQueuePositionsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuePositions: (getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get settlements for the logged-in user
+     * @summary Get Settlements
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSettlements: (limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the total value of all resting orders
+     * @summary Get Total Resting Order Value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTotalRestingOrderValue: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Reset an order group
+     * @summary Reset Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetOrderGroup: (orderGroupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PortfolioApi - functional programming interface
+ */
+export declare const PortfolioApiFp: (configuration?: Configuration) => {
+    /**
+     * Amend an existing order
+     * @summary Amend Order
+     * @param {string} orderId Order ID
+     * @param {AmendOrderRequest} amendOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AmendOrderResponse>>;
+    /**
+     * Cancel multiple orders in a single request
+     * @summary Batch Cancel Orders
+     * @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchCancelOrdersResponse>>;
+    /**
+     * Create multiple orders in a single request
+     * @summary Batch Create Orders
+     * @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchCreateOrdersResponse>>;
+    /**
+     * Cancel an order
+     * @summary Cancel Order
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>>;
+    /**
+     * Create a new order
+     * @summary Create Order
+     * @param {CreateOrderRequest} createOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderResponse>>;
+    /**
+     * Create a new order group
+     * @summary Create Order Group
+     * @param {CreateOrderGroupRequest} createOrderGroupRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderGroupResponse>>;
+    /**
+     * Decrease the size of an existing order
+     * @summary Decrease Order
+     * @param {string} orderId Order ID
+     * @param {DecreaseOrderRequest} decreaseOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DecreaseOrderResponse>>;
+    /**
+     * Delete an order group
+     * @summary Delete Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get the user\'s current balance
+     * @summary Get Balance
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceResponse>>;
+    /**
+     * Get fills for the logged-in user.  A fill represents a partial or complete execution of an order. When an order matches with another order in the orderbook, a fill is created for each side of the trade.
+     * @summary Get Fills
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [orderId] Filter by order ID
+     * @param {number} [minTs] Filter items after this Unix timestamp
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>>;
+    /**
+     * Get a single order by ID
+     * @summary Get Order
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
+    /**
+     * Get order groups for the logged-in user
+     * @summary Get Order Groups
+     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupsResponse>>;
+    /**
+     * Get the queue position for an order
+     * @summary Get Order Queue Position
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderQueuePositionResponse>>;
+    /**
+     * Get orders for the logged-in user
+     * @summary Get Orders
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [eventTicker] Filter by event ticker
+     * @param {number} [minTs] Filter items after this Unix timestamp
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
+    /**
+     * Get positions for the logged-in user
+     * @summary Get Positions
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [eventTicker] Filter by event ticker
+     * @param {number} [countDown] Filter positions by minimum count down value
+     * @param {number} [countUp] Filter positions by minimum count up value
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPositionsResponse>>;
+    /**
+     * Get queue positions for multiple orders
+     * @summary Get Queue Positions
+     * @param {GetQueuePositionsRequest} getQueuePositionsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQueuePositionsResponse>>;
+    /**
+     * Get settlements for the logged-in user
+     * @summary Get Settlements
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementsResponse>>;
+    /**
+     * Get the total value of all resting orders
+     * @summary Get Total Resting Order Value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTotalRestingOrderValueResponse>>;
+    /**
+     * Reset an order group
+     * @summary Reset Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * PortfolioApi - factory interface
+ */
+export declare const PortfolioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Amend an existing order
+     * @summary Amend Order
+     * @param {string} orderId Order ID
+     * @param {AmendOrderRequest} amendOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<AmendOrderResponse>;
+    /**
+     * Cancel multiple orders in a single request
+     * @summary Batch Cancel Orders
+     * @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchCancelOrdersResponse>;
+    /**
+     * Create multiple orders in a single request
+     * @summary Batch Create Orders
+     * @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchCreateOrdersResponse>;
+    /**
+     * Cancel an order
+     * @summary Cancel Order
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrder(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<CancelOrderResponse>;
+    /**
+     * Create a new order
+     * @summary Create Order
+     * @param {CreateOrderRequest} createOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderResponse>;
+    /**
+     * Create a new order group
+     * @summary Create Order Group
+     * @param {CreateOrderGroupRequest} createOrderGroupRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderGroupResponse>;
+    /**
+     * Decrease the size of an existing order
+     * @summary Decrease Order
+     * @param {string} orderId Order ID
+     * @param {DecreaseOrderRequest} decreaseOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DecreaseOrderResponse>;
+    /**
+     * Delete an order group
+     * @summary Delete Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get the user\'s current balance
+     * @summary Get Balance
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance(options?: RawAxiosRequestConfig): AxiosPromise<GetBalanceResponse>;
+    /**
+     * Get fills for the logged-in user.  A fill represents a partial or complete execution of an order. When an order matches with another order in the orderbook, a fill is created for each side of the trade.
+     * @summary Get Fills
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [orderId] Filter by order ID
+     * @param {number} [minTs] Filter items after this Unix timestamp
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFillsResponse>;
+    /**
+     * Get a single order by ID
+     * @summary Get Order
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrder(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse>;
+    /**
+     * Get order groups for the logged-in user
+     * @summary Get Order Groups
+     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupsResponse>;
+    /**
+     * Get the queue position for an order
+     * @summary Get Order Queue Position
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderQueuePositionResponse>;
+    /**
+     * Get orders for the logged-in user
+     * @summary Get Orders
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [eventTicker] Filter by event ticker
+     * @param {number} [minTs] Filter items after this Unix timestamp
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
+    /**
+     * Get positions for the logged-in user
+     * @summary Get Positions
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [eventTicker] Filter by event ticker
+     * @param {number} [countDown] Filter positions by minimum count down value
+     * @param {number} [countUp] Filter positions by minimum count up value
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse>;
+    /**
+     * Get queue positions for multiple orders
+     * @summary Get Queue Positions
+     * @param {GetQueuePositionsRequest} getQueuePositionsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetQueuePositionsResponse>;
+    /**
+     * Get settlements for the logged-in user
+     * @summary Get Settlements
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSettlementsResponse>;
+    /**
+     * Get the total value of all resting orders
+     * @summary Get Total Resting Order Value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTotalRestingOrderValue(options?: RawAxiosRequestConfig): AxiosPromise<GetTotalRestingOrderValueResponse>;
+    /**
+     * Reset an order group
+     * @summary Reset Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * PortfolioApi - object-oriented interface
+ */
+export declare class PortfolioApi extends BaseAPI {
+    /**
+     * Amend an existing order
+     * @summary Amend Order
+     * @param {string} orderId Order ID
+     * @param {AmendOrderRequest} amendOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AmendOrderResponse, any>>;
+    /**
+     * Cancel multiple orders in a single request
+     * @summary Batch Cancel Orders
+     * @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCancelOrdersResponse, any>>;
+    /**
+     * Create multiple orders in a single request
+     * @summary Batch Create Orders
+     * @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCreateOrdersResponse, any>>;
+    /**
+     * Cancel an order
+     * @summary Cancel Order
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any>>;
+    /**
+     * Create a new order
+     * @summary Create Order
+     * @param {CreateOrderRequest} createOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderResponse, any>>;
+    /**
+     * Create a new order group
+     * @summary Create Order Group
+     * @param {CreateOrderGroupRequest} createOrderGroupRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderGroupResponse, any>>;
+    /**
+     * Decrease the size of an existing order
+     * @summary Decrease Order
+     * @param {string} orderId Order ID
+     * @param {DecreaseOrderRequest} decreaseOrderRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DecreaseOrderResponse, any>>;
+    /**
+     * Delete an order group
+     * @summary Delete Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Get the user\'s current balance
+     * @summary Get Balance
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any>>;
+    /**
+     * Get fills for the logged-in user.  A fill represents a partial or complete execution of an order. When an order matches with another order in the orderbook, a fill is created for each side of the trade.
+     * @summary Get Fills
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [orderId] Filter by order ID
+     * @param {number} [minTs] Filter items after this Unix timestamp
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any>>;
+    /**
+     * Get a single order by ID
+     * @summary Get Order
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderResponse, any>>;
+    /**
+     * Get order groups for the logged-in user
+     * @summary Get Order Groups
+     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderGroupsResponse, any>>;
+    /**
+     * Get the queue position for an order
+     * @summary Get Order Queue Position
+     * @param {string} orderId Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderQueuePositionResponse, any>>;
+    /**
+     * Get orders for the logged-in user
+     * @summary Get Orders
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [eventTicker] Filter by event ticker
+     * @param {number} [minTs] Filter items after this Unix timestamp
+     * @param {number} [maxTs] Filter items before this Unix timestamp
+     * @param {string} [status] Filter by status. Possible values depend on the endpoint.
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
+    /**
+     * Get positions for the logged-in user
+     * @summary Get Positions
+     * @param {string} [ticker] Filter by market ticker
+     * @param {string} [eventTicker] Filter by event ticker
+     * @param {number} [countDown] Filter positions by minimum count down value
+     * @param {number} [countUp] Filter positions by minimum count up value
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any>>;
+    /**
+     * Get queue positions for multiple orders
+     * @summary Get Queue Positions
+     * @param {GetQueuePositionsRequest} getQueuePositionsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQueuePositionsResponse, any>>;
+    /**
+     * Get settlements for the logged-in user
+     * @summary Get Settlements
+     * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
+     * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any>>;
+    /**
+     * Get the total value of all resting orders
+     * @summary Get Total Resting Order Value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTotalRestingOrderValueResponse, any>>;
+    /**
+     * Reset an order group
+     * @summary Reset Order Group
+     * @param {string} orderGroupId Order group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}