kalshi-typescript

/** * Kalshi Trade API Manual Endpoints * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach * * The version of the OpenAPI document: 3.11.0 * * * 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 { ApplySubaccountTransferRequest } from '../models'; import type { CreateSubaccountResponse } from '../models'; import type { GetBalanceResponse } from '../models'; import type { GetFillsResponse } from '../models'; import type { GetPortfolioRestingOrderTotalValueResponse } from '../models'; import type { GetPositionsResponse } from '../models'; import type { GetSettlementsResponse } from '../models'; import type { GetSubaccountBalancesResponse } from '../models'; import type { GetSubaccountNettingResponse } from '../models'; import type { GetSubaccountTransfersResponse } from '../models'; import type { UpdateSubaccountNettingRequest } from '../models'; /** * PortfolioApi - axios parameter creator */ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configuration) => { /** * Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts. * @summary Transfer Between Subaccounts * @param {ApplySubaccountTransferRequest} applySubaccountTransferRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ applySubaccountTransfer: (applySubaccountTransferRequest: ApplySubaccountTransferRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user. * @summary Create Subaccount * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubaccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents. * @summary Get Balance * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBalance: (subaccount?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details. * @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 {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFills: (ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, subaccount?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you. * @summary Get Total Resting Order Value * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPortfolioRestingOrderTotalValue: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded * @summary Get Positions * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page. * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100. * @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded * @param {string} [ticker] Filter by market ticker * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported. * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPositions: (cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, subaccount?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Endpoint for getting the member\'s settlements historical track. * @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 {string} [ticker] Filter by market ticker * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported. * @param {number} [minTs] Filter items after this Unix timestamp * @param {number} [maxTs] Filter items before this Unix timestamp * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSettlements: (limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, subaccount?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Gets balances for all subaccounts including the primary account. * @summary Get All Subaccount Balances * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubaccountBalances: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Gets the netting enabled settings for all subaccounts. * @summary Get Subaccount Netting * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubaccountNetting: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Gets a paginated list of all transfers between subaccounts for the authenticated user. * @summary Get Subaccount Transfers * @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} */ getSubaccountTransfers: (limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts. * @summary Update Subaccount Netting * @param {UpdateSubaccountNettingRequest} updateSubaccountNettingRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubaccountNetting: (updateSubaccountNettingRequest: UpdateSubaccountNettingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * PortfolioApi - functional programming interface */ export declare const PortfolioApiFp: (configuration?: Configuration) => { /** * Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts. * @summary Transfer Between Subaccounts * @param {ApplySubaccountTransferRequest} applySubaccountTransferRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ applySubaccountTransfer(applySubaccountTransferRequest: ApplySubaccountTransferRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>; /** * Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user. * @summary Create Subaccount * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubaccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSubaccountResponse>>; /** * Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents. * @summary Get Balance * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBalance(subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceResponse>>; /** * Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details. * @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 {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>>; /** * Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you. * @summary Get Total Resting Order Value * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPortfolioRestingOrderTotalValueResponse>>; /** * Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded * @summary Get Positions * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page. * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100. * @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded * @param {string} [ticker] Filter by market ticker * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported. * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPositionsResponse>>; /** * Endpoint for getting the member\'s settlements historical track. * @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 {string} [ticker] Filter by market ticker * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported. * @param {number} [minTs] Filter items after this Unix timestamp * @param {number} [maxTs] Filter items before this Unix timestamp * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementsResponse>>; /** * Gets balances for all subaccounts including the primary account. * @summary Get All Subaccount Balances * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubaccountBalances(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubaccountBalancesResponse>>; /** * Gets the netting enabled settings for all subaccounts. * @summary Get Subaccount Netting * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubaccountNetting(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubaccountNettingResponse>>; /** * Gets a paginated list of all transfers between subaccounts for the authenticated user. * @summary Get Subaccount Transfers * @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} */ getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubaccountTransfersResponse>>; /** * Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts. * @summary Update Subaccount Netting * @param {UpdateSubaccountNettingRequest} updateSubaccountNettingRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubaccountNetting(updateSubaccountNettingRequest: UpdateSubaccountNettingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; }; /** * PortfolioApi - factory interface */ export declare const PortfolioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts. * @summary Transfer Between Subaccounts * @param {ApplySubaccountTransferRequest} applySubaccountTransferRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ applySubaccountTransfer(applySubaccountTransferRequest: ApplySubaccountTransferRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>; /** * Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user. * @summary Create Subaccount * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubaccount(options?: RawAxiosRequestConfig): AxiosPromise<CreateSubaccountResponse>; /** * Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents. * @summary Get Balance * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBalance(subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetBalanceResponse>; /** * Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details. * @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 {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetFillsResponse>; /** * Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you. * @summary Get Total Resting Order Value * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): AxiosPromise<GetPortfolioRestingOrderTotalValueResponse>; /** * Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded * @summary Get Positions * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page. * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100. * @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded * @param {string} [ticker] Filter by market ticker * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported. * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse>; /** * Endpoint for getting the member\'s settlements historical track. * @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 {string} [ticker] Filter by market ticker * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported. * @param {number} [minTs] Filter items after this Unix timestamp * @param {number} [maxTs] Filter items before this Unix timestamp * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetSettlementsResponse>; /** * Gets balances for all subaccounts including the primary account. * @summary Get All Subaccount Balances * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubaccountBalances(options?: RawAxiosRequestConfig): AxiosPromise<GetSubaccountBalancesResponse>; /** * Gets the netting enabled settings for all subaccounts. * @summary Get Subaccount Netting * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubaccountNetting(options?: RawAxiosRequestConfig): AxiosPromise<GetSubaccountNettingResponse>; /** * Gets a paginated list of all transfers between subaccounts for the authenticated user. * @summary Get Subaccount Transfers * @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} */ getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSubaccountTransfersResponse>; /** * Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts. * @summary Update Subaccount Netting * @param {UpdateSubaccountNettingRequest} updateSubaccountNettingRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubaccountNetting(updateSubaccountNettingRequest: UpdateSubaccountNettingRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; }; /** * PortfolioApi - object-oriented interface */ export declare class PortfolioApi extends BaseAPI { /** * Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-32 for numbered subaccounts. * @summary Transfer Between Subaccounts * @param {ApplySubaccountTransferRequest} applySubaccountTransferRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ applySubaccountTransfer(applySubaccountTransferRequest: ApplySubaccountTransferRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>; /** * Creates a new subaccount for the authenticated user. Subaccounts are numbered sequentially starting from 1. Maximum 32 subaccounts per user. * @summary Create Subaccount * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubaccount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSubaccountResponse, any, {}>>; /** * Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents. * @summary Get Balance * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBalance(subaccount?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any, {}>>; /** * Endpoint for getting all fills for the member. A fill is when a trade you have is matched. Fills that occurred before the historical cutoff are only available via `GET /historical/fills`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details. * @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 {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any, {}>>; /** * Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you. * @summary Get Total Resting Order Value * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPortfolioRestingOrderTotalValueResponse, any, {}>>; /** * Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded * @summary Get Positions * @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page. * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100. * @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded * @param {string} [ticker] Filter by market ticker * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported. * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any, {}>>; /** * Endpoint for getting the member\'s settlements historical track. * @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 {string} [ticker] Filter by market ticker * @param {string} [eventTicker] Event ticker to filter by. Only a single event ticker is supported. * @param {number} [minTs] Filter items after this Unix timestamp * @param {number} [maxTs] Filter items before this Unix timestamp * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, subaccount?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any, {}>>; /** * Gets balances for all subaccounts including the primary account. * @summary Get All Subaccount Balances * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubaccountBalances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubaccountBalancesResponse, any, {}>>; /** * Gets the netting enabled settings for all subaccounts. * @summary Get Subaccount Netting * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubaccountNetting(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubaccountNettingResponse, any, {}>>; /** * Gets a paginated list of all transfers between subaccounts for the authenticated user. * @summary Get Subaccount Transfers * @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} */ getSubaccountTransfers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubaccountTransfersResponse, any, {}>>; /** * Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-32 for numbered subaccounts. * @summary Update Subaccount Netting * @param {UpdateSubaccountNettingRequest} updateSubaccountNettingRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubaccountNetting(updateSubaccountNettingRequest: UpdateSubaccountNettingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>; }