UNPKG

kalshi-typescript

Version:

Official TypeScript SDK for the Kalshi API

kalshi.com/docs/api

296 lines (264 loc) • 20.5 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
## kalshi-typescript@3.6.0 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: Environment * Node.js * Webpack * Browserify Language level * ES5 - you must have a Promises/A+ library installed * ES6 Module system * CommonJS * ES6 module system It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) ### Building To build and compile the typescript sources to javascript use: ``` npm install npm run build ``` ### Publishing First build the package then run `npm publish` ### Consuming navigate to the folder of your consuming project and run one of the following commands. _published:_ ``` npm install kalshi-typescript@3.6.0 --save ``` _unPublished (not recommended):_ ``` npm install PATH_TO_GENERATED_PACKAGE --save ``` ### Documentation for API Endpoints All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AccountApi* | [**getAccountApiLimits**](docs/AccountApi.md#getaccountapilimits) | **GET** /account/limits | Get Account API Limits *ApiKeysApi* | [**createApiKey**](docs/ApiKeysApi.md#createapikey) | **POST** /api_keys | Create API Key *ApiKeysApi* | [**deleteApiKey**](docs/ApiKeysApi.md#deleteapikey) | **DELETE** /api_keys/{api_key} | Delete API Key *ApiKeysApi* | [**generateApiKey**](docs/ApiKeysApi.md#generateapikey) | **POST** /api_keys/generate | Generate API Key *ApiKeysApi* | [**getApiKeys**](docs/ApiKeysApi.md#getapikeys) | **GET** /api_keys | Get API Keys *CommunicationsApi* | [**acceptQuote**](docs/CommunicationsApi.md#acceptquote) | **PUT** /communications/quotes/{quote_id}/accept | Accept Quote *CommunicationsApi* | [**confirmQuote**](docs/CommunicationsApi.md#confirmquote) | **PUT** /communications/quotes/{quote_id}/confirm | Confirm Quote *CommunicationsApi* | [**createQuote**](docs/CommunicationsApi.md#createquote) | **POST** /communications/quotes | Create Quote *CommunicationsApi* | [**createRFQ**](docs/CommunicationsApi.md#createrfq) | **POST** /communications/rfqs | Create RFQ *CommunicationsApi* | [**deleteQuote**](docs/CommunicationsApi.md#deletequote) | **DELETE** /communications/quotes/{quote_id} | Delete Quote *CommunicationsApi* | [**deleteRFQ**](docs/CommunicationsApi.md#deleterfq) | **DELETE** /communications/rfqs/{rfq_id} | Delete RFQ *CommunicationsApi* | [**getCommunicationsID**](docs/CommunicationsApi.md#getcommunicationsid) | **GET** /communications/id | Get Communications ID *CommunicationsApi* | [**getQuote**](docs/CommunicationsApi.md#getquote) | **GET** /communications/quotes/{quote_id} | Get Quote *CommunicationsApi* | [**getQuotes**](docs/CommunicationsApi.md#getquotes) | **GET** /communications/quotes | Get Quotes *CommunicationsApi* | [**getRFQ**](docs/CommunicationsApi.md#getrfq) | **GET** /communications/rfqs/{rfq_id} | Get RFQ *CommunicationsApi* | [**getRFQs**](docs/CommunicationsApi.md#getrfqs) | **GET** /communications/rfqs | Get RFQs *EventsApi* | [**getEvent**](docs/EventsApi.md#getevent) | **GET** /events/{event_ticker} | Get Event *EventsApi* | [**getEventForecastPercentilesHistory**](docs/EventsApi.md#geteventforecastpercentileshistory) | **GET** /series/{series_ticker}/events/{ticker}/forecast_percentile_history | Get Event Forecast Percentile History *EventsApi* | [**getEventMetadata**](docs/EventsApi.md#geteventmetadata) | **GET** /events/{event_ticker}/metadata | Get Event Metadata *EventsApi* | [**getEvents**](docs/EventsApi.md#getevents) | **GET** /events | Get Events *EventsApi* | [**getMarketCandlesticksByEvent**](docs/EventsApi.md#getmarketcandlesticksbyevent) | **GET** /series/{series_ticker}/events/{ticker}/candlesticks | Get Event Candlesticks *EventsApi* | [**getMultivariateEvents**](docs/EventsApi.md#getmultivariateevents) | **GET** /events/multivariate | Get Multivariate Events *ExchangeApi* | [**getExchangeAnnouncements**](docs/ExchangeApi.md#getexchangeannouncements) | **GET** /exchange/announcements | Get Exchange Announcements *ExchangeApi* | [**getExchangeSchedule**](docs/ExchangeApi.md#getexchangeschedule) | **GET** /exchange/schedule | Get Exchange Schedule *ExchangeApi* | [**getExchangeStatus**](docs/ExchangeApi.md#getexchangestatus) | **GET** /exchange/status | Get Exchange Status *ExchangeApi* | [**getSeriesFeeChanges**](docs/ExchangeApi.md#getseriesfeechanges) | **GET** /series/fee_changes | Get Series Fee Changes *ExchangeApi* | [**getUserDataTimestamp**](docs/ExchangeApi.md#getuserdatatimestamp) | **GET** /exchange/user_data_timestamp | Get User Data Timestamp *FcmApi* | [**getFCMOrders**](docs/FcmApi.md#getfcmorders) | **GET** /fcm/orders | Get FCM Orders *FcmApi* | [**getFCMPositions**](docs/FcmApi.md#getfcmpositions) | **GET** /fcm/positions | Get FCM Positions *IncentiveProgramsApi* | [**getIncentivePrograms**](docs/IncentiveProgramsApi.md#getincentiveprograms) | **GET** /incentive_programs | Get Incentives *LiveDataApi* | [**getLiveData**](docs/LiveDataApi.md#getlivedata) | **GET** /live_data/{type}/milestone/{milestone_id} | Get Live Data *LiveDataApi* | [**getLiveDatas**](docs/LiveDataApi.md#getlivedatas) | **GET** /live_data/batch | Get Multiple Live Data *MarketApi* | [**batchGetMarketCandlesticks**](docs/MarketApi.md#batchgetmarketcandlesticks) | **GET** /markets/candlesticks | Batch Get Market Candlesticks *MarketApi* | [**getMarket**](docs/MarketApi.md#getmarket) | **GET** /markets/{ticker} | Get Market *MarketApi* | [**getMarketCandlesticks**](docs/MarketApi.md#getmarketcandlesticks) | **GET** /series/{series_ticker}/markets/{ticker}/candlesticks | Get Market Candlesticks *MarketApi* | [**getMarketOrderbook**](docs/MarketApi.md#getmarketorderbook) | **GET** /markets/{ticker}/orderbook | Get Market Orderbook *MarketApi* | [**getMarkets**](docs/MarketApi.md#getmarkets) | **GET** /markets | Get Markets *MarketApi* | [**getSeries**](docs/MarketApi.md#getseries) | **GET** /series/{series_ticker} | Get Series *MarketApi* | [**getSeriesList**](docs/MarketApi.md#getserieslist) | **GET** /series | Get Series List *MarketApi* | [**getTrades**](docs/MarketApi.md#gettrades) | **GET** /markets/trades | Get Trades *MilestoneApi* | [**getMilestone**](docs/MilestoneApi.md#getmilestone) | **GET** /milestones/{milestone_id} | Get Milestone *MilestoneApi* | [**getMilestones**](docs/MilestoneApi.md#getmilestones) | **GET** /milestones | Get Milestones *MultivariateApi* | [**createMarketInMultivariateEventCollection**](docs/MultivariateApi.md#createmarketinmultivariateeventcollection) | **POST** /multivariate_event_collections/{collection_ticker} | Create Market In Multivariate Event Collection *MultivariateApi* | [**getMultivariateEventCollection**](docs/MultivariateApi.md#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection *MultivariateApi* | [**getMultivariateEventCollectionLookupHistory**](docs/MultivariateApi.md#getmultivariateeventcollectionlookuphistory) | **GET** /multivariate_event_collections/{collection_ticker}/lookup | Get Multivariate Event Collection Lookup History *MultivariateApi* | [**getMultivariateEventCollections**](docs/MultivariateApi.md#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections *MultivariateApi* | [**lookupTickersForMarketInMultivariateEventCollection**](docs/MultivariateApi.md#lookuptickersformarketinmultivariateeventcollection) | **PUT** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Tickers For Market In Multivariate Event Collection *OrderGroupsApi* | [**createOrderGroup**](docs/OrderGroupsApi.md#createordergroup) | **POST** /portfolio/order_groups/create | Create Order Group *OrderGroupsApi* | [**deleteOrderGroup**](docs/OrderGroupsApi.md#deleteordergroup) | **DELETE** /portfolio/order_groups/{order_group_id} | Delete Order Group *OrderGroupsApi* | [**getOrderGroup**](docs/OrderGroupsApi.md#getordergroup) | **GET** /portfolio/order_groups/{order_group_id} | Get Order Group *OrderGroupsApi* | [**getOrderGroups**](docs/OrderGroupsApi.md#getordergroups) | **GET** /portfolio/order_groups | Get Order Groups *OrderGroupsApi* | [**resetOrderGroup**](docs/OrderGroupsApi.md#resetordergroup) | **PUT** /portfolio/order_groups/{order_group_id}/reset | Reset Order Group *OrderGroupsApi* | [**triggerOrderGroup**](docs/OrderGroupsApi.md#triggerordergroup) | **PUT** /portfolio/order_groups/{order_group_id}/trigger | Trigger Order Group *OrderGroupsApi* | [**updateOrderGroupLimit**](docs/OrderGroupsApi.md#updateordergrouplimit) | **PUT** /portfolio/order_groups/{order_group_id}/limit | Update Order Group Limit *OrdersApi* | [**amendOrder**](docs/OrdersApi.md#amendorder) | **POST** /portfolio/orders/{order_id}/amend | Amend Order *OrdersApi* | [**batchCancelOrders**](docs/OrdersApi.md#batchcancelorders) | **DELETE** /portfolio/orders/batched | Batch Cancel Orders *OrdersApi* | [**batchCreateOrders**](docs/OrdersApi.md#batchcreateorders) | **POST** /portfolio/orders/batched | Batch Create Orders *OrdersApi* | [**cancelOrder**](docs/OrdersApi.md#cancelorder) | **DELETE** /portfolio/orders/{order_id} | Cancel Order *OrdersApi* | [**createOrder**](docs/OrdersApi.md#createorder) | **POST** /portfolio/orders | Create Order *OrdersApi* | [**decreaseOrder**](docs/OrdersApi.md#decreaseorder) | **POST** /portfolio/orders/{order_id}/decrease | Decrease Order *OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /portfolio/orders/{order_id} | Get Order *OrdersApi* | [**getOrderQueuePosition**](docs/OrdersApi.md#getorderqueueposition) | **GET** /portfolio/orders/{order_id}/queue_position | Get Order Queue Position *OrdersApi* | [**getOrderQueuePositions**](docs/OrdersApi.md#getorderqueuepositions) | **GET** /portfolio/orders/queue_positions | Get Queue Positions for Orders *OrdersApi* | [**getOrders**](docs/OrdersApi.md#getorders) | **GET** /portfolio/orders | Get Orders *PortfolioApi* | [**applySubaccountTransfer**](docs/PortfolioApi.md#applysubaccounttransfer) | **POST** /portfolio/subaccounts/transfer | Transfer Between Subaccounts *PortfolioApi* | [**createSubaccount**](docs/PortfolioApi.md#createsubaccount) | **POST** /portfolio/subaccounts | Create Subaccount *PortfolioApi* | [**getBalance**](docs/PortfolioApi.md#getbalance) | **GET** /portfolio/balance | Get Balance *PortfolioApi* | [**getFills**](docs/PortfolioApi.md#getfills) | **GET** /portfolio/fills | Get Fills *PortfolioApi* | [**getPortfolioRestingOrderTotalValue**](docs/PortfolioApi.md#getportfoliorestingordertotalvalue) | **GET** /portfolio/summary/total_resting_order_value | Get Total Resting Order Value *PortfolioApi* | [**getPositions**](docs/PortfolioApi.md#getpositions) | **GET** /portfolio/positions | Get Positions *PortfolioApi* | [**getSettlements**](docs/PortfolioApi.md#getsettlements) | **GET** /portfolio/settlements | Get Settlements *PortfolioApi* | [**getSubaccountBalances**](docs/PortfolioApi.md#getsubaccountbalances) | **GET** /portfolio/subaccounts/balances | Get All Subaccount Balances *PortfolioApi* | [**getSubaccountTransfers**](docs/PortfolioApi.md#getsubaccounttransfers) | **GET** /portfolio/subaccounts/transfers | Get Subaccount Transfers *SearchApi* | [**getFiltersForSports**](docs/SearchApi.md#getfiltersforsports) | **GET** /search/filters_by_sport | Get Filters for Sports *SearchApi* | [**getTagsForSeriesCategories**](docs/SearchApi.md#gettagsforseriescategories) | **GET** /search/tags_by_categories | Get Tags for Series Categories *StructuredTargetsApi* | [**getStructuredTarget**](docs/StructuredTargetsApi.md#getstructuredtarget) | **GET** /structured_targets/{structured_target_id} | Get Structured Target *StructuredTargetsApi* | [**getStructuredTargets**](docs/StructuredTargetsApi.md#getstructuredtargets) | **GET** /structured_targets | Get Structured Targets ### Documentation For Models - [AcceptQuoteRequest](docs/AcceptQuoteRequest.md) - [AmendOrderRequest](docs/AmendOrderRequest.md) - [AmendOrderResponse](docs/AmendOrderResponse.md) - [Announcement](docs/Announcement.md) - [ApiKey](docs/ApiKey.md) - [ApplySubaccountTransferRequest](docs/ApplySubaccountTransferRequest.md) - [AssociatedEvent](docs/AssociatedEvent.md) - [BatchCancelOrdersIndividualResponse](docs/BatchCancelOrdersIndividualResponse.md) - [BatchCancelOrdersRequest](docs/BatchCancelOrdersRequest.md) - [BatchCancelOrdersRequestOrder](docs/BatchCancelOrdersRequestOrder.md) - [BatchCancelOrdersResponse](docs/BatchCancelOrdersResponse.md) - [BatchCreateOrdersIndividualResponse](docs/BatchCreateOrdersIndividualResponse.md) - [BatchCreateOrdersRequest](docs/BatchCreateOrdersRequest.md) - [BatchCreateOrdersResponse](docs/BatchCreateOrdersResponse.md) - [BatchGetMarketCandlesticksResponse](docs/BatchGetMarketCandlesticksResponse.md) - [BidAskDistribution](docs/BidAskDistribution.md) - [CancelOrderResponse](docs/CancelOrderResponse.md) - [CreateApiKeyRequest](docs/CreateApiKeyRequest.md) - [CreateApiKeyResponse](docs/CreateApiKeyResponse.md) - [CreateMarketInMultivariateEventCollectionRequest](docs/CreateMarketInMultivariateEventCollectionRequest.md) - [CreateMarketInMultivariateEventCollectionResponse](docs/CreateMarketInMultivariateEventCollectionResponse.md) - [CreateOrderGroupRequest](docs/CreateOrderGroupRequest.md) - [CreateOrderGroupResponse](docs/CreateOrderGroupResponse.md) - [CreateOrderRequest](docs/CreateOrderRequest.md) - [CreateOrderResponse](docs/CreateOrderResponse.md) - [CreateQuoteRequest](docs/CreateQuoteRequest.md) - [CreateQuoteResponse](docs/CreateQuoteResponse.md) - [CreateRFQRequest](docs/CreateRFQRequest.md) - [CreateRFQResponse](docs/CreateRFQResponse.md) - [CreateSubaccountResponse](docs/CreateSubaccountResponse.md) - [DailySchedule](docs/DailySchedule.md) - [DecreaseOrderRequest](docs/DecreaseOrderRequest.md) - [DecreaseOrderResponse](docs/DecreaseOrderResponse.md) - [ErrorResponse](docs/ErrorResponse.md) - [EventData](docs/EventData.md) - [EventPosition](docs/EventPosition.md) - [ExchangeInstance](docs/ExchangeInstance.md) - [ExchangeStatus](docs/ExchangeStatus.md) - [Fill](docs/Fill.md) - [ForecastPercentilesPoint](docs/ForecastPercentilesPoint.md) - [GenerateApiKeyRequest](docs/GenerateApiKeyRequest.md) - [GenerateApiKeyResponse](docs/GenerateApiKeyResponse.md) - [GetAccountApiLimitsResponse](docs/GetAccountApiLimitsResponse.md) - [GetApiKeysResponse](docs/GetApiKeysResponse.md) - [GetBalanceResponse](docs/GetBalanceResponse.md) - [GetCommunicationsIDResponse](docs/GetCommunicationsIDResponse.md) - [GetEventCandlesticksResponse](docs/GetEventCandlesticksResponse.md) - [GetEventForecastPercentilesHistoryResponse](docs/GetEventForecastPercentilesHistoryResponse.md) - [GetEventMetadataResponse](docs/GetEventMetadataResponse.md) - [GetEventResponse](docs/GetEventResponse.md) - [GetEventsResponse](docs/GetEventsResponse.md) - [GetExchangeAnnouncementsResponse](docs/GetExchangeAnnouncementsResponse.md) - [GetExchangeScheduleResponse](docs/GetExchangeScheduleResponse.md) - [GetFillsResponse](docs/GetFillsResponse.md) - [GetFiltersBySportsResponse](docs/GetFiltersBySportsResponse.md) - [GetIncentiveProgramsResponse](docs/GetIncentiveProgramsResponse.md) - [GetLiveDataResponse](docs/GetLiveDataResponse.md) - [GetLiveDatasResponse](docs/GetLiveDatasResponse.md) - [GetMarketCandlesticksResponse](docs/GetMarketCandlesticksResponse.md) - [GetMarketOrderbookResponse](docs/GetMarketOrderbookResponse.md) - [GetMarketResponse](docs/GetMarketResponse.md) - [GetMarketsResponse](docs/GetMarketsResponse.md) - [GetMilestoneResponse](docs/GetMilestoneResponse.md) - [GetMilestonesResponse](docs/GetMilestonesResponse.md) - [GetMultivariateEventCollectionLookupHistoryResponse](docs/GetMultivariateEventCollectionLookupHistoryResponse.md) - [GetMultivariateEventCollectionResponse](docs/GetMultivariateEventCollectionResponse.md) - [GetMultivariateEventCollectionsResponse](docs/GetMultivariateEventCollectionsResponse.md) - [GetMultivariateEventsResponse](docs/GetMultivariateEventsResponse.md) - [GetOrderGroupResponse](docs/GetOrderGroupResponse.md) - [GetOrderGroupsResponse](docs/GetOrderGroupsResponse.md) - [GetOrderQueuePositionResponse](docs/GetOrderQueuePositionResponse.md) - [GetOrderQueuePositionsResponse](docs/GetOrderQueuePositionsResponse.md) - [GetOrderResponse](docs/GetOrderResponse.md) - [GetOrdersResponse](docs/GetOrdersResponse.md) - [GetPortfolioRestingOrderTotalValueResponse](docs/GetPortfolioRestingOrderTotalValueResponse.md) - [GetPositionsResponse](docs/GetPositionsResponse.md) - [GetQuoteResponse](docs/GetQuoteResponse.md) - [GetQuotesResponse](docs/GetQuotesResponse.md) - [GetRFQResponse](docs/GetRFQResponse.md) - [GetRFQsResponse](docs/GetRFQsResponse.md) - [GetSeriesFeeChangesResponse](docs/GetSeriesFeeChangesResponse.md) - [GetSeriesListResponse](docs/GetSeriesListResponse.md) - [GetSeriesResponse](docs/GetSeriesResponse.md) - [GetSettlementsResponse](docs/GetSettlementsResponse.md) - [GetStructuredTargetResponse](docs/GetStructuredTargetResponse.md) - [GetStructuredTargetsResponse](docs/GetStructuredTargetsResponse.md) - [GetSubaccountBalancesResponse](docs/GetSubaccountBalancesResponse.md) - [GetSubaccountTransfersResponse](docs/GetSubaccountTransfersResponse.md) - [GetTagsForSeriesCategoriesResponse](docs/GetTagsForSeriesCategoriesResponse.md) - [GetTradesResponse](docs/GetTradesResponse.md) - [GetUserDataTimestampResponse](docs/GetUserDataTimestampResponse.md) - [IncentiveProgram](docs/IncentiveProgram.md) - [IntraExchangeInstanceTransferRequest](docs/IntraExchangeInstanceTransferRequest.md) - [IntraExchangeInstanceTransferResponse](docs/IntraExchangeInstanceTransferResponse.md) - [LiveData](docs/LiveData.md) - [LookupPoint](docs/LookupPoint.md) - [LookupTickersForMarketInMultivariateEventCollectionRequest](docs/LookupTickersForMarketInMultivariateEventCollectionRequest.md) - [LookupTickersForMarketInMultivariateEventCollectionResponse](docs/LookupTickersForMarketInMultivariateEventCollectionResponse.md) - [MaintenanceWindow](docs/MaintenanceWindow.md) - [Market](docs/Market.md) - [MarketCandlestick](docs/MarketCandlestick.md) - [MarketCandlesticksResponse](docs/MarketCandlesticksResponse.md) - [MarketMetadata](docs/MarketMetadata.md) - [MarketPosition](docs/MarketPosition.md) - [Milestone](docs/Milestone.md) - [MultivariateEventCollection](docs/MultivariateEventCollection.md) - [MveSelectedLeg](docs/MveSelectedLeg.md) - [Order](docs/Order.md) - [OrderGroup](docs/OrderGroup.md) - [OrderQueuePosition](docs/OrderQueuePosition.md) - [OrderStatus](docs/OrderStatus.md) - [Orderbook](docs/Orderbook.md) - [OrderbookCountFp](docs/OrderbookCountFp.md) - [PercentilePoint](docs/PercentilePoint.md) - [PriceDistribution](docs/PriceDistribution.md) - [PriceRange](docs/PriceRange.md) - [Quote](docs/Quote.md) - [RFQ](docs/RFQ.md) - [Schedule](docs/Schedule.md) - [ScopeList](docs/ScopeList.md) - [SelfTradePreventionType](docs/SelfTradePreventionType.md) - [Series](docs/Series.md) - [SeriesFeeChange](docs/SeriesFeeChange.md) - [Settlement](docs/Settlement.md) - [SettlementSource](docs/SettlementSource.md) - [SportFilterDetails](docs/SportFilterDetails.md) - [StructuredTarget](docs/StructuredTarget.md) - [SubaccountBalance](docs/SubaccountBalance.md) - [SubaccountTransfer](docs/SubaccountTransfer.md) - [TickerPair](docs/TickerPair.md) - [Trade](docs/Trade.md) - [UpdateOrderGroupLimitRequest](docs/UpdateOrderGroupLimitRequest.md) - [WeeklySchedule](docs/WeeklySchedule.md) <a id="documentation-for-authorization"></a> ## Documentation For Authorization Authentication schemes defined for the API: <a id="kalshiAccessKey"></a> ### kalshiAccessKey - **Type**: API key - **API key parameter name**: KALSHI-ACCESS-KEY - **Location**: HTTP header <a id="kalshiAccessSignature"></a> ### kalshiAccessSignature - **Type**: API key - **API key parameter name**: KALSHI-ACCESS-SIGNATURE - **Location**: HTTP header <a id="kalshiAccessTimestamp"></a> ### kalshiAccessTimestamp - **Type**: API key - **API key parameter name**: KALSHI-ACCESS-TIMESTAMP - **Location**: HTTP header