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/.openapi-generator/FILES
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
.gitignore
|
|
2
2
|
.npmignore
|
|
3
|
-
.openapi-generator-ignore
|
|
4
3
|
README.md
|
|
5
4
|
api.ts
|
|
6
5
|
api/api-keys-api.ts
|
|
@@ -47,6 +46,7 @@ docs/DecreaseOrderResponse.md
|
|
|
47
46
|
docs/ErrorResponse.md
|
|
48
47
|
docs/ErrorResponseError.md
|
|
49
48
|
docs/Event.md
|
|
49
|
+
docs/EventPosition.md
|
|
50
50
|
docs/EventsApi.md
|
|
51
51
|
docs/ExchangeApi.md
|
|
52
52
|
docs/ExchangeStatus.md
|
|
@@ -72,6 +72,7 @@ docs/GetMilestoneResponse.md
|
|
|
72
72
|
docs/GetMilestonesResponse.md
|
|
73
73
|
docs/GetMultivariateEventCollectionResponse.md
|
|
74
74
|
docs/GetMultivariateEventCollectionsResponse.md
|
|
75
|
+
docs/GetOrderGroupResponse.md
|
|
75
76
|
docs/GetOrderGroupsResponse.md
|
|
76
77
|
docs/GetOrderQueuePositionResponse.md
|
|
77
78
|
docs/GetOrderResponse.md
|
|
@@ -144,6 +145,7 @@ models/decrease-order-request.ts
|
|
|
144
145
|
models/decrease-order-response.ts
|
|
145
146
|
models/error-response-error.ts
|
|
146
147
|
models/error-response.ts
|
|
148
|
+
models/event-position.ts
|
|
147
149
|
models/event.ts
|
|
148
150
|
models/exchange-status.ts
|
|
149
151
|
models/fill.ts
|
|
@@ -168,6 +170,7 @@ models/get-milestone-response.ts
|
|
|
168
170
|
models/get-milestones-response.ts
|
|
169
171
|
models/get-multivariate-event-collection-response.ts
|
|
170
172
|
models/get-multivariate-event-collections-response.ts
|
|
173
|
+
models/get-order-group-response.ts
|
|
171
174
|
models/get-order-groups-response.ts
|
|
172
175
|
models/get-order-queue-position-response.ts
|
|
173
176
|
models/get-order-response.ts
|
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
# IMPORTANT: this file is generated with the option `openapiGeneratorIgnoreList` enabled
|
|
2
|
+
# (--openapi-generator-ignore-list in CLI for example) so the entries below are pre-populated based
|
|
3
|
+
# on the input provided by the users and this file will be overwritten every time when the option is
|
|
4
|
+
# enabled (which is the exact opposite of the default behaviour to not overwrite
|
|
5
|
+
# .openapi-generator-ignore if the file exists).
|
|
6
|
+
|
|
1
7
|
# OpenAPI Generator Ignore
|
|
2
8
|
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
|
3
9
|
|
|
@@ -22,5 +28,6 @@
|
|
|
22
28
|
# Then explicitly reverse the ignore rule for a single file:
|
|
23
29
|
#!docs/README.md
|
|
24
30
|
|
|
25
|
-
|
|
26
|
-
|
|
31
|
+
# The following entries are pre-populated based on the input obtained via
|
|
32
|
+
# the option `openapiGeneratorIgnoreList` (--openapi-generator-ignore-list in CLI for example).
|
|
33
|
+
auth.ts
|
package/README.md
CHANGED
|
@@ -1,44 +1,215 @@
|
|
|
1
|
-
|
|
1
|
+
## kalshi-typescript@2.1.3
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
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:
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Environment
|
|
6
|
+
* Node.js
|
|
7
|
+
* Webpack
|
|
8
|
+
* Browserify
|
|
6
9
|
|
|
7
|
-
|
|
8
|
-
-
|
|
9
|
-
|
|
10
|
-
- Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen
|
|
10
|
+
Language level
|
|
11
|
+
* ES5 - you must have a Promises/A+ library installed
|
|
12
|
+
* ES6
|
|
11
13
|
|
|
12
|
-
|
|
14
|
+
Module system
|
|
15
|
+
* CommonJS
|
|
16
|
+
* ES6 module system
|
|
13
17
|
|
|
14
|
-
|
|
18
|
+
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))
|
|
15
19
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
20
|
+
### Building
|
|
21
|
+
|
|
22
|
+
To build and compile the typescript sources to javascript use:
|
|
23
|
+
```
|
|
24
|
+
npm install
|
|
25
|
+
npm run build
|
|
19
26
|
```
|
|
20
27
|
|
|
21
|
-
|
|
28
|
+
### Publishing
|
|
29
|
+
|
|
30
|
+
First build the package then run `npm publish`
|
|
22
31
|
|
|
23
|
-
|
|
24
|
-
import { Configuration, PortfolioApi } from 'kalshi-typescript';
|
|
32
|
+
### Consuming
|
|
25
33
|
|
|
26
|
-
|
|
27
|
-
const config = new Configuration({
|
|
28
|
-
basePath: 'https://api.elections.kalshi.com/trade-api/v2',
|
|
29
|
-
apiKey: 'your-api-key-id',
|
|
30
|
-
privateKeyPath: 'path/to/private_key.pem'
|
|
31
|
-
// or privateKeyPem: 'your-private-key-string'
|
|
32
|
-
});
|
|
34
|
+
navigate to the folder of your consuming project and run one of the following commands.
|
|
33
35
|
|
|
34
|
-
|
|
35
|
-
const portfolioApi = new PortfolioApi(config);
|
|
36
|
+
_published:_
|
|
36
37
|
|
|
37
|
-
// Make API calls
|
|
38
|
-
const balance = await portfolioApi.getBalance();
|
|
39
|
-
console.log(`Balance: $${balance.data.balance / 100}`);
|
|
40
38
|
```
|
|
39
|
+
npm install kalshi-typescript@2.1.3 --save
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
_unPublished (not recommended):_
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Documentation for API Endpoints
|
|
49
|
+
|
|
50
|
+
All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
51
|
+
|
|
52
|
+
Class | Method | HTTP request | Description
|
|
53
|
+
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*ApiKeysApi* | [**createApiKey**](docs/ApiKeysApi.md#createapikey) | **POST** /api_keys | Create API Key
|
|
55
|
+
*ApiKeysApi* | [**deleteApiKey**](docs/ApiKeysApi.md#deleteapikey) | **DELETE** /api_keys/{api_key} | Delete API Key
|
|
56
|
+
*ApiKeysApi* | [**generateApiKey**](docs/ApiKeysApi.md#generateapikey) | **POST** /api_keys/generate | Generate API Key
|
|
57
|
+
*ApiKeysApi* | [**getApiKeys**](docs/ApiKeysApi.md#getapikeys) | **GET** /api_keys | Get API Keys
|
|
58
|
+
*CommunicationsApi* | [**acceptQuote**](docs/CommunicationsApi.md#acceptquote) | **PUT** /communications/quotes/{quote_id}/accept | Accept Quote
|
|
59
|
+
*CommunicationsApi* | [**confirmQuote**](docs/CommunicationsApi.md#confirmquote) | **PUT** /communications/quotes/{quote_id}/confirm | Confirm Quote
|
|
60
|
+
*CommunicationsApi* | [**createQuote**](docs/CommunicationsApi.md#createquote) | **POST** /communications/quotes | Create Quote
|
|
61
|
+
*CommunicationsApi* | [**createRFQ**](docs/CommunicationsApi.md#createrfq) | **POST** /communications/rfqs | Create RFQ
|
|
62
|
+
*CommunicationsApi* | [**deleteQuote**](docs/CommunicationsApi.md#deletequote) | **DELETE** /communications/quotes/{quote_id} | Delete Quote
|
|
63
|
+
*CommunicationsApi* | [**deleteRFQ**](docs/CommunicationsApi.md#deleterfq) | **DELETE** /communications/rfqs/{rfq_id} | Delete RFQ
|
|
64
|
+
*CommunicationsApi* | [**getCommunicationsID**](docs/CommunicationsApi.md#getcommunicationsid) | **GET** /communications/id | Get Communications ID
|
|
65
|
+
*CommunicationsApi* | [**getQuote**](docs/CommunicationsApi.md#getquote) | **GET** /communications/quotes/{quote_id} | Get Quote
|
|
66
|
+
*CommunicationsApi* | [**getQuotes**](docs/CommunicationsApi.md#getquotes) | **GET** /communications/quotes | Get Quotes
|
|
67
|
+
*CommunicationsApi* | [**getRFQ**](docs/CommunicationsApi.md#getrfq) | **GET** /communications/rfqs/{rfq_id} | Get RFQ
|
|
68
|
+
*CommunicationsApi* | [**getRFQs**](docs/CommunicationsApi.md#getrfqs) | **GET** /communications/rfqs | Get RFQs
|
|
69
|
+
*EventsApi* | [**getEvent**](docs/EventsApi.md#getevent) | **GET** /events/{event_ticker} | Get Event
|
|
70
|
+
*EventsApi* | [**getEventMetadata**](docs/EventsApi.md#geteventmetadata) | **GET** /events/{event_ticker}/metadata | Get Event Metadata
|
|
71
|
+
*EventsApi* | [**getEvents**](docs/EventsApi.md#getevents) | **GET** /events | Get Events
|
|
72
|
+
*ExchangeApi* | [**getExchangeAnnouncements**](docs/ExchangeApi.md#getexchangeannouncements) | **GET** /exchange/announcements | Get Exchange Announcements
|
|
73
|
+
*ExchangeApi* | [**getExchangeSchedule**](docs/ExchangeApi.md#getexchangeschedule) | **GET** /exchange/schedule | Get Exchange Schedule
|
|
74
|
+
*ExchangeApi* | [**getExchangeStatus**](docs/ExchangeApi.md#getexchangestatus) | **GET** /exchange/status | Get Exchange Status
|
|
75
|
+
*ExchangeApi* | [**getUserDataTimestamp**](docs/ExchangeApi.md#getuserdatatimestamp) | **GET** /exchange/user_data_timestamp | Get User Data Timestamp
|
|
76
|
+
*MarketsApi* | [**getMarket**](docs/MarketsApi.md#getmarket) | **GET** /markets/{ticker} | Get Market
|
|
77
|
+
*MarketsApi* | [**getMarketCandlesticks**](docs/MarketsApi.md#getmarketcandlesticks) | **GET** /series/{ticker}/markets/{market_ticker}/candlesticks | Get Market Candlesticks
|
|
78
|
+
*MarketsApi* | [**getMarketOrderbook**](docs/MarketsApi.md#getmarketorderbook) | **GET** /markets/{ticker}/orderbook | Get Market Orderbook
|
|
79
|
+
*MarketsApi* | [**getMarkets**](docs/MarketsApi.md#getmarkets) | **GET** /markets | Get Markets
|
|
80
|
+
*MarketsApi* | [**getTrades**](docs/MarketsApi.md#gettrades) | **GET** /markets/trades | Get Trades
|
|
81
|
+
*MilestonesApi* | [**getMilestone**](docs/MilestonesApi.md#getmilestone) | **GET** /milestones/{milestone_id} | Get Milestone
|
|
82
|
+
*MilestonesApi* | [**getMilestones**](docs/MilestonesApi.md#getmilestones) | **GET** /milestones | Get Milestones
|
|
83
|
+
*MultivariateCollectionsApi* | [**getMultivariateEventCollection**](docs/MultivariateCollectionsApi.md#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection
|
|
84
|
+
*MultivariateCollectionsApi* | [**getMultivariateEventCollections**](docs/MultivariateCollectionsApi.md#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections
|
|
85
|
+
*MultivariateCollectionsApi* | [**lookupMultivariateEventCollectionBundle**](docs/MultivariateCollectionsApi.md#lookupmultivariateeventcollectionbundle) | **POST** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Multivariate Event Collection Bundle
|
|
86
|
+
*PortfolioApi* | [**amendOrder**](docs/PortfolioApi.md#amendorder) | **POST** /portfolio/orders/{order_id}/amend | Amend Order
|
|
87
|
+
*PortfolioApi* | [**batchCancelOrders**](docs/PortfolioApi.md#batchcancelorders) | **DELETE** /portfolio/orders/batched | Batch Cancel Orders
|
|
88
|
+
*PortfolioApi* | [**batchCreateOrders**](docs/PortfolioApi.md#batchcreateorders) | **POST** /portfolio/orders/batched | Batch Create Orders
|
|
89
|
+
*PortfolioApi* | [**cancelOrder**](docs/PortfolioApi.md#cancelorder) | **DELETE** /portfolio/orders/{order_id} | Cancel Order
|
|
90
|
+
*PortfolioApi* | [**createOrder**](docs/PortfolioApi.md#createorder) | **POST** /portfolio/orders | Create Order
|
|
91
|
+
*PortfolioApi* | [**createOrderGroup**](docs/PortfolioApi.md#createordergroup) | **POST** /portfolio/order_groups/create | Create Order Group
|
|
92
|
+
*PortfolioApi* | [**decreaseOrder**](docs/PortfolioApi.md#decreaseorder) | **POST** /portfolio/orders/{order_id}/decrease | Decrease Order
|
|
93
|
+
*PortfolioApi* | [**deleteOrderGroup**](docs/PortfolioApi.md#deleteordergroup) | **DELETE** /portfolio/order_groups/{order_group_id} | Delete Order Group
|
|
94
|
+
*PortfolioApi* | [**getBalance**](docs/PortfolioApi.md#getbalance) | **GET** /portfolio/balance | Get Balance
|
|
95
|
+
*PortfolioApi* | [**getFills**](docs/PortfolioApi.md#getfills) | **GET** /portfolio/fills | Get Fills
|
|
96
|
+
*PortfolioApi* | [**getOrder**](docs/PortfolioApi.md#getorder) | **GET** /portfolio/orders/{order_id} | Get Order
|
|
97
|
+
*PortfolioApi* | [**getOrderGroup**](docs/PortfolioApi.md#getordergroup) | **GET** /portfolio/order_groups/{order_group_id} | Get Order Group
|
|
98
|
+
*PortfolioApi* | [**getOrderGroups**](docs/PortfolioApi.md#getordergroups) | **GET** /portfolio/order_groups | Get Order Groups
|
|
99
|
+
*PortfolioApi* | [**getOrderQueuePosition**](docs/PortfolioApi.md#getorderqueueposition) | **GET** /portfolio/orders/{order_id}/queue_position | Get Order Queue Position
|
|
100
|
+
*PortfolioApi* | [**getOrders**](docs/PortfolioApi.md#getorders) | **GET** /portfolio/orders | Get Orders
|
|
101
|
+
*PortfolioApi* | [**getPositions**](docs/PortfolioApi.md#getpositions) | **GET** /portfolio/positions | Get Positions
|
|
102
|
+
*PortfolioApi* | [**getQueuePositions**](docs/PortfolioApi.md#getqueuepositions) | **POST** /portfolio/orders/queue_positions | Get Queue Positions
|
|
103
|
+
*PortfolioApi* | [**getSettlements**](docs/PortfolioApi.md#getsettlements) | **GET** /portfolio/settlements | Get Settlements
|
|
104
|
+
*PortfolioApi* | [**getTotalRestingOrderValue**](docs/PortfolioApi.md#gettotalrestingordervalue) | **GET** /portfolio/summary/total_resting_order_value | Get Total Resting Order Value
|
|
105
|
+
*PortfolioApi* | [**resetOrderGroup**](docs/PortfolioApi.md#resetordergroup) | **PUT** /portfolio/order_groups/{order_group_id}/reset | Reset Order Group
|
|
106
|
+
*SeriesApi* | [**getSeries**](docs/SeriesApi.md#getseries) | **GET** /series | Get Series
|
|
107
|
+
*SeriesApi* | [**getSeriesByTicker**](docs/SeriesApi.md#getseriesbyticker) | **GET** /series/{ticker} | Get Series by Ticker
|
|
108
|
+
*StructuredTargetsApi* | [**getStructuredTarget**](docs/StructuredTargetsApi.md#getstructuredtarget) | **GET** /structured_targets/{structured_target_id} | Get Structured Target
|
|
109
|
+
*StructuredTargetsApi* | [**getStructuredTargets**](docs/StructuredTargetsApi.md#getstructuredtargets) | **GET** /structured_targets | Get Structured Targets
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### Documentation For Models
|
|
113
|
+
|
|
114
|
+
- [AcceptQuoteRequest](docs/AcceptQuoteRequest.md)
|
|
115
|
+
- [AmendOrderRequest](docs/AmendOrderRequest.md)
|
|
116
|
+
- [AmendOrderResponse](docs/AmendOrderResponse.md)
|
|
117
|
+
- [Announcement](docs/Announcement.md)
|
|
118
|
+
- [ApiKey](docs/ApiKey.md)
|
|
119
|
+
- [BatchCancelOrdersRequest](docs/BatchCancelOrdersRequest.md)
|
|
120
|
+
- [BatchCancelOrdersResponse](docs/BatchCancelOrdersResponse.md)
|
|
121
|
+
- [BatchCancelOrdersResponseResponsesInner](docs/BatchCancelOrdersResponseResponsesInner.md)
|
|
122
|
+
- [BatchCreateOrdersRequest](docs/BatchCreateOrdersRequest.md)
|
|
123
|
+
- [BatchCreateOrdersResponse](docs/BatchCreateOrdersResponse.md)
|
|
124
|
+
- [BatchCreateOrdersResponseResponsesInner](docs/BatchCreateOrdersResponseResponsesInner.md)
|
|
125
|
+
- [CancelOrderResponse](docs/CancelOrderResponse.md)
|
|
126
|
+
- [Candlestick](docs/Candlestick.md)
|
|
127
|
+
- [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
|
128
|
+
- [CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
|
|
129
|
+
- [CreateOrderGroupRequest](docs/CreateOrderGroupRequest.md)
|
|
130
|
+
- [CreateOrderGroupResponse](docs/CreateOrderGroupResponse.md)
|
|
131
|
+
- [CreateOrderRequest](docs/CreateOrderRequest.md)
|
|
132
|
+
- [CreateOrderResponse](docs/CreateOrderResponse.md)
|
|
133
|
+
- [CreateQuoteRequest](docs/CreateQuoteRequest.md)
|
|
134
|
+
- [CreateQuoteResponse](docs/CreateQuoteResponse.md)
|
|
135
|
+
- [CreateRFQRequest](docs/CreateRFQRequest.md)
|
|
136
|
+
- [CreateRFQResponse](docs/CreateRFQResponse.md)
|
|
137
|
+
- [DailySchedule](docs/DailySchedule.md)
|
|
138
|
+
- [DecreaseOrderRequest](docs/DecreaseOrderRequest.md)
|
|
139
|
+
- [DecreaseOrderResponse](docs/DecreaseOrderResponse.md)
|
|
140
|
+
- [ErrorResponse](docs/ErrorResponse.md)
|
|
141
|
+
- [ErrorResponseError](docs/ErrorResponseError.md)
|
|
142
|
+
- [Event](docs/Event.md)
|
|
143
|
+
- [EventPosition](docs/EventPosition.md)
|
|
144
|
+
- [ExchangeStatus](docs/ExchangeStatus.md)
|
|
145
|
+
- [Fill](docs/Fill.md)
|
|
146
|
+
- [GenerateApiKeyRequest](docs/GenerateApiKeyRequest.md)
|
|
147
|
+
- [GenerateApiKeyResponse](docs/GenerateApiKeyResponse.md)
|
|
148
|
+
- [GetApiKeysResponse](docs/GetApiKeysResponse.md)
|
|
149
|
+
- [GetBalanceResponse](docs/GetBalanceResponse.md)
|
|
150
|
+
- [GetCommunicationsIDResponse](docs/GetCommunicationsIDResponse.md)
|
|
151
|
+
- [GetEventMetadataResponse](docs/GetEventMetadataResponse.md)
|
|
152
|
+
- [GetEventResponse](docs/GetEventResponse.md)
|
|
153
|
+
- [GetEventsResponse](docs/GetEventsResponse.md)
|
|
154
|
+
- [GetExchangeAnnouncementsResponse](docs/GetExchangeAnnouncementsResponse.md)
|
|
155
|
+
- [GetExchangeScheduleResponse](docs/GetExchangeScheduleResponse.md)
|
|
156
|
+
- [GetExchangeScheduleResponseSchedule](docs/GetExchangeScheduleResponseSchedule.md)
|
|
157
|
+
- [GetFillsResponse](docs/GetFillsResponse.md)
|
|
158
|
+
- [GetMarketCandlesticksResponse](docs/GetMarketCandlesticksResponse.md)
|
|
159
|
+
- [GetMarketOrderbookResponse](docs/GetMarketOrderbookResponse.md)
|
|
160
|
+
- [GetMarketOrderbookResponseOrderbook](docs/GetMarketOrderbookResponseOrderbook.md)
|
|
161
|
+
- [GetMarketResponse](docs/GetMarketResponse.md)
|
|
162
|
+
- [GetMarketsResponse](docs/GetMarketsResponse.md)
|
|
163
|
+
- [GetMilestoneResponse](docs/GetMilestoneResponse.md)
|
|
164
|
+
- [GetMilestonesResponse](docs/GetMilestonesResponse.md)
|
|
165
|
+
- [GetMultivariateEventCollectionResponse](docs/GetMultivariateEventCollectionResponse.md)
|
|
166
|
+
- [GetMultivariateEventCollectionsResponse](docs/GetMultivariateEventCollectionsResponse.md)
|
|
167
|
+
- [GetOrderGroupResponse](docs/GetOrderGroupResponse.md)
|
|
168
|
+
- [GetOrderGroupsResponse](docs/GetOrderGroupsResponse.md)
|
|
169
|
+
- [GetOrderQueuePositionResponse](docs/GetOrderQueuePositionResponse.md)
|
|
170
|
+
- [GetOrderResponse](docs/GetOrderResponse.md)
|
|
171
|
+
- [GetOrdersResponse](docs/GetOrdersResponse.md)
|
|
172
|
+
- [GetPositionsResponse](docs/GetPositionsResponse.md)
|
|
173
|
+
- [GetQueuePositionsRequest](docs/GetQueuePositionsRequest.md)
|
|
174
|
+
- [GetQueuePositionsResponse](docs/GetQueuePositionsResponse.md)
|
|
175
|
+
- [GetQuoteResponse](docs/GetQuoteResponse.md)
|
|
176
|
+
- [GetQuotesResponse](docs/GetQuotesResponse.md)
|
|
177
|
+
- [GetRFQResponse](docs/GetRFQResponse.md)
|
|
178
|
+
- [GetRFQsResponse](docs/GetRFQsResponse.md)
|
|
179
|
+
- [GetSeriesByTickerResponse](docs/GetSeriesByTickerResponse.md)
|
|
180
|
+
- [GetSeriesResponse](docs/GetSeriesResponse.md)
|
|
181
|
+
- [GetSettlementsResponse](docs/GetSettlementsResponse.md)
|
|
182
|
+
- [GetStructuredTargetResponse](docs/GetStructuredTargetResponse.md)
|
|
183
|
+
- [GetStructuredTargetsResponse](docs/GetStructuredTargetsResponse.md)
|
|
184
|
+
- [GetTotalRestingOrderValueResponse](docs/GetTotalRestingOrderValueResponse.md)
|
|
185
|
+
- [GetTradesResponse](docs/GetTradesResponse.md)
|
|
186
|
+
- [GetUserDataTimestampResponse](docs/GetUserDataTimestampResponse.md)
|
|
187
|
+
- [LookupBundleRequest](docs/LookupBundleRequest.md)
|
|
188
|
+
- [LookupBundleRequestBundleInner](docs/LookupBundleRequestBundleInner.md)
|
|
189
|
+
- [LookupBundleResponse](docs/LookupBundleResponse.md)
|
|
190
|
+
- [Market](docs/Market.md)
|
|
191
|
+
- [Milestone](docs/Milestone.md)
|
|
192
|
+
- [MultivariateEventCollection](docs/MultivariateEventCollection.md)
|
|
193
|
+
- [MultivariateEventCollectionEventsInner](docs/MultivariateEventCollectionEventsInner.md)
|
|
194
|
+
- [Order](docs/Order.md)
|
|
195
|
+
- [OrderGroup](docs/OrderGroup.md)
|
|
196
|
+
- [OrderbookLevel](docs/OrderbookLevel.md)
|
|
197
|
+
- [Position](docs/Position.md)
|
|
198
|
+
- [Quote](docs/Quote.md)
|
|
199
|
+
- [RFQ](docs/RFQ.md)
|
|
200
|
+
- [Series](docs/Series.md)
|
|
201
|
+
- [Settlement](docs/Settlement.md)
|
|
202
|
+
- [StructuredTarget](docs/StructuredTarget.md)
|
|
203
|
+
- [Trade](docs/Trade.md)
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<a id="documentation-for-authorization"></a>
|
|
207
|
+
## Documentation For Authorization
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
Authentication schemes defined for the API:
|
|
211
|
+
<a id="bearerAuth"></a>
|
|
212
|
+
### bearerAuth
|
|
41
213
|
|
|
42
|
-
|
|
214
|
+
- **Type**: Bearer authentication (JWT)
|
|
43
215
|
|
|
44
|
-
Full documentation is available at [docs.kalshi.com](https://docs.kalshi.com)
|
package/api/api-keys-api.ts
CHANGED
|
@@ -23,7 +23,7 @@ import { URL, URLSearchParams } from 'url';
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
25
25
|
// @ts-ignore
|
|
26
|
-
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
|
|
26
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import type { CreateApiKeyRequest } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
@@ -212,7 +212,7 @@ export const ApiKeysApiFp = function(configuration?: Configuration) {
|
|
|
212
212
|
async createApiKey(createApiKeyRequest: CreateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateApiKeyResponse>> {
|
|
213
213
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createApiKey(createApiKeyRequest, options);
|
|
214
214
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
215
|
-
const localVarOperationServerBasePath =
|
|
215
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
216
216
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
217
217
|
},
|
|
218
218
|
/**
|
|
@@ -225,7 +225,7 @@ export const ApiKeysApiFp = function(configuration?: Configuration) {
|
|
|
225
225
|
async deleteApiKey(apiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
226
226
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApiKey(apiKey, options);
|
|
227
227
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
228
|
-
const localVarOperationServerBasePath =
|
|
228
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
229
229
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
230
230
|
},
|
|
231
231
|
/**
|
|
@@ -238,7 +238,7 @@ export const ApiKeysApiFp = function(configuration?: Configuration) {
|
|
|
238
238
|
async generateApiKey(generateApiKeyRequest: GenerateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateApiKeyResponse>> {
|
|
239
239
|
const localVarAxiosArgs = await localVarAxiosParamCreator.generateApiKey(generateApiKeyRequest, options);
|
|
240
240
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
241
|
-
const localVarOperationServerBasePath =
|
|
241
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
242
242
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
@@ -250,7 +250,7 @@ export const ApiKeysApiFp = function(configuration?: Configuration) {
|
|
|
250
250
|
async getApiKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetApiKeysResponse>> {
|
|
251
251
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getApiKeys(options);
|
|
252
252
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
253
|
-
const localVarOperationServerBasePath =
|
|
253
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
254
254
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
255
255
|
},
|
|
256
256
|
}
|
|
@@ -23,7 +23,7 @@ import { URL, URLSearchParams } from 'url';
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
25
25
|
// @ts-ignore
|
|
26
|
-
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
|
|
26
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import type { AcceptQuoteRequest } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
@@ -487,7 +487,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
487
487
|
async acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
488
488
|
const localVarAxiosArgs = await localVarAxiosParamCreator.acceptQuote(quoteId, acceptQuoteRequest, options);
|
|
489
489
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
490
|
-
const localVarOperationServerBasePath =
|
|
490
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
491
491
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
492
492
|
},
|
|
493
493
|
/**
|
|
@@ -500,7 +500,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
500
500
|
async confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
501
501
|
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmQuote(quoteId, options);
|
|
502
502
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
503
|
-
const localVarOperationServerBasePath =
|
|
503
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
504
504
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
505
505
|
},
|
|
506
506
|
/**
|
|
@@ -513,7 +513,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
513
513
|
async createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateQuoteResponse>> {
|
|
514
514
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createQuote(createQuoteRequest, options);
|
|
515
515
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
516
|
-
const localVarOperationServerBasePath =
|
|
516
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
517
517
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
518
518
|
},
|
|
519
519
|
/**
|
|
@@ -526,7 +526,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
526
526
|
async createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRFQResponse>> {
|
|
527
527
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createRFQ(createRFQRequest, options);
|
|
528
528
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
529
|
-
const localVarOperationServerBasePath =
|
|
529
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
530
530
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
531
531
|
},
|
|
532
532
|
/**
|
|
@@ -539,7 +539,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
539
539
|
async deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
540
540
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteQuote(quoteId, options);
|
|
541
541
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
542
|
-
const localVarOperationServerBasePath =
|
|
542
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
543
543
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
544
544
|
},
|
|
545
545
|
/**
|
|
@@ -552,7 +552,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
552
552
|
async deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
553
553
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRFQ(rfqId, options);
|
|
554
554
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
555
|
-
const localVarOperationServerBasePath =
|
|
555
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
556
556
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
557
557
|
},
|
|
558
558
|
/**
|
|
@@ -564,7 +564,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
564
564
|
async getCommunicationsID(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommunicationsIDResponse>> {
|
|
565
565
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getCommunicationsID(options);
|
|
566
566
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
567
|
-
const localVarOperationServerBasePath =
|
|
567
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
568
568
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
569
569
|
},
|
|
570
570
|
/**
|
|
@@ -577,7 +577,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
577
577
|
async getQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuoteResponse>> {
|
|
578
578
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getQuote(quoteId, options);
|
|
579
579
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
580
|
-
const localVarOperationServerBasePath =
|
|
580
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
581
581
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
582
582
|
},
|
|
583
583
|
/**
|
|
@@ -589,7 +589,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
589
589
|
async getQuotes(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQuotesResponse>> {
|
|
590
590
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getQuotes(options);
|
|
591
591
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
592
|
-
const localVarOperationServerBasePath =
|
|
592
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
593
593
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
594
594
|
},
|
|
595
595
|
/**
|
|
@@ -602,7 +602,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
602
602
|
async getRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRFQResponse>> {
|
|
603
603
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getRFQ(rfqId, options);
|
|
604
604
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
605
|
-
const localVarOperationServerBasePath =
|
|
605
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
606
606
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
607
607
|
},
|
|
608
608
|
/**
|
|
@@ -614,7 +614,7 @@ export const CommunicationsApiFp = function(configuration?: Configuration) {
|
|
|
614
614
|
async getRFQs(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRFQsResponse>> {
|
|
615
615
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getRFQs(options);
|
|
616
616
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
617
|
-
const localVarOperationServerBasePath =
|
|
617
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
618
618
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
619
619
|
},
|
|
620
620
|
}
|
package/api/events-api.ts
CHANGED
|
@@ -23,7 +23,7 @@ import { URL, URLSearchParams } from 'url';
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
25
25
|
// @ts-ignore
|
|
26
|
-
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
|
|
26
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import type { ErrorResponse } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
@@ -202,7 +202,7 @@ export const EventsApiFp = function(configuration?: Configuration) {
|
|
|
202
202
|
async getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>> {
|
|
203
203
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEvent(eventTicker, withNestedMarkets, options);
|
|
204
204
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
205
|
-
const localVarOperationServerBasePath =
|
|
205
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
206
206
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
207
207
|
},
|
|
208
208
|
/**
|
|
@@ -215,7 +215,7 @@ export const EventsApiFp = function(configuration?: Configuration) {
|
|
|
215
215
|
async getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventMetadataResponse>> {
|
|
216
216
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEventMetadata(eventTicker, options);
|
|
217
217
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
218
|
-
const localVarOperationServerBasePath =
|
|
218
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
219
219
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
220
220
|
},
|
|
221
221
|
/**
|
|
@@ -233,7 +233,7 @@ export const EventsApiFp = function(configuration?: Configuration) {
|
|
|
233
233
|
async getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventsResponse>> {
|
|
234
234
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options);
|
|
235
235
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
236
|
-
const localVarOperationServerBasePath =
|
|
236
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
237
237
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
238
238
|
},
|
|
239
239
|
}
|
package/api/exchange-api.ts
CHANGED
|
@@ -23,7 +23,7 @@ import { URL, URLSearchParams } from 'url';
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
25
25
|
// @ts-ignore
|
|
26
|
-
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
|
|
26
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import type { ErrorResponse } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
@@ -130,7 +130,7 @@ export const ExchangeApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
130
130
|
};
|
|
131
131
|
},
|
|
132
132
|
/**
|
|
133
|
-
* There is typically a short delay before exchange events are reflected in the API endpoints.
|
|
133
|
+
* 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
|
|
134
134
|
* @summary Get User Data Timestamp
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
@@ -181,7 +181,7 @@ export const ExchangeApiFp = function(configuration?: Configuration) {
|
|
|
181
181
|
async getExchangeAnnouncements(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExchangeAnnouncementsResponse>> {
|
|
182
182
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getExchangeAnnouncements(options);
|
|
183
183
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
184
|
-
const localVarOperationServerBasePath =
|
|
184
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
185
185
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
186
186
|
},
|
|
187
187
|
/**
|
|
@@ -193,7 +193,7 @@ export const ExchangeApiFp = function(configuration?: Configuration) {
|
|
|
193
193
|
async getExchangeSchedule(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExchangeScheduleResponse>> {
|
|
194
194
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getExchangeSchedule(options);
|
|
195
195
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
196
|
-
const localVarOperationServerBasePath =
|
|
196
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
197
197
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
198
198
|
},
|
|
199
199
|
/**
|
|
@@ -205,11 +205,11 @@ export const ExchangeApiFp = function(configuration?: Configuration) {
|
|
|
205
205
|
async getExchangeStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeStatus>> {
|
|
206
206
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getExchangeStatus(options);
|
|
207
207
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
208
|
-
const localVarOperationServerBasePath =
|
|
208
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
209
209
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
210
210
|
},
|
|
211
211
|
/**
|
|
212
|
-
* There is typically a short delay before exchange events are reflected in the API endpoints.
|
|
212
|
+
* 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
|
|
213
213
|
* @summary Get User Data Timestamp
|
|
214
214
|
* @param {*} [options] Override http request option.
|
|
215
215
|
* @throws {RequiredError}
|
|
@@ -217,7 +217,7 @@ export const ExchangeApiFp = function(configuration?: Configuration) {
|
|
|
217
217
|
async getUserDataTimestamp(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserDataTimestampResponse>> {
|
|
218
218
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getUserDataTimestamp(options);
|
|
219
219
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
220
|
-
const localVarOperationServerBasePath =
|
|
220
|
+
const localVarOperationServerBasePath: string | undefined = undefined;
|
|
221
221
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
222
222
|
},
|
|
223
223
|
}
|
|
@@ -257,7 +257,7 @@ export const ExchangeApiFactory = function (configuration?: Configuration, baseP
|
|
|
257
257
|
return localVarFp.getExchangeStatus(options).then((request) => request(axios, basePath));
|
|
258
258
|
},
|
|
259
259
|
/**
|
|
260
|
-
* There is typically a short delay before exchange events are reflected in the API endpoints.
|
|
260
|
+
* 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
|
|
261
261
|
* @summary Get User Data Timestamp
|
|
262
262
|
* @param {*} [options] Override http request option.
|
|
263
263
|
* @throws {RequiredError}
|
|
@@ -303,7 +303,7 @@ export class ExchangeApi extends BaseAPI {
|
|
|
303
303
|
}
|
|
304
304
|
|
|
305
305
|
/**
|
|
306
|
-
* There is typically a short delay before exchange events are reflected in the API endpoints.
|
|
306
|
+
* 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
|
|
307
307
|
* @summary Get User Data Timestamp
|
|
308
308
|
* @param {*} [options] Override http request option.
|
|
309
309
|
* @throws {RequiredError}
|