UNPKG

kalshi-typescript

Version:

OpenAPI client for kalshi-typescript

github.com/GIT_USER_ID/GIT_REPO_ID

GIT_USER_ID/GIT_REPO_ID

45 lines (28 loc) • 2.03 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
# IncentiveProgramsApi All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**getIncentivePrograms**](#getincentiveprograms) | **GET** /incentive_programs | Get Incentives| # **getIncentivePrograms** > GetIncentiveProgramsResponse getIncentivePrograms() List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets. ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **status** | [**&#39;all&#39; | &#39;active&#39; | &#39;upcoming&#39; | &#39;closed&#39; | &#39;paid_out&#39;**]**Array<&#39;all&#39; &#124; &#39;active&#39; &#124; &#39;upcoming&#39; &#124; &#39;closed&#39; &#124; &#39;paid_out&#39;>** | Status filter. Can be \&quot;all\&quot;, \&quot;active\&quot;, \&quot;upcoming\&quot;, \&quot;closed\&quot;, or \&quot;paid_out\&quot;. Default is \&quot;all\&quot;. | (optional) defaults to undefined| | **type** | [**&#39;all&#39; | &#39;liquidity&#39; | &#39;volume&#39;**]**Array<&#39;all&#39; &#124; &#39;liquidity&#39; &#124; &#39;volume&#39;>** | Type filter. Can be \&quot;all\&quot;, \&quot;liquidity\&quot;, or \&quot;volume\&quot;. Default is \&quot;all\&quot;. | (optional) defaults to undefined| | **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 10000. | (optional) defaults to undefined| | **cursor** | [**string**] | Cursor for pagination | (optional) defaults to undefined| ### Return type **GetIncentiveProgramsResponse** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Incentive programs retrieved successfully | - | |**400** | Invalid request parameters | - | |**500** | Internal server error | - |