kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
667 lines (589 loc) • 38.1 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* 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 globalAxios from 'axios';
// URLSearchParams not necessarily used
// @ts-ignore
import { URL, URLSearchParams } from 'url';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError } from '../base';
// @ts-ignore
import type { CreateOrderGroupRequest } from '../models';
// @ts-ignore
import type { CreateOrderGroupResponse } from '../models';
// @ts-ignore
import type { ErrorResponse } from '../models';
// @ts-ignore
import type { GetOrderGroupResponse } from '../models';
// @ts-ignore
import type { GetOrderGroupsResponse } from '../models';
// @ts-ignore
import type { UpdateOrderGroupLimitRequest } from '../models';
/**
* OrderGroupsApi - axios parameter creator
*/
export const OrderGroupsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
* @summary Create Order Group
* @param {CreateOrderGroupRequest} createOrderGroupRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createOrderGroup: async (createOrderGroupRequest: CreateOrderGroupRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'createOrderGroupRequest' is not null or undefined
assertParamExists('createOrderGroup', 'createOrderGroupRequest', createOrderGroupRequest)
const localVarPath = `/portfolio/order_groups/create`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication kalshiAccessSignature required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
// authentication kalshiAccessKey required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
// authentication kalshiAccessTimestamp required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(createOrderGroupRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Deletes an order group and cancels all orders within it. This permanently removes the group.
* @summary Delete Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteOrderGroup: async (orderGroupId: string, subaccount?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'orderGroupId' is not null or undefined
assertParamExists('deleteOrderGroup', 'orderGroupId', orderGroupId)
const localVarPath = `/portfolio/order_groups/{order_group_id}`
.replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication kalshiAccessSignature required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
// authentication kalshiAccessKey required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
// authentication kalshiAccessTimestamp required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
if (subaccount !== undefined) {
localVarQueryParameter['subaccount'] = subaccount;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Retrieves details for a single order group including all order IDs and auto-cancel status.
* @summary Get Order Group
* @param {string} orderGroupId Order group ID
* @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}
*/
getOrderGroup: async (orderGroupId: string, subaccount?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'orderGroupId' is not null or undefined
assertParamExists('getOrderGroup', 'orderGroupId', orderGroupId)
const localVarPath = `/portfolio/order_groups/{order_group_id}`
.replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication kalshiAccessSignature required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
// authentication kalshiAccessKey required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
// authentication kalshiAccessTimestamp required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
if (subaccount !== undefined) {
localVarQueryParameter['subaccount'] = subaccount;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Retrieves all order groups for the authenticated user.
* @summary Get Order Groups
* @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}
*/
getOrderGroups: async (subaccount?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/portfolio/order_groups`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication kalshiAccessSignature required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
// authentication kalshiAccessKey required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
// authentication kalshiAccessTimestamp required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
if (subaccount !== undefined) {
localVarQueryParameter['subaccount'] = subaccount;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
* @summary Reset Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {object} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetOrderGroup: async (orderGroupId: string, subaccount?: number, body?: object, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'orderGroupId' is not null or undefined
assertParamExists('resetOrderGroup', 'orderGroupId', orderGroupId)
const localVarPath = `/portfolio/order_groups/{order_group_id}/reset`
.replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication kalshiAccessSignature required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
// authentication kalshiAccessKey required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
// authentication kalshiAccessTimestamp required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
if (subaccount !== undefined) {
localVarQueryParameter['subaccount'] = subaccount;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
* @summary Trigger Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {object} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
triggerOrderGroup: async (orderGroupId: string, subaccount?: number, body?: object, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'orderGroupId' is not null or undefined
assertParamExists('triggerOrderGroup', 'orderGroupId', orderGroupId)
const localVarPath = `/portfolio/order_groups/{order_group_id}/trigger`
.replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication kalshiAccessSignature required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
// authentication kalshiAccessKey required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
// authentication kalshiAccessTimestamp required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
if (subaccount !== undefined) {
localVarQueryParameter['subaccount'] = subaccount;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
* @summary Update Order Group Limit
* @param {string} orderGroupId Order group ID
* @param {UpdateOrderGroupLimitRequest} updateOrderGroupLimitRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateOrderGroupLimit: async (orderGroupId: string, updateOrderGroupLimitRequest: UpdateOrderGroupLimitRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'orderGroupId' is not null or undefined
assertParamExists('updateOrderGroupLimit', 'orderGroupId', orderGroupId)
// verify required parameter 'updateOrderGroupLimitRequest' is not null or undefined
assertParamExists('updateOrderGroupLimit', 'updateOrderGroupLimitRequest', updateOrderGroupLimitRequest)
const localVarPath = `/portfolio/order_groups/{order_group_id}/limit`
.replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication kalshiAccessSignature required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
// authentication kalshiAccessKey required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
// authentication kalshiAccessTimestamp required
await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(updateOrderGroupLimitRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* OrderGroupsApi - functional programming interface
*/
export const OrderGroupsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = OrderGroupsApiAxiosParamCreator(configuration)
return {
/**
* Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
* @summary Create Order Group
* @param {CreateOrderGroupRequest} createOrderGroupRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderGroupResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.createOrderGroup(createOrderGroupRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath: string | undefined = undefined;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Deletes an order group and cancels all orders within it. This permanently removes the group.
* @summary Delete Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrderGroup(orderGroupId, subaccount, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath: string | undefined = undefined;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Retrieves details for a single order group including all order IDs and auto-cancel status.
* @summary Get Order Group
* @param {string} orderGroupId Order group ID
* @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}
*/
async getOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderGroup(orderGroupId, subaccount, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath: string | undefined = undefined;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Retrieves all order groups for the authenticated user.
* @summary Get Order Groups
* @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}
*/
async getOrderGroups(subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupsResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderGroups(subaccount, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath: string | undefined = undefined;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
* @summary Reset Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {object} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async resetOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.resetOrderGroup(orderGroupId, subaccount, body, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath: string | undefined = undefined;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
* @summary Trigger Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {object} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async triggerOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.triggerOrderGroup(orderGroupId, subaccount, body, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath: string | undefined = undefined;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
* @summary Update Order Group Limit
* @param {string} orderGroupId Order group ID
* @param {UpdateOrderGroupLimitRequest} updateOrderGroupLimitRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async updateOrderGroupLimit(orderGroupId: string, updateOrderGroupLimitRequest: UpdateOrderGroupLimitRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateOrderGroupLimit(orderGroupId, updateOrderGroupLimitRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath: string | undefined = undefined;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* OrderGroupsApi - factory interface
*/
export const OrderGroupsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = OrderGroupsApiFp(configuration)
return {
/**
* Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
* @summary Create Order Group
* @param {CreateOrderGroupRequest} createOrderGroupRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderGroupResponse> {
return localVarFp.createOrderGroup(createOrderGroupRequest, options).then((request) => request(axios, basePath));
},
/**
* Deletes an order group and cancels all orders within it. This permanently removes the group.
* @summary Delete Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<object> {
return localVarFp.deleteOrderGroup(orderGroupId, subaccount, options).then((request) => request(axios, basePath));
},
/**
* Retrieves details for a single order group including all order IDs and auto-cancel status.
* @summary Get Order Group
* @param {string} orderGroupId Order group ID
* @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}
*/
getOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupResponse> {
return localVarFp.getOrderGroup(orderGroupId, subaccount, options).then((request) => request(axios, basePath));
},
/**
* Retrieves all order groups for the authenticated user.
* @summary Get Order Groups
* @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}
*/
getOrderGroups(subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupsResponse> {
return localVarFp.getOrderGroups(subaccount, options).then((request) => request(axios, basePath));
},
/**
* Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
* @summary Reset Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {object} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<object> {
return localVarFp.resetOrderGroup(orderGroupId, subaccount, body, options).then((request) => request(axios, basePath));
},
/**
* Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
* @summary Trigger Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {object} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
triggerOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<object> {
return localVarFp.triggerOrderGroup(orderGroupId, subaccount, body, options).then((request) => request(axios, basePath));
},
/**
* Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
* @summary Update Order Group Limit
* @param {string} orderGroupId Order group ID
* @param {UpdateOrderGroupLimitRequest} updateOrderGroupLimitRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateOrderGroupLimit(orderGroupId: string, updateOrderGroupLimitRequest: UpdateOrderGroupLimitRequest, options?: RawAxiosRequestConfig): AxiosPromise<object> {
return localVarFp.updateOrderGroupLimit(orderGroupId, updateOrderGroupLimitRequest, options).then((request) => request(axios, basePath));
},
};
};
/**
* OrderGroupsApi - object-oriented interface
*/
export class OrderGroupsApi extends BaseAPI {
/**
* Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
* @summary Create Order Group
* @param {CreateOrderGroupRequest} createOrderGroupRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig) {
return OrderGroupsApiFp(this.configuration).createOrderGroup(createOrderGroupRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
* Deletes an order group and cancels all orders within it. This permanently removes the group.
* @summary Delete Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public deleteOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig) {
return OrderGroupsApiFp(this.configuration).deleteOrderGroup(orderGroupId, subaccount, options).then((request) => request(this.axios, this.basePath));
}
/**
* Retrieves details for a single order group including all order IDs and auto-cancel status.
* @summary Get Order Group
* @param {string} orderGroupId Order group ID
* @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}
*/
public getOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig) {
return OrderGroupsApiFp(this.configuration).getOrderGroup(orderGroupId, subaccount, options).then((request) => request(this.axios, this.basePath));
}
/**
* Retrieves all order groups for the authenticated user.
* @summary Get Order Groups
* @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}
*/
public getOrderGroups(subaccount?: number, options?: RawAxiosRequestConfig) {
return OrderGroupsApiFp(this.configuration).getOrderGroups(subaccount, options).then((request) => request(this.axios, this.basePath));
}
/**
* Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
* @summary Reset Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {object} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public resetOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig) {
return OrderGroupsApiFp(this.configuration).resetOrderGroup(orderGroupId, subaccount, body, options).then((request) => request(this.axios, this.basePath));
}
/**
* Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
* @summary Trigger Order Group
* @param {string} orderGroupId Order group ID
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
* @param {object} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public triggerOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig) {
return OrderGroupsApiFp(this.configuration).triggerOrderGroup(orderGroupId, subaccount, body, options).then((request) => request(this.axios, this.basePath));
}
/**
* Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
* @summary Update Order Group Limit
* @param {string} orderGroupId Order group ID
* @param {UpdateOrderGroupLimitRequest} updateOrderGroupLimitRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public updateOrderGroupLimit(orderGroupId: string, updateOrderGroupLimitRequest: UpdateOrderGroupLimitRequest, options?: RawAxiosRequestConfig) {
return OrderGroupsApiFp(this.configuration).updateOrderGroupLimit(orderGroupId, updateOrderGroupLimitRequest, options).then((request) => request(this.axios, this.basePath));
}
}