kalshi-typescript 2.1.1 → 2.1.2
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/exchange-api.ts +4 -4
- package/api/markets-api.ts +4 -4
- package/api/portfolio-api.ts +75 -1
- 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/communications-api.d.ts +11 -11
- package/dist/api/events-api.d.ts +3 -3
- package/dist/api/exchange-api.d.ts +8 -8
- package/dist/api/exchange-api.js +4 -4
- package/dist/api/markets-api.d.ts +9 -9
- package/dist/api/markets-api.js +4 -4
- package/dist/api/milestones-api.d.ts +2 -2
- package/dist/api/multivariate-collections-api.d.ts +3 -3
- package/dist/api/portfolio-api.d.ts +52 -19
- package/dist/api/portfolio-api.js +69 -1
- package/dist/api/series-api.d.ts +2 -2
- package/dist/api/structured-targets-api.d.ts +2 -2
- 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/communications-api.d.ts +11 -11
- package/dist/esm/api/events-api.d.ts +3 -3
- package/dist/esm/api/exchange-api.d.ts +8 -8
- package/dist/esm/api/exchange-api.js +4 -4
- package/dist/esm/api/markets-api.d.ts +9 -9
- package/dist/esm/api/markets-api.js +4 -4
- package/dist/esm/api/milestones-api.d.ts +2 -2
- package/dist/esm/api/multivariate-collections-api.d.ts +3 -3
- package/dist/esm/api/portfolio-api.d.ts +52 -19
- package/dist/esm/api/portfolio-api.js +69 -1
- package/dist/esm/api/series-api.d.ts +2 -2
- package/dist/esm/api/structured-targets-api.d.ts +2 -2
- 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
|
@@ -9,7 +9,9 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type { OrderGroup } from './order-group';
|
|
13
12
|
export interface CreateOrderGroupResponse {
|
|
14
|
-
|
|
13
|
+
/**
|
|
14
|
+
* The unique identifier for the created order group
|
|
15
|
+
*/
|
|
16
|
+
'order_group_id'?: string;
|
|
15
17
|
}
|
|
@@ -21,6 +21,14 @@ export interface CreateOrderRequest {
|
|
|
21
21
|
'expiration_ts'?: number;
|
|
22
22
|
'sell_position_floor'?: number;
|
|
23
23
|
'buy_max_cost'?: number;
|
|
24
|
+
/**
|
|
25
|
+
* If set to true, the order will be rejected if it crosses the spread and executes immediately
|
|
26
|
+
*/
|
|
27
|
+
'post_only'?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* OrderGroupId specifies the order group this order is part of
|
|
30
|
+
*/
|
|
31
|
+
'order_group_id'?: string;
|
|
24
32
|
}
|
|
25
33
|
export declare const CreateOrderRequestSideEnum: {
|
|
26
34
|
readonly Yes: "yes";
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Kalshi Trading API
|
|
3
|
+
* Complete API for the Kalshi trading platform including all handlers for SDK generation
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@kalshi.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface EventPosition {
|
|
13
|
+
/**
|
|
14
|
+
* Unique identifier for events.
|
|
15
|
+
*/
|
|
16
|
+
'event_ticker'?: string;
|
|
17
|
+
/**
|
|
18
|
+
* Total spent on this event in cents.
|
|
19
|
+
*/
|
|
20
|
+
'total_cost'?: number;
|
|
21
|
+
/**
|
|
22
|
+
* Total spent on this event in dollars.
|
|
23
|
+
*/
|
|
24
|
+
'total_cost_dollars'?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Cost of the aggregate event position in cents.
|
|
27
|
+
*/
|
|
28
|
+
'event_exposure'?: number;
|
|
29
|
+
/**
|
|
30
|
+
* Cost of the aggregate event position in dollars.
|
|
31
|
+
*/
|
|
32
|
+
'event_exposure_dollars'?: string;
|
|
33
|
+
/**
|
|
34
|
+
* Locked in profit and loss, in cents.
|
|
35
|
+
*/
|
|
36
|
+
'realized_pnl'?: number;
|
|
37
|
+
/**
|
|
38
|
+
* Locked in profit and loss, in dollars.
|
|
39
|
+
*/
|
|
40
|
+
'realized_pnl_dollars'?: string;
|
|
41
|
+
/**
|
|
42
|
+
* Aggregate size of resting orders in contract units.
|
|
43
|
+
*/
|
|
44
|
+
'resting_order_count'?: number;
|
|
45
|
+
/**
|
|
46
|
+
* Fees paid on fill orders, in cents.
|
|
47
|
+
*/
|
|
48
|
+
'fees_paid'?: number;
|
|
49
|
+
/**
|
|
50
|
+
* Fees paid on fill orders, in dollars.
|
|
51
|
+
*/
|
|
52
|
+
'fees_paid_dollars'?: string;
|
|
53
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Kalshi Trading API
|
|
6
|
+
* Complete API for the Kalshi trading platform including all handlers for SDK generation
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@kalshi.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Kalshi Trading API
|
|
3
|
+
* Complete API for the Kalshi trading platform including all handlers for SDK generation
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@kalshi.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetOrderGroupResponse {
|
|
13
|
+
/**
|
|
14
|
+
* Whether auto-cancel is enabled for this order group
|
|
15
|
+
*/
|
|
16
|
+
'is_auto_cancel_enabled'?: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* List of order IDs that belong to this order group
|
|
19
|
+
*/
|
|
20
|
+
'orders'?: Array<string>;
|
|
21
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Kalshi Trading API
|
|
6
|
+
* Complete API for the Kalshi trading platform including all handlers for SDK generation
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@kalshi.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -9,8 +9,10 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { EventPosition } from './event-position';
|
|
12
13
|
import type { Position } from './position';
|
|
13
14
|
export interface GetPositionsResponse {
|
|
14
|
-
'
|
|
15
|
+
'market_positions'?: Array<Position>;
|
|
16
|
+
'event_positions'?: Array<EventPosition>;
|
|
15
17
|
'cursor'?: string;
|
|
16
18
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -27,6 +27,7 @@ export * from './decrease-order-response';
|
|
|
27
27
|
export * from './error-response';
|
|
28
28
|
export * from './error-response-error';
|
|
29
29
|
export * from './event';
|
|
30
|
+
export * from './event-position';
|
|
30
31
|
export * from './exchange-status';
|
|
31
32
|
export * from './fill';
|
|
32
33
|
export * from './generate-api-key-request';
|
|
@@ -50,6 +51,7 @@ export * from './get-milestone-response';
|
|
|
50
51
|
export * from './get-milestones-response';
|
|
51
52
|
export * from './get-multivariate-event-collection-response';
|
|
52
53
|
export * from './get-multivariate-event-collections-response';
|
|
54
|
+
export * from './get-order-group-response';
|
|
53
55
|
export * from './get-order-groups-response';
|
|
54
56
|
export * from './get-order-queue-position-response';
|
|
55
57
|
export * from './get-order-response';
|
package/dist/models/index.js
CHANGED
|
@@ -43,6 +43,7 @@ __exportStar(require("./decrease-order-response"), exports);
|
|
|
43
43
|
__exportStar(require("./error-response"), exports);
|
|
44
44
|
__exportStar(require("./error-response-error"), exports);
|
|
45
45
|
__exportStar(require("./event"), exports);
|
|
46
|
+
__exportStar(require("./event-position"), exports);
|
|
46
47
|
__exportStar(require("./exchange-status"), exports);
|
|
47
48
|
__exportStar(require("./fill"), exports);
|
|
48
49
|
__exportStar(require("./generate-api-key-request"), exports);
|
|
@@ -66,6 +67,7 @@ __exportStar(require("./get-milestone-response"), exports);
|
|
|
66
67
|
__exportStar(require("./get-milestones-response"), exports);
|
|
67
68
|
__exportStar(require("./get-multivariate-event-collection-response"), exports);
|
|
68
69
|
__exportStar(require("./get-multivariate-event-collections-response"), exports);
|
|
70
|
+
__exportStar(require("./get-order-group-response"), exports);
|
|
69
71
|
__exportStar(require("./get-order-groups-response"), exports);
|
|
70
72
|
__exportStar(require("./get-order-queue-position-response"), exports);
|
|
71
73
|
__exportStar(require("./get-order-response"), exports);
|
|
@@ -10,8 +10,12 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
export interface OrderGroup {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
'
|
|
13
|
+
/**
|
|
14
|
+
* Unique identifier for the order group
|
|
15
|
+
*/
|
|
16
|
+
'id': string;
|
|
17
|
+
/**
|
|
18
|
+
* Whether auto-cancel is enabled for this order group
|
|
19
|
+
*/
|
|
20
|
+
'is_auto_cancel_enabled'?: boolean;
|
|
17
21
|
}
|
package/dist/models/order.d.ts
CHANGED
|
@@ -20,7 +20,23 @@ export interface Order {
|
|
|
20
20
|
'yes_price'?: number;
|
|
21
21
|
'no_price'?: number;
|
|
22
22
|
'count'?: number;
|
|
23
|
+
/**
|
|
24
|
+
* The number of contracts that have been filled
|
|
25
|
+
*/
|
|
26
|
+
'fill_count'?: number;
|
|
23
27
|
'remaining_count'?: number;
|
|
28
|
+
/**
|
|
29
|
+
* The initial size of the order (contract units)
|
|
30
|
+
*/
|
|
31
|
+
'initial_count'?: number;
|
|
32
|
+
/**
|
|
33
|
+
* Fees paid on filled taker contracts, in cents
|
|
34
|
+
*/
|
|
35
|
+
'taker_fees'?: number;
|
|
36
|
+
/**
|
|
37
|
+
* Fees paid on filled maker contracts, in cents
|
|
38
|
+
*/
|
|
39
|
+
'maker_fees'?: number;
|
|
24
40
|
'expiration_time'?: string;
|
|
25
41
|
'created_time'?: string;
|
|
26
42
|
'updated_time'?: string;
|
|
@@ -5,19 +5,29 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ticker** | **string** | Market ticker | [default to undefined]
|
|
9
|
+
**side** | **string** | Side of the order | [default to undefined]
|
|
10
|
+
**action** | **string** | Buy or sell action | [default to undefined]
|
|
8
11
|
**yes_price** | **number** | | [optional] [default to undefined]
|
|
9
12
|
**no_price** | **number** | | [optional] [default to undefined]
|
|
10
13
|
**count** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**client_order_id** | **string** | Current client order ID | [default to undefined]
|
|
15
|
+
**updated_client_order_id** | **string** | New client order ID after amendment | [default to undefined]
|
|
11
16
|
|
|
12
17
|
## Example
|
|
13
18
|
|
|
14
19
|
```typescript
|
|
15
|
-
import { AmendOrderRequest } from '
|
|
20
|
+
import { AmendOrderRequest } from 'kalshi-typescript';
|
|
16
21
|
|
|
17
22
|
const instance: AmendOrderRequest = {
|
|
23
|
+
ticker,
|
|
24
|
+
side,
|
|
25
|
+
action,
|
|
18
26
|
yes_price,
|
|
19
27
|
no_price,
|
|
20
28
|
count,
|
|
29
|
+
client_order_id,
|
|
30
|
+
updated_client_order_id,
|
|
21
31
|
};
|
|
22
32
|
```
|
|
23
33
|
|
package/docs/Announcement.md
CHANGED
package/docs/ApiKey.md
CHANGED
package/docs/ApiKeysApi.md
CHANGED
|
@@ -21,9 +21,12 @@ import {
|
|
|
21
21
|
ApiKeysApi,
|
|
22
22
|
Configuration,
|
|
23
23
|
CreateApiKeyRequest
|
|
24
|
-
} from '
|
|
24
|
+
} from 'kalshi-typescript';
|
|
25
25
|
|
|
26
|
-
const configuration = new Configuration(
|
|
26
|
+
const configuration = new Configuration({
|
|
27
|
+
apiKey: 'your-api-key-id',
|
|
28
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
29
|
+
});
|
|
27
30
|
const apiInstance = new ApiKeysApi(configuration);
|
|
28
31
|
|
|
29
32
|
let createApiKeyRequest: CreateApiKeyRequest; //
|
|
@@ -76,9 +79,12 @@ Delete an existing API key. This endpoint permanently deletes an API key. Once
|
|
|
76
79
|
import {
|
|
77
80
|
ApiKeysApi,
|
|
78
81
|
Configuration
|
|
79
|
-
} from '
|
|
82
|
+
} from 'kalshi-typescript';
|
|
80
83
|
|
|
81
|
-
const configuration = new Configuration(
|
|
84
|
+
const configuration = new Configuration({
|
|
85
|
+
apiKey: 'your-api-key-id',
|
|
86
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
87
|
+
});
|
|
82
88
|
const apiInstance = new ApiKeysApi(configuration);
|
|
83
89
|
|
|
84
90
|
let apiKey: string; //API key ID to delete (default to undefined)
|
|
@@ -132,9 +138,12 @@ import {
|
|
|
132
138
|
ApiKeysApi,
|
|
133
139
|
Configuration,
|
|
134
140
|
GenerateApiKeyRequest
|
|
135
|
-
} from '
|
|
141
|
+
} from 'kalshi-typescript';
|
|
136
142
|
|
|
137
|
-
const configuration = new Configuration(
|
|
143
|
+
const configuration = new Configuration({
|
|
144
|
+
apiKey: 'your-api-key-id',
|
|
145
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
146
|
+
});
|
|
138
147
|
const apiInstance = new ApiKeysApi(configuration);
|
|
139
148
|
|
|
140
149
|
let generateApiKeyRequest: GenerateApiKeyRequest; //
|
|
@@ -186,9 +195,12 @@ Retrieve all API keys associated with the authenticated user. API keys allow pr
|
|
|
186
195
|
import {
|
|
187
196
|
ApiKeysApi,
|
|
188
197
|
Configuration
|
|
189
|
-
} from '
|
|
198
|
+
} from 'kalshi-typescript';
|
|
190
199
|
|
|
191
|
-
const configuration = new Configuration(
|
|
200
|
+
const configuration = new Configuration({
|
|
201
|
+
apiKey: 'your-api-key-id',
|
|
202
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
203
|
+
});
|
|
192
204
|
const apiInstance = new ApiKeysApi(configuration);
|
|
193
205
|
|
|
194
206
|
const { status, data } = await apiInstance.getApiKeys();
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import { BatchCancelOrdersRequest } from '
|
|
13
|
+
import { BatchCancelOrdersRequest } from 'kalshi-typescript';
|
|
14
14
|
|
|
15
15
|
const instance: BatchCancelOrdersRequest = {
|
|
16
16
|
order_ids,
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import { BatchCancelOrdersResponse } from '
|
|
13
|
+
import { BatchCancelOrdersResponse } from 'kalshi-typescript';
|
|
14
14
|
|
|
15
15
|
const instance: BatchCancelOrdersResponse = {
|
|
16
16
|
responses,
|
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import { BatchCancelOrdersResponseResponsesInner } from '
|
|
15
|
+
import { BatchCancelOrdersResponseResponsesInner } from 'kalshi-typescript';
|
|
16
16
|
|
|
17
17
|
const instance: BatchCancelOrdersResponseResponsesInner = {
|
|
18
18
|
order_id,
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import { BatchCreateOrdersRequest } from '
|
|
13
|
+
import { BatchCreateOrdersRequest } from 'kalshi-typescript';
|
|
14
14
|
|
|
15
15
|
const instance: BatchCreateOrdersRequest = {
|
|
16
16
|
orders,
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import { BatchCreateOrdersResponse } from '
|
|
13
|
+
import { BatchCreateOrdersResponse } from 'kalshi-typescript';
|
|
14
14
|
|
|
15
15
|
const instance: BatchCreateOrdersResponse = {
|
|
16
16
|
responses,
|
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import { BatchCreateOrdersResponseResponsesInner } from '
|
|
14
|
+
import { BatchCreateOrdersResponseResponsesInner } from 'kalshi-typescript';
|
|
15
15
|
|
|
16
16
|
const instance: BatchCreateOrdersResponseResponsesInner = {
|
|
17
17
|
order,
|
package/docs/Candlestick.md
CHANGED
|
@@ -28,9 +28,12 @@ import {
|
|
|
28
28
|
CommunicationsApi,
|
|
29
29
|
Configuration,
|
|
30
30
|
AcceptQuoteRequest
|
|
31
|
-
} from '
|
|
31
|
+
} from 'kalshi-typescript';
|
|
32
32
|
|
|
33
|
-
const configuration = new Configuration(
|
|
33
|
+
const configuration = new Configuration({
|
|
34
|
+
apiKey: 'your-api-key-id',
|
|
35
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
36
|
+
});
|
|
34
37
|
const apiInstance = new CommunicationsApi(configuration);
|
|
35
38
|
|
|
36
39
|
let quoteId: string; //Quote ID (default to undefined)
|
|
@@ -86,9 +89,12 @@ Confirm a quote. This will start a timer for order execution
|
|
|
86
89
|
import {
|
|
87
90
|
CommunicationsApi,
|
|
88
91
|
Configuration
|
|
89
|
-
} from '
|
|
92
|
+
} from 'kalshi-typescript';
|
|
90
93
|
|
|
91
|
-
const configuration = new Configuration(
|
|
94
|
+
const configuration = new Configuration({
|
|
95
|
+
apiKey: 'your-api-key-id',
|
|
96
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
97
|
+
});
|
|
92
98
|
const apiInstance = new CommunicationsApi(configuration);
|
|
93
99
|
|
|
94
100
|
let quoteId: string; //Quote ID (default to undefined)
|
|
@@ -141,9 +147,12 @@ import {
|
|
|
141
147
|
CommunicationsApi,
|
|
142
148
|
Configuration,
|
|
143
149
|
CreateQuoteRequest
|
|
144
|
-
} from '
|
|
150
|
+
} from 'kalshi-typescript';
|
|
145
151
|
|
|
146
|
-
const configuration = new Configuration(
|
|
152
|
+
const configuration = new Configuration({
|
|
153
|
+
apiKey: 'your-api-key-id',
|
|
154
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
155
|
+
});
|
|
147
156
|
const apiInstance = new CommunicationsApi(configuration);
|
|
148
157
|
|
|
149
158
|
let createQuoteRequest: CreateQuoteRequest; //
|
|
@@ -196,9 +205,12 @@ import {
|
|
|
196
205
|
CommunicationsApi,
|
|
197
206
|
Configuration,
|
|
198
207
|
CreateRFQRequest
|
|
199
|
-
} from '
|
|
208
|
+
} from 'kalshi-typescript';
|
|
200
209
|
|
|
201
|
-
const configuration = new Configuration(
|
|
210
|
+
const configuration = new Configuration({
|
|
211
|
+
apiKey: 'your-api-key-id',
|
|
212
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
213
|
+
});
|
|
202
214
|
const apiInstance = new CommunicationsApi(configuration);
|
|
203
215
|
|
|
204
216
|
let createRFQRequest: CreateRFQRequest; //
|
|
@@ -250,9 +262,12 @@ Delete a quote, which means it can no longer be accepted
|
|
|
250
262
|
import {
|
|
251
263
|
CommunicationsApi,
|
|
252
264
|
Configuration
|
|
253
|
-
} from '
|
|
265
|
+
} from 'kalshi-typescript';
|
|
254
266
|
|
|
255
|
-
const configuration = new Configuration(
|
|
267
|
+
const configuration = new Configuration({
|
|
268
|
+
apiKey: 'your-api-key-id',
|
|
269
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
270
|
+
});
|
|
256
271
|
const apiInstance = new CommunicationsApi(configuration);
|
|
257
272
|
|
|
258
273
|
let quoteId: string; //Quote ID (default to undefined)
|
|
@@ -304,9 +319,12 @@ Delete an RFQ by ID
|
|
|
304
319
|
import {
|
|
305
320
|
CommunicationsApi,
|
|
306
321
|
Configuration
|
|
307
|
-
} from '
|
|
322
|
+
} from 'kalshi-typescript';
|
|
308
323
|
|
|
309
|
-
const configuration = new Configuration(
|
|
324
|
+
const configuration = new Configuration({
|
|
325
|
+
apiKey: 'your-api-key-id',
|
|
326
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
327
|
+
});
|
|
310
328
|
const apiInstance = new CommunicationsApi(configuration);
|
|
311
329
|
|
|
312
330
|
let rfqId: string; //RFQ ID (default to undefined)
|
|
@@ -358,9 +376,12 @@ Get the communications ID of the logged-in user
|
|
|
358
376
|
import {
|
|
359
377
|
CommunicationsApi,
|
|
360
378
|
Configuration
|
|
361
|
-
} from '
|
|
379
|
+
} from 'kalshi-typescript';
|
|
362
380
|
|
|
363
|
-
const configuration = new Configuration(
|
|
381
|
+
const configuration = new Configuration({
|
|
382
|
+
apiKey: 'your-api-key-id',
|
|
383
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
384
|
+
});
|
|
364
385
|
const apiInstance = new CommunicationsApi(configuration);
|
|
365
386
|
|
|
366
387
|
const { status, data } = await apiInstance.getCommunicationsID();
|
|
@@ -404,9 +425,12 @@ Get a particular quote by ID
|
|
|
404
425
|
import {
|
|
405
426
|
CommunicationsApi,
|
|
406
427
|
Configuration
|
|
407
|
-
} from '
|
|
428
|
+
} from 'kalshi-typescript';
|
|
408
429
|
|
|
409
|
-
const configuration = new Configuration(
|
|
430
|
+
const configuration = new Configuration({
|
|
431
|
+
apiKey: 'your-api-key-id',
|
|
432
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
433
|
+
});
|
|
410
434
|
const apiInstance = new CommunicationsApi(configuration);
|
|
411
435
|
|
|
412
436
|
let quoteId: string; //Quote ID (default to undefined)
|
|
@@ -458,9 +482,12 @@ Retrieve all quotes
|
|
|
458
482
|
import {
|
|
459
483
|
CommunicationsApi,
|
|
460
484
|
Configuration
|
|
461
|
-
} from '
|
|
485
|
+
} from 'kalshi-typescript';
|
|
462
486
|
|
|
463
|
-
const configuration = new Configuration(
|
|
487
|
+
const configuration = new Configuration({
|
|
488
|
+
apiKey: 'your-api-key-id',
|
|
489
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
490
|
+
});
|
|
464
491
|
const apiInstance = new CommunicationsApi(configuration);
|
|
465
492
|
|
|
466
493
|
const { status, data } = await apiInstance.getQuotes();
|
|
@@ -504,9 +531,12 @@ Get a single RFQ by ID
|
|
|
504
531
|
import {
|
|
505
532
|
CommunicationsApi,
|
|
506
533
|
Configuration
|
|
507
|
-
} from '
|
|
534
|
+
} from 'kalshi-typescript';
|
|
508
535
|
|
|
509
|
-
const configuration = new Configuration(
|
|
536
|
+
const configuration = new Configuration({
|
|
537
|
+
apiKey: 'your-api-key-id',
|
|
538
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
539
|
+
});
|
|
510
540
|
const apiInstance = new CommunicationsApi(configuration);
|
|
511
541
|
|
|
512
542
|
let rfqId: string; //RFQ ID (default to undefined)
|
|
@@ -558,9 +588,12 @@ Retrieve all RFQs
|
|
|
558
588
|
import {
|
|
559
589
|
CommunicationsApi,
|
|
560
590
|
Configuration
|
|
561
|
-
} from '
|
|
591
|
+
} from 'kalshi-typescript';
|
|
562
592
|
|
|
563
|
-
const configuration = new Configuration(
|
|
593
|
+
const configuration = new Configuration({
|
|
594
|
+
apiKey: 'your-api-key-id',
|
|
595
|
+
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
596
|
+
});
|
|
564
597
|
const apiInstance = new CommunicationsApi(configuration);
|
|
565
598
|
|
|
566
599
|
const { status, data } = await apiInstance.getRFQs();
|