kalshi-typescript 2.1.1 → 2.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +4 -1
- package/.openapi-generator-ignore +9 -2
- package/README.md +200 -29
- package/api/api-keys-api.ts +5 -5
- package/api/communications-api.ts +12 -12
- package/api/events-api.ts +4 -4
- package/api/exchange-api.ts +9 -9
- package/api/markets-api.ts +10 -10
- package/api/milestones-api.ts +3 -3
- package/api/multivariate-collections-api.ts +4 -4
- package/api/portfolio-api.ts +95 -21
- package/api/series-api.ts +3 -3
- package/api/structured-targets-api.ts +3 -3
- package/auth.ts +38 -0
- package/base.ts +51 -17
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/api-keys-api.d.ts +4 -4
- package/dist/api/api-keys-api.js +8 -8
- package/dist/api/communications-api.d.ts +11 -11
- package/dist/api/communications-api.js +22 -22
- package/dist/api/events-api.d.ts +3 -3
- package/dist/api/events-api.js +6 -6
- package/dist/api/exchange-api.d.ts +8 -8
- package/dist/api/exchange-api.js +12 -12
- package/dist/api/markets-api.d.ts +9 -9
- package/dist/api/markets-api.js +14 -14
- package/dist/api/milestones-api.d.ts +2 -2
- package/dist/api/milestones-api.js +4 -4
- package/dist/api/multivariate-collections-api.d.ts +3 -3
- package/dist/api/multivariate-collections-api.js +6 -6
- package/dist/api/portfolio-api.d.ts +52 -19
- package/dist/api/portfolio-api.js +107 -39
- package/dist/api/series-api.d.ts +2 -2
- package/dist/api/series-api.js +4 -4
- package/dist/api/structured-targets-api.d.ts +2 -2
- package/dist/api/structured-targets-api.js +4 -4
- package/dist/auth.d.ts +7 -0
- package/dist/auth.js +33 -0
- package/dist/base.d.ts +25 -10
- package/dist/base.js +37 -6
- package/dist/esm/api/api-keys-api.d.ts +4 -4
- package/dist/esm/api/api-keys-api.js +9 -9
- package/dist/esm/api/communications-api.d.ts +11 -11
- package/dist/esm/api/communications-api.js +23 -23
- package/dist/esm/api/events-api.d.ts +3 -3
- package/dist/esm/api/events-api.js +7 -7
- package/dist/esm/api/exchange-api.d.ts +8 -8
- package/dist/esm/api/exchange-api.js +13 -13
- package/dist/esm/api/markets-api.d.ts +9 -9
- package/dist/esm/api/markets-api.js +15 -15
- package/dist/esm/api/milestones-api.d.ts +2 -2
- package/dist/esm/api/milestones-api.js +5 -5
- package/dist/esm/api/multivariate-collections-api.d.ts +3 -3
- package/dist/esm/api/multivariate-collections-api.js +7 -7
- package/dist/esm/api/portfolio-api.d.ts +52 -19
- package/dist/esm/api/portfolio-api.js +108 -40
- package/dist/esm/api/series-api.d.ts +2 -2
- package/dist/esm/api/series-api.js +5 -5
- package/dist/esm/api/structured-targets-api.d.ts +2 -2
- package/dist/esm/api/structured-targets-api.js +5 -5
- package/dist/esm/auth.d.ts +7 -0
- package/dist/esm/auth.js +29 -0
- package/dist/esm/base.d.ts +25 -10
- package/dist/esm/base.js +36 -5
- package/dist/esm/models/amend-order-request.d.ts +30 -0
- package/dist/esm/models/amend-order-request.js +8 -1
- package/dist/esm/models/create-order-group-request.d.ts +4 -1
- package/dist/esm/models/create-order-group-response.d.ts +4 -2
- package/dist/esm/models/create-order-request.d.ts +8 -0
- package/dist/esm/models/error-response-error.d.ts +1 -1
- package/dist/esm/models/event-position.d.ts +53 -0
- package/dist/esm/models/event-position.js +14 -0
- package/dist/esm/models/get-order-group-response.d.ts +21 -0
- package/dist/esm/models/get-order-group-response.js +14 -0
- package/dist/esm/models/get-order-response.d.ts +1 -1
- package/dist/esm/models/get-positions-response.d.ts +3 -1
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/esm/models/order-group.d.ts +8 -4
- package/dist/esm/models/order.d.ts +16 -0
- package/dist/models/amend-order-request.d.ts +30 -0
- package/dist/models/amend-order-request.js +9 -0
- package/dist/models/create-order-group-request.d.ts +4 -1
- package/dist/models/create-order-group-response.d.ts +4 -2
- package/dist/models/create-order-request.d.ts +8 -0
- package/dist/models/error-response-error.d.ts +1 -1
- package/dist/models/event-position.d.ts +53 -0
- package/dist/models/event-position.js +15 -0
- package/dist/models/get-order-group-response.d.ts +21 -0
- package/dist/models/get-order-group-response.js +15 -0
- package/dist/models/get-order-response.d.ts +1 -1
- package/dist/models/get-positions-response.d.ts +3 -1
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/order-group.d.ts +8 -4
- package/dist/models/order.d.ts +16 -0
- package/docs/AcceptQuoteRequest.md +1 -1
- package/docs/AmendOrderRequest.md +11 -1
- package/docs/AmendOrderResponse.md +1 -1
- package/docs/Announcement.md +1 -1
- package/docs/ApiKey.md +1 -1
- package/docs/ApiKeysApi.md +20 -8
- package/docs/BatchCancelOrdersRequest.md +1 -1
- package/docs/BatchCancelOrdersResponse.md +1 -1
- package/docs/BatchCancelOrdersResponseResponsesInner.md +1 -1
- package/docs/BatchCreateOrdersRequest.md +1 -1
- package/docs/BatchCreateOrdersResponse.md +1 -1
- package/docs/BatchCreateOrdersResponseResponsesInner.md +1 -1
- package/docs/CancelOrderResponse.md +1 -1
- package/docs/Candlestick.md +1 -1
- package/docs/CommunicationsApi.md +55 -22
- package/docs/CreateApiKeyRequest.md +1 -1
- package/docs/CreateApiKeyResponse.md +1 -1
- package/docs/CreateOrderGroupRequest.md +3 -3
- package/docs/CreateOrderGroupResponse.md +3 -3
- package/docs/CreateOrderRequest.md +5 -1
- package/docs/CreateOrderResponse.md +1 -1
- package/docs/CreateQuoteRequest.md +1 -1
- package/docs/CreateQuoteResponse.md +1 -1
- package/docs/CreateRFQRequest.md +1 -1
- package/docs/CreateRFQResponse.md +1 -1
- package/docs/DailySchedule.md +1 -1
- package/docs/DecreaseOrderRequest.md +1 -1
- package/docs/DecreaseOrderResponse.md +1 -1
- package/docs/ErrorResponse.md +1 -1
- package/docs/ErrorResponseError.md +2 -2
- package/docs/Event.md +1 -1
- package/docs/EventPosition.md +38 -0
- package/docs/EventsApi.md +15 -6
- package/docs/ExchangeApi.md +21 -9
- package/docs/ExchangeStatus.md +1 -1
- package/docs/Fill.md +1 -1
- package/docs/GenerateApiKeyRequest.md +1 -1
- package/docs/GenerateApiKeyResponse.md +1 -1
- package/docs/GetApiKeysResponse.md +1 -1
- package/docs/GetBalanceResponse.md +1 -1
- package/docs/GetCommunicationsIDResponse.md +1 -1
- package/docs/GetEventMetadataResponse.md +1 -1
- package/docs/GetEventResponse.md +1 -1
- package/docs/GetEventsResponse.md +1 -1
- package/docs/GetExchangeAnnouncementsResponse.md +1 -1
- package/docs/GetExchangeScheduleResponse.md +1 -1
- package/docs/GetExchangeScheduleResponseSchedule.md +1 -1
- package/docs/GetFillsResponse.md +1 -1
- package/docs/GetMarketCandlesticksResponse.md +1 -1
- package/docs/GetMarketOrderbookResponse.md +1 -1
- package/docs/GetMarketOrderbookResponseOrderbook.md +1 -1
- package/docs/GetMarketResponse.md +1 -1
- package/docs/GetMarketsResponse.md +1 -1
- package/docs/GetMilestoneResponse.md +1 -1
- package/docs/GetMilestonesResponse.md +1 -1
- package/docs/GetMultivariateEventCollectionResponse.md +1 -1
- package/docs/GetMultivariateEventCollectionsResponse.md +1 -1
- package/docs/GetOrderGroupResponse.md +22 -0
- package/docs/GetOrderGroupsResponse.md +1 -1
- package/docs/GetOrderQueuePositionResponse.md +1 -1
- package/docs/GetOrderResponse.md +2 -2
- package/docs/GetOrdersResponse.md +1 -1
- package/docs/GetPositionsResponse.md +5 -3
- package/docs/GetQueuePositionsRequest.md +1 -1
- package/docs/GetQueuePositionsResponse.md +1 -1
- package/docs/GetQuoteResponse.md +1 -1
- package/docs/GetQuotesResponse.md +1 -1
- package/docs/GetRFQResponse.md +1 -1
- package/docs/GetRFQsResponse.md +1 -1
- package/docs/GetSeriesByTickerResponse.md +1 -1
- package/docs/GetSeriesResponse.md +1 -1
- package/docs/GetSettlementsResponse.md +1 -1
- package/docs/GetStructuredTargetResponse.md +1 -1
- package/docs/GetStructuredTargetsResponse.md +1 -1
- package/docs/GetTotalRestingOrderValueResponse.md +1 -1
- package/docs/GetTradesResponse.md +1 -1
- package/docs/GetUserDataTimestampResponse.md +1 -1
- package/docs/LookupBundleRequest.md +1 -1
- package/docs/LookupBundleRequestBundleInner.md +1 -1
- package/docs/LookupBundleResponse.md +1 -1
- package/docs/Market.md +1 -1
- package/docs/MarketsApi.md +26 -11
- package/docs/Milestone.md +1 -1
- package/docs/MilestonesApi.md +10 -4
- package/docs/MultivariateCollectionsApi.md +15 -6
- package/docs/MultivariateEventCollection.md +1 -1
- package/docs/MultivariateEventCollectionEventsInner.md +1 -1
- package/docs/Order.md +9 -1
- package/docs/OrderGroup.md +5 -9
- package/docs/OrderbookLevel.md +1 -1
- package/docs/PortfolioApi.md +154 -39
- package/docs/Position.md +1 -1
- package/docs/Quote.md +1 -1
- package/docs/RFQ.md +1 -1
- package/docs/Series.md +1 -1
- package/docs/SeriesApi.md +10 -4
- package/docs/Settlement.md +1 -1
- package/docs/StructuredTarget.md +1 -1
- package/docs/StructuredTargetsApi.md +10 -4
- package/docs/Trade.md +1 -1
- package/models/amend-order-request.ts +34 -0
- package/models/create-order-group-request.ts +4 -1
- package/models/create-order-group-response.ts +4 -4
- package/models/create-order-request.ts +8 -0
- package/models/error-response-error.ts +1 -1
- package/models/event-position.ts +59 -0
- package/models/get-order-group-response.ts +27 -0
- package/models/get-order-response.ts +1 -1
- package/models/get-positions-response.ts +5 -1
- package/models/index.ts +2 -0
- package/models/order-group.ts +8 -4
- package/models/order.ts +16 -0
- package/package.json +4 -4
package/dist/api/exchange-api.js
CHANGED
|
@@ -113,7 +113,7 @@ const ExchangeApiAxiosParamCreator = function (configuration) {
|
|
|
113
113
|
};
|
|
114
114
|
}),
|
|
115
115
|
/**
|
|
116
|
-
* There is typically a short delay before exchange events are reflected in the API endpoints.
|
|
116
|
+
* There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
|
|
117
117
|
* @summary Get User Data Timestamp
|
|
118
118
|
* @param {*} [options] Override http request option.
|
|
119
119
|
* @throws {RequiredError}
|
|
@@ -157,10 +157,10 @@ const ExchangeApiFp = function (configuration) {
|
|
|
157
157
|
*/
|
|
158
158
|
getExchangeAnnouncements(options) {
|
|
159
159
|
return __awaiter(this, void 0, void 0, function* () {
|
|
160
|
-
var _a
|
|
160
|
+
var _a;
|
|
161
161
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getExchangeAnnouncements(options);
|
|
162
162
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
163
|
-
const localVarOperationServerBasePath =
|
|
163
|
+
const localVarOperationServerBasePath = undefined;
|
|
164
164
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
165
165
|
});
|
|
166
166
|
},
|
|
@@ -172,10 +172,10 @@ const ExchangeApiFp = function (configuration) {
|
|
|
172
172
|
*/
|
|
173
173
|
getExchangeSchedule(options) {
|
|
174
174
|
return __awaiter(this, void 0, void 0, function* () {
|
|
175
|
-
var _a
|
|
175
|
+
var _a;
|
|
176
176
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getExchangeSchedule(options);
|
|
177
177
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
178
|
-
const localVarOperationServerBasePath =
|
|
178
|
+
const localVarOperationServerBasePath = undefined;
|
|
179
179
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
180
180
|
});
|
|
181
181
|
},
|
|
@@ -187,25 +187,25 @@ const ExchangeApiFp = function (configuration) {
|
|
|
187
187
|
*/
|
|
188
188
|
getExchangeStatus(options) {
|
|
189
189
|
return __awaiter(this, void 0, void 0, function* () {
|
|
190
|
-
var _a
|
|
190
|
+
var _a;
|
|
191
191
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getExchangeStatus(options);
|
|
192
192
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
193
|
-
const localVarOperationServerBasePath =
|
|
193
|
+
const localVarOperationServerBasePath = undefined;
|
|
194
194
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
195
195
|
});
|
|
196
196
|
},
|
|
197
197
|
/**
|
|
198
|
-
* There is typically a short delay before exchange events are reflected in the API endpoints.
|
|
198
|
+
* There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
|
|
199
199
|
* @summary Get User Data Timestamp
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
203
203
|
getUserDataTimestamp(options) {
|
|
204
204
|
return __awaiter(this, void 0, void 0, function* () {
|
|
205
|
-
var _a
|
|
205
|
+
var _a;
|
|
206
206
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserDataTimestamp(options);
|
|
207
207
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
208
|
-
const localVarOperationServerBasePath =
|
|
208
|
+
const localVarOperationServerBasePath = undefined;
|
|
209
209
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
210
210
|
});
|
|
211
211
|
},
|
|
@@ -246,7 +246,7 @@ const ExchangeApiFactory = function (configuration, basePath, axios) {
|
|
|
246
246
|
return localVarFp.getExchangeStatus(options).then((request) => request(axios, basePath));
|
|
247
247
|
},
|
|
248
248
|
/**
|
|
249
|
-
* There is typically a short delay before exchange events are reflected in the API endpoints.
|
|
249
|
+
* There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
|
|
250
250
|
* @summary Get User Data Timestamp
|
|
251
251
|
* @param {*} [options] Override http request option.
|
|
252
252
|
* @throws {RequiredError}
|
|
@@ -289,7 +289,7 @@ class ExchangeApi extends base_1.BaseAPI {
|
|
|
289
289
|
return (0, exports.ExchangeApiFp)(this.configuration).getExchangeStatus(options).then((request) => request(this.axios, this.basePath));
|
|
290
290
|
}
|
|
291
291
|
/**
|
|
292
|
-
* There is typically a short delay before exchange events are reflected in the API endpoints.
|
|
292
|
+
* There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
|
|
293
293
|
* @summary Get User Data Timestamp
|
|
294
294
|
* @param {*} [options] Override http request option.
|
|
295
295
|
* @throws {RequiredError}
|
|
@@ -51,7 +51,7 @@ export declare const MarketsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
51
51
|
*/
|
|
52
52
|
getMarketOrderbook: (ticker: string, depth?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
* List and discover markets on Kalshi.
|
|
54
|
+
* List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
55
55
|
* @summary Get Markets
|
|
56
56
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
57
57
|
* @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.
|
|
@@ -112,7 +112,7 @@ export declare const MarketsApiFp: (configuration?: Configuration) => {
|
|
|
112
112
|
*/
|
|
113
113
|
getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketOrderbookResponse>>;
|
|
114
114
|
/**
|
|
115
|
-
* List and discover markets on Kalshi.
|
|
115
|
+
* List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
116
116
|
* @summary Get Markets
|
|
117
117
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
118
118
|
* @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.
|
|
@@ -173,7 +173,7 @@ export declare const MarketsApiFactory: (configuration?: Configuration, basePath
|
|
|
173
173
|
*/
|
|
174
174
|
getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketOrderbookResponse>;
|
|
175
175
|
/**
|
|
176
|
-
* List and discover markets on Kalshi.
|
|
176
|
+
* List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
177
177
|
* @summary Get Markets
|
|
178
178
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
179
179
|
* @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.
|
|
@@ -211,7 +211,7 @@ export declare class MarketsApi extends BaseAPI {
|
|
|
211
211
|
* @param {*} [options] Override http request option.
|
|
212
212
|
* @throws {RequiredError}
|
|
213
213
|
*/
|
|
214
|
-
getMarket(ticker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketResponse, any>>;
|
|
214
|
+
getMarket(ticker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketResponse, any, {}>>;
|
|
215
215
|
/**
|
|
216
216
|
* Get candlestick data for a market within a series
|
|
217
217
|
* @summary Get Market Candlesticks
|
|
@@ -223,7 +223,7 @@ export declare class MarketsApi extends BaseAPI {
|
|
|
223
223
|
* @param {*} [options] Override http request option.
|
|
224
224
|
* @throws {RequiredError}
|
|
225
225
|
*/
|
|
226
|
-
getMarketCandlesticks(ticker: string, marketTicker: string, startTs?: number, endTs?: number, periodInterval?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksResponse, any>>;
|
|
226
|
+
getMarketCandlesticks(ticker: string, marketTicker: string, startTs?: number, endTs?: number, periodInterval?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksResponse, any, {}>>;
|
|
227
227
|
/**
|
|
228
228
|
* Get the orderbook for a market
|
|
229
229
|
* @summary Get Market Orderbook
|
|
@@ -232,9 +232,9 @@ export declare class MarketsApi extends BaseAPI {
|
|
|
232
232
|
* @param {*} [options] Override http request option.
|
|
233
233
|
* @throws {RequiredError}
|
|
234
234
|
*/
|
|
235
|
-
getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketOrderbookResponse, any>>;
|
|
235
|
+
getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketOrderbookResponse, any, {}>>;
|
|
236
236
|
/**
|
|
237
|
-
* List and discover markets on Kalshi.
|
|
237
|
+
* List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
238
238
|
* @summary Get Markets
|
|
239
239
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
240
240
|
* @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.
|
|
@@ -247,7 +247,7 @@ export declare class MarketsApi extends BaseAPI {
|
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
248
248
|
* @throws {RequiredError}
|
|
249
249
|
*/
|
|
250
|
-
getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, maxCloseTs?: number, minCloseTs?: number, status?: string, tickers?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketsResponse, any>>;
|
|
250
|
+
getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, maxCloseTs?: number, minCloseTs?: number, status?: string, tickers?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketsResponse, any, {}>>;
|
|
251
251
|
/**
|
|
252
252
|
* Get all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
253
253
|
* @summary Get Trades
|
|
@@ -259,5 +259,5 @@ export declare class MarketsApi extends BaseAPI {
|
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
262
|
-
getTrades(limit?: number, cursor?: string, ticker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTradesResponse, any>>;
|
|
262
|
+
getTrades(limit?: number, cursor?: string, ticker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTradesResponse, any, {}>>;
|
|
263
263
|
}
|
package/dist/api/markets-api.js
CHANGED
|
@@ -154,7 +154,7 @@ const MarketsApiAxiosParamCreator = function (configuration) {
|
|
|
154
154
|
};
|
|
155
155
|
}),
|
|
156
156
|
/**
|
|
157
|
-
* List and discover markets on Kalshi.
|
|
157
|
+
* List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
158
158
|
* @summary Get Markets
|
|
159
159
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
160
160
|
* @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.
|
|
@@ -276,10 +276,10 @@ const MarketsApiFp = function (configuration) {
|
|
|
276
276
|
*/
|
|
277
277
|
getMarket(ticker, options) {
|
|
278
278
|
return __awaiter(this, void 0, void 0, function* () {
|
|
279
|
-
var _a
|
|
279
|
+
var _a;
|
|
280
280
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarket(ticker, options);
|
|
281
281
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
282
|
-
const localVarOperationServerBasePath =
|
|
282
|
+
const localVarOperationServerBasePath = undefined;
|
|
283
283
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
284
284
|
});
|
|
285
285
|
},
|
|
@@ -296,10 +296,10 @@ const MarketsApiFp = function (configuration) {
|
|
|
296
296
|
*/
|
|
297
297
|
getMarketCandlesticks(ticker, marketTicker, startTs, endTs, periodInterval, options) {
|
|
298
298
|
return __awaiter(this, void 0, void 0, function* () {
|
|
299
|
-
var _a
|
|
299
|
+
var _a;
|
|
300
300
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarketCandlesticks(ticker, marketTicker, startTs, endTs, periodInterval, options);
|
|
301
301
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
302
|
-
const localVarOperationServerBasePath =
|
|
302
|
+
const localVarOperationServerBasePath = undefined;
|
|
303
303
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
304
304
|
});
|
|
305
305
|
},
|
|
@@ -313,15 +313,15 @@ const MarketsApiFp = function (configuration) {
|
|
|
313
313
|
*/
|
|
314
314
|
getMarketOrderbook(ticker, depth, options) {
|
|
315
315
|
return __awaiter(this, void 0, void 0, function* () {
|
|
316
|
-
var _a
|
|
316
|
+
var _a;
|
|
317
317
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarketOrderbook(ticker, depth, options);
|
|
318
318
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
319
|
-
const localVarOperationServerBasePath =
|
|
319
|
+
const localVarOperationServerBasePath = undefined;
|
|
320
320
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
321
321
|
});
|
|
322
322
|
},
|
|
323
323
|
/**
|
|
324
|
-
* List and discover markets on Kalshi.
|
|
324
|
+
* List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
325
325
|
* @summary Get Markets
|
|
326
326
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
327
327
|
* @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.
|
|
@@ -336,10 +336,10 @@ const MarketsApiFp = function (configuration) {
|
|
|
336
336
|
*/
|
|
337
337
|
getMarkets(limit, cursor, eventTicker, seriesTicker, maxCloseTs, minCloseTs, status, tickers, options) {
|
|
338
338
|
return __awaiter(this, void 0, void 0, function* () {
|
|
339
|
-
var _a
|
|
339
|
+
var _a;
|
|
340
340
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarkets(limit, cursor, eventTicker, seriesTicker, maxCloseTs, minCloseTs, status, tickers, options);
|
|
341
341
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
342
|
-
const localVarOperationServerBasePath =
|
|
342
|
+
const localVarOperationServerBasePath = undefined;
|
|
343
343
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
344
344
|
});
|
|
345
345
|
},
|
|
@@ -356,10 +356,10 @@ const MarketsApiFp = function (configuration) {
|
|
|
356
356
|
*/
|
|
357
357
|
getTrades(limit, cursor, ticker, minTs, maxTs, options) {
|
|
358
358
|
return __awaiter(this, void 0, void 0, function* () {
|
|
359
|
-
var _a
|
|
359
|
+
var _a;
|
|
360
360
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTrades(limit, cursor, ticker, minTs, maxTs, options);
|
|
361
361
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
362
|
-
const localVarOperationServerBasePath =
|
|
362
|
+
const localVarOperationServerBasePath = undefined;
|
|
363
363
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
364
364
|
});
|
|
365
365
|
},
|
|
@@ -408,7 +408,7 @@ const MarketsApiFactory = function (configuration, basePath, axios) {
|
|
|
408
408
|
return localVarFp.getMarketOrderbook(ticker, depth, options).then((request) => request(axios, basePath));
|
|
409
409
|
},
|
|
410
410
|
/**
|
|
411
|
-
* List and discover markets on Kalshi.
|
|
411
|
+
* List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
412
412
|
* @summary Get Markets
|
|
413
413
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
414
414
|
* @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.
|
|
@@ -481,7 +481,7 @@ class MarketsApi extends base_1.BaseAPI {
|
|
|
481
481
|
return (0, exports.MarketsApiFp)(this.configuration).getMarketOrderbook(ticker, depth, options).then((request) => request(this.axios, this.basePath));
|
|
482
482
|
}
|
|
483
483
|
/**
|
|
484
|
-
* List and discover markets on Kalshi.
|
|
484
|
+
* List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
485
485
|
* @summary Get Markets
|
|
486
486
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
487
487
|
* @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.
|
|
@@ -91,7 +91,7 @@ export declare class MilestonesApi extends BaseAPI {
|
|
|
91
91
|
* @param {*} [options] Override http request option.
|
|
92
92
|
* @throws {RequiredError}
|
|
93
93
|
*/
|
|
94
|
-
getMilestone(milestoneId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestoneResponse, any>>;
|
|
94
|
+
getMilestone(milestoneId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestoneResponse, any, {}>>;
|
|
95
95
|
/**
|
|
96
96
|
* Get all milestones
|
|
97
97
|
* @summary Get Milestones
|
|
@@ -100,5 +100,5 @@ export declare class MilestonesApi extends BaseAPI {
|
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
101
101
|
* @throws {RequiredError}
|
|
102
102
|
*/
|
|
103
|
-
getMilestones(status?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestonesResponse, any>>;
|
|
103
|
+
getMilestones(status?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestonesResponse, any, {}>>;
|
|
104
104
|
}
|
|
@@ -123,10 +123,10 @@ const MilestonesApiFp = function (configuration) {
|
|
|
123
123
|
*/
|
|
124
124
|
getMilestone(milestoneId, options) {
|
|
125
125
|
return __awaiter(this, void 0, void 0, function* () {
|
|
126
|
-
var _a
|
|
126
|
+
var _a;
|
|
127
127
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMilestone(milestoneId, options);
|
|
128
128
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
129
|
-
const localVarOperationServerBasePath =
|
|
129
|
+
const localVarOperationServerBasePath = undefined;
|
|
130
130
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131
131
|
});
|
|
132
132
|
},
|
|
@@ -140,10 +140,10 @@ const MilestonesApiFp = function (configuration) {
|
|
|
140
140
|
*/
|
|
141
141
|
getMilestones(status, limit, options) {
|
|
142
142
|
return __awaiter(this, void 0, void 0, function* () {
|
|
143
|
-
var _a
|
|
143
|
+
var _a;
|
|
144
144
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMilestones(status, limit, options);
|
|
145
145
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
146
|
-
const localVarOperationServerBasePath =
|
|
146
|
+
const localVarOperationServerBasePath = undefined;
|
|
147
147
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
148
148
|
});
|
|
149
149
|
},
|
|
@@ -117,7 +117,7 @@ export declare class MultivariateCollectionsApi extends BaseAPI {
|
|
|
117
117
|
* @param {*} [options] Override http request option.
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
120
|
-
getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionResponse, any>>;
|
|
120
|
+
getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionResponse, any, {}>>;
|
|
121
121
|
/**
|
|
122
122
|
* Get all multivariate event collections
|
|
123
123
|
* @summary Get Multivariate Event Collections
|
|
@@ -125,7 +125,7 @@ export declare class MultivariateCollectionsApi extends BaseAPI {
|
|
|
125
125
|
* @param {*} [options] Override http request option.
|
|
126
126
|
* @throws {RequiredError}
|
|
127
127
|
*/
|
|
128
|
-
getMultivariateEventCollections(status?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionsResponse, any>>;
|
|
128
|
+
getMultivariateEventCollections(status?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionsResponse, any, {}>>;
|
|
129
129
|
/**
|
|
130
130
|
* Lookup a bundle in a multivariate event collection
|
|
131
131
|
* @summary Lookup Multivariate Event Collection Bundle
|
|
@@ -134,5 +134,5 @@ export declare class MultivariateCollectionsApi extends BaseAPI {
|
|
|
134
134
|
* @param {*} [options] Override http request option.
|
|
135
135
|
* @throws {RequiredError}
|
|
136
136
|
*/
|
|
137
|
-
lookupMultivariateEventCollectionBundle(collectionTicker: string, lookupBundleRequest: LookupBundleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LookupBundleResponse, any>>;
|
|
137
|
+
lookupMultivariateEventCollectionBundle(collectionTicker: string, lookupBundleRequest: LookupBundleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LookupBundleResponse, any, {}>>;
|
|
138
138
|
}
|
|
@@ -156,10 +156,10 @@ const MultivariateCollectionsApiFp = function (configuration) {
|
|
|
156
156
|
*/
|
|
157
157
|
getMultivariateEventCollection(collectionTicker, options) {
|
|
158
158
|
return __awaiter(this, void 0, void 0, function* () {
|
|
159
|
-
var _a
|
|
159
|
+
var _a;
|
|
160
160
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMultivariateEventCollection(collectionTicker, options);
|
|
161
161
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
162
|
-
const localVarOperationServerBasePath =
|
|
162
|
+
const localVarOperationServerBasePath = undefined;
|
|
163
163
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
164
164
|
});
|
|
165
165
|
},
|
|
@@ -172,10 +172,10 @@ const MultivariateCollectionsApiFp = function (configuration) {
|
|
|
172
172
|
*/
|
|
173
173
|
getMultivariateEventCollections(status, options) {
|
|
174
174
|
return __awaiter(this, void 0, void 0, function* () {
|
|
175
|
-
var _a
|
|
175
|
+
var _a;
|
|
176
176
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMultivariateEventCollections(status, options);
|
|
177
177
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
178
|
-
const localVarOperationServerBasePath =
|
|
178
|
+
const localVarOperationServerBasePath = undefined;
|
|
179
179
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
180
180
|
});
|
|
181
181
|
},
|
|
@@ -189,10 +189,10 @@ const MultivariateCollectionsApiFp = function (configuration) {
|
|
|
189
189
|
*/
|
|
190
190
|
lookupMultivariateEventCollectionBundle(collectionTicker, lookupBundleRequest, options) {
|
|
191
191
|
return __awaiter(this, void 0, void 0, function* () {
|
|
192
|
-
var _a
|
|
192
|
+
var _a;
|
|
193
193
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.lookupMultivariateEventCollectionBundle(collectionTicker, lookupBundleRequest, options);
|
|
194
194
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
195
|
-
const localVarOperationServerBasePath =
|
|
195
|
+
const localVarOperationServerBasePath = undefined;
|
|
196
196
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
197
197
|
});
|
|
198
198
|
},
|
|
@@ -27,6 +27,7 @@ import type { DecreaseOrderRequest } from '../models';
|
|
|
27
27
|
import type { DecreaseOrderResponse } from '../models';
|
|
28
28
|
import type { GetBalanceResponse } from '../models';
|
|
29
29
|
import type { GetFillsResponse } from '../models';
|
|
30
|
+
import type { GetOrderGroupResponse } from '../models';
|
|
30
31
|
import type { GetOrderGroupsResponse } from '../models';
|
|
31
32
|
import type { GetOrderQueuePositionResponse } from '../models';
|
|
32
33
|
import type { GetOrderResponse } from '../models';
|
|
@@ -134,6 +135,14 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
|
|
|
134
135
|
* @throws {RequiredError}
|
|
135
136
|
*/
|
|
136
137
|
getOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
138
|
+
/**
|
|
139
|
+
* Get details of a specific order group
|
|
140
|
+
* @summary Get Order Group
|
|
141
|
+
* @param {string} orderGroupId Order group ID
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
getOrderGroup: (orderGroupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
137
146
|
/**
|
|
138
147
|
* Get order groups for the logged-in user
|
|
139
148
|
* @summary Get Order Groups
|
|
@@ -310,6 +319,14 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
|
|
|
310
319
|
* @throws {RequiredError}
|
|
311
320
|
*/
|
|
312
321
|
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
|
|
322
|
+
/**
|
|
323
|
+
* Get details of a specific order group
|
|
324
|
+
* @summary Get Order Group
|
|
325
|
+
* @param {string} orderGroupId Order group ID
|
|
326
|
+
* @param {*} [options] Override http request option.
|
|
327
|
+
* @throws {RequiredError}
|
|
328
|
+
*/
|
|
329
|
+
getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupResponse>>;
|
|
313
330
|
/**
|
|
314
331
|
* Get order groups for the logged-in user
|
|
315
332
|
* @summary Get Order Groups
|
|
@@ -486,6 +503,14 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
|
|
|
486
503
|
* @throws {RequiredError}
|
|
487
504
|
*/
|
|
488
505
|
getOrder(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse>;
|
|
506
|
+
/**
|
|
507
|
+
* Get details of a specific order group
|
|
508
|
+
* @summary Get Order Group
|
|
509
|
+
* @param {string} orderGroupId Order group ID
|
|
510
|
+
* @param {*} [options] Override http request option.
|
|
511
|
+
* @throws {RequiredError}
|
|
512
|
+
*/
|
|
513
|
+
getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupResponse>;
|
|
489
514
|
/**
|
|
490
515
|
* Get order groups for the logged-in user
|
|
491
516
|
* @summary Get Order Groups
|
|
@@ -576,7 +601,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
576
601
|
* @param {*} [options] Override http request option.
|
|
577
602
|
* @throws {RequiredError}
|
|
578
603
|
*/
|
|
579
|
-
amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AmendOrderResponse, any>>;
|
|
604
|
+
amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AmendOrderResponse, any, {}>>;
|
|
580
605
|
/**
|
|
581
606
|
* Cancel multiple orders in a single request
|
|
582
607
|
* @summary Batch Cancel Orders
|
|
@@ -584,7 +609,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
584
609
|
* @param {*} [options] Override http request option.
|
|
585
610
|
* @throws {RequiredError}
|
|
586
611
|
*/
|
|
587
|
-
batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCancelOrdersResponse, any>>;
|
|
612
|
+
batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCancelOrdersResponse, any, {}>>;
|
|
588
613
|
/**
|
|
589
614
|
* Create multiple orders in a single request
|
|
590
615
|
* @summary Batch Create Orders
|
|
@@ -592,7 +617,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
592
617
|
* @param {*} [options] Override http request option.
|
|
593
618
|
* @throws {RequiredError}
|
|
594
619
|
*/
|
|
595
|
-
batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCreateOrdersResponse, any>>;
|
|
620
|
+
batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCreateOrdersResponse, any, {}>>;
|
|
596
621
|
/**
|
|
597
622
|
* Cancel an order
|
|
598
623
|
* @summary Cancel Order
|
|
@@ -600,7 +625,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
600
625
|
* @param {*} [options] Override http request option.
|
|
601
626
|
* @throws {RequiredError}
|
|
602
627
|
*/
|
|
603
|
-
cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any>>;
|
|
628
|
+
cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any, {}>>;
|
|
604
629
|
/**
|
|
605
630
|
* Create a new order
|
|
606
631
|
* @summary Create Order
|
|
@@ -608,7 +633,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
608
633
|
* @param {*} [options] Override http request option.
|
|
609
634
|
* @throws {RequiredError}
|
|
610
635
|
*/
|
|
611
|
-
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderResponse, any>>;
|
|
636
|
+
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderResponse, any, {}>>;
|
|
612
637
|
/**
|
|
613
638
|
* Create a new order group
|
|
614
639
|
* @summary Create Order Group
|
|
@@ -616,7 +641,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
616
641
|
* @param {*} [options] Override http request option.
|
|
617
642
|
* @throws {RequiredError}
|
|
618
643
|
*/
|
|
619
|
-
createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderGroupResponse, any>>;
|
|
644
|
+
createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderGroupResponse, any, {}>>;
|
|
620
645
|
/**
|
|
621
646
|
* Decrease the size of an existing order
|
|
622
647
|
* @summary Decrease Order
|
|
@@ -625,7 +650,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
625
650
|
* @param {*} [options] Override http request option.
|
|
626
651
|
* @throws {RequiredError}
|
|
627
652
|
*/
|
|
628
|
-
decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DecreaseOrderResponse, any>>;
|
|
653
|
+
decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DecreaseOrderResponse, any, {}>>;
|
|
629
654
|
/**
|
|
630
655
|
* Delete an order group
|
|
631
656
|
* @summary Delete Order Group
|
|
@@ -633,14 +658,14 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
633
658
|
* @param {*} [options] Override http request option.
|
|
634
659
|
* @throws {RequiredError}
|
|
635
660
|
*/
|
|
636
|
-
deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
661
|
+
deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
637
662
|
/**
|
|
638
663
|
* Get the user\'s current balance
|
|
639
664
|
* @summary Get Balance
|
|
640
665
|
* @param {*} [options] Override http request option.
|
|
641
666
|
* @throws {RequiredError}
|
|
642
667
|
*/
|
|
643
|
-
getBalance(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any>>;
|
|
668
|
+
getBalance(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any, {}>>;
|
|
644
669
|
/**
|
|
645
670
|
* 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.
|
|
646
671
|
* @summary Get Fills
|
|
@@ -653,7 +678,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
653
678
|
* @param {*} [options] Override http request option.
|
|
654
679
|
* @throws {RequiredError}
|
|
655
680
|
*/
|
|
656
|
-
getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any>>;
|
|
681
|
+
getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any, {}>>;
|
|
657
682
|
/**
|
|
658
683
|
* Get a single order by ID
|
|
659
684
|
* @summary Get Order
|
|
@@ -661,7 +686,15 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
661
686
|
* @param {*} [options] Override http request option.
|
|
662
687
|
* @throws {RequiredError}
|
|
663
688
|
*/
|
|
664
|
-
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderResponse, any>>;
|
|
689
|
+
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderResponse, any, {}>>;
|
|
690
|
+
/**
|
|
691
|
+
* Get details of a specific order group
|
|
692
|
+
* @summary Get Order Group
|
|
693
|
+
* @param {string} orderGroupId Order group ID
|
|
694
|
+
* @param {*} [options] Override http request option.
|
|
695
|
+
* @throws {RequiredError}
|
|
696
|
+
*/
|
|
697
|
+
getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderGroupResponse, any, {}>>;
|
|
665
698
|
/**
|
|
666
699
|
* Get order groups for the logged-in user
|
|
667
700
|
* @summary Get Order Groups
|
|
@@ -671,7 +704,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
671
704
|
* @param {*} [options] Override http request option.
|
|
672
705
|
* @throws {RequiredError}
|
|
673
706
|
*/
|
|
674
|
-
getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderGroupsResponse, any>>;
|
|
707
|
+
getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderGroupsResponse, any, {}>>;
|
|
675
708
|
/**
|
|
676
709
|
* Get the queue position for an order
|
|
677
710
|
* @summary Get Order Queue Position
|
|
@@ -679,7 +712,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
679
712
|
* @param {*} [options] Override http request option.
|
|
680
713
|
* @throws {RequiredError}
|
|
681
714
|
*/
|
|
682
|
-
getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderQueuePositionResponse, any>>;
|
|
715
|
+
getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderQueuePositionResponse, any, {}>>;
|
|
683
716
|
/**
|
|
684
717
|
* Get orders for the logged-in user
|
|
685
718
|
* @summary Get Orders
|
|
@@ -693,7 +726,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
693
726
|
* @param {*} [options] Override http request option.
|
|
694
727
|
* @throws {RequiredError}
|
|
695
728
|
*/
|
|
696
|
-
getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
|
|
729
|
+
getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any, {}>>;
|
|
697
730
|
/**
|
|
698
731
|
* Get positions for the logged-in user
|
|
699
732
|
* @summary Get Positions
|
|
@@ -706,7 +739,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
706
739
|
* @param {*} [options] Override http request option.
|
|
707
740
|
* @throws {RequiredError}
|
|
708
741
|
*/
|
|
709
|
-
getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any>>;
|
|
742
|
+
getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any, {}>>;
|
|
710
743
|
/**
|
|
711
744
|
* Get queue positions for multiple orders
|
|
712
745
|
* @summary Get Queue Positions
|
|
@@ -714,7 +747,7 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
714
747
|
* @param {*} [options] Override http request option.
|
|
715
748
|
* @throws {RequiredError}
|
|
716
749
|
*/
|
|
717
|
-
getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQueuePositionsResponse, any>>;
|
|
750
|
+
getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQueuePositionsResponse, any, {}>>;
|
|
718
751
|
/**
|
|
719
752
|
* Get settlements for the logged-in user
|
|
720
753
|
* @summary Get Settlements
|
|
@@ -723,14 +756,14 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
723
756
|
* @param {*} [options] Override http request option.
|
|
724
757
|
* @throws {RequiredError}
|
|
725
758
|
*/
|
|
726
|
-
getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any>>;
|
|
759
|
+
getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any, {}>>;
|
|
727
760
|
/**
|
|
728
761
|
* Get the total value of all resting orders
|
|
729
762
|
* @summary Get Total Resting Order Value
|
|
730
763
|
* @param {*} [options] Override http request option.
|
|
731
764
|
* @throws {RequiredError}
|
|
732
765
|
*/
|
|
733
|
-
getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTotalRestingOrderValueResponse, any>>;
|
|
766
|
+
getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTotalRestingOrderValueResponse, any, {}>>;
|
|
734
767
|
/**
|
|
735
768
|
* Reset an order group
|
|
736
769
|
* @summary Reset Order Group
|
|
@@ -738,5 +771,5 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
738
771
|
* @param {*} [options] Override http request option.
|
|
739
772
|
* @throws {RequiredError}
|
|
740
773
|
*/
|
|
741
|
-
resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
774
|
+
resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
742
775
|
}
|