UNPKG

kalshi-typescript

Version:

OpenAPI client for kalshi-typescript

github.com/GIT_USER_ID/GIT_REPO_ID

GIT_USER_ID/GIT_REPO_ID

93 lines (63 loc) • 4.61 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
# FcmApi All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**getFCMOrders**](#getfcmorders) | **GET** /fcm/orders | Get FCM Orders| |[**getFCMPositions**](#getfcmpositions) | **GET** /fcm/positions | Get FCM Positions| # **getFCMOrders** > GetOrdersResponse getFCMOrders() Endpoint for FCM members to get orders filtered by subtrader ID. This endpoint requires FCM member access level and allows filtering orders by subtrader ID. ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **subtraderId** | [**string**] | Restricts the response to orders for a specific subtrader (FCM members only) | defaults to undefined| | **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined| | **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined| | **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined| | **minTs** | [**number**] | Restricts the response to orders after a timestamp, formatted as a Unix Timestamp | (optional) defaults to undefined| | **maxTs** | [**number**] | Restricts the response to orders before a timestamp, formatted as a Unix Timestamp | (optional) defaults to undefined| | **status** | [**&#39;resting&#39; | &#39;canceled&#39; | &#39;executed&#39;**]**Array<&#39;resting&#39; &#124; &#39;canceled&#39; &#124; &#39;executed&#39;>** | Restricts the response to orders that have a certain status | (optional) defaults to undefined| | **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100 | (optional) defaults to undefined| ### Return type **GetOrdersResponse** ### Authorization [kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Orders retrieved successfully | - | |**400** | Bad request | - | |**401** | Unauthorized | - | |**404** | Not found | - | |**500** | Internal server error | - | # **getFCMPositions** > GetPositionsResponse getFCMPositions() Endpoint for FCM members to get market positions filtered by subtrader ID. This endpoint requires FCM member access level and allows filtering positions by subtrader ID. ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **subtraderId** | [**string**] | Restricts the response to positions for a specific subtrader (FCM members only) | defaults to undefined| | **ticker** | [**string**] | Ticker of desired positions | (optional) defaults to undefined| | **eventTicker** | [**string**] | Event ticker of desired positions | (optional) defaults to undefined| | **countFilter** | [**string**] | Restricts the positions to those with any of following fields with non-zero values, as a comma separated list | (optional) defaults to undefined| | **settlementStatus** | [**&#39;all&#39; | &#39;unsettled&#39; | &#39;settled&#39;**]**Array<&#39;all&#39; &#124; &#39;unsettled&#39; &#124; &#39;settled&#39;>** | Settlement status of the markets to return. Defaults to unsettled | (optional) defaults to undefined| | **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100 | (optional) defaults to undefined| | **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination | (optional) defaults to undefined| ### Return type **GetPositionsResponse** ### Authorization [kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Positions retrieved successfully | - | |**400** | Bad request | - | |**401** | Unauthorized | - | |**404** | Not found | - | |**500** | Internal server error | - |