UNPKG

kalshi-typescript

Version:

OpenAPI client for kalshi-typescript

github.com/GIT_USER_ID/GIT_REPO_ID

GIT_USER_ID/GIT_REPO_ID

81 lines (51 loc) • 2.64 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
# StructuredTargetsApi All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**getStructuredTarget**](#getstructuredtarget) | **GET** /structured_targets/{structured_target_id} | Get Structured Target| |[**getStructuredTargets**](#getstructuredtargets) | **GET** /structured_targets | Get Structured Targets| # **getStructuredTarget** > GetStructuredTargetResponse getStructuredTarget() Endpoint for getting data about a specific structured target by its ID. ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **structuredTargetId** | [**string**] | Structured target ID | defaults to undefined| ### Return type **GetStructuredTargetResponse** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Structured target retrieved successfully | - | |**401** | Unauthorized | - | |**404** | Not found | - | |**500** | Internal server error | - | # **getStructuredTargets** > GetStructuredTargetsResponse getStructuredTargets() Page size (min: 1, max: 2000) ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **ids** | **Array<string>** | Filter by specific structured target IDs. Pass multiple IDs by repeating the parameter (e.g. `?ids=uuid1&ids=uuid2`). | (optional) defaults to undefined| | **type** | [**string**] | Filter by structured target type | (optional) defaults to undefined| | **competition** | [**string**] | Filter by competition. Matches against the league, conference, division, or tour in the structured target details. | (optional) defaults to undefined| | **pageSize** | [**number**] | Number of items per page (min 1, max 2000, default 100) | (optional) defaults to 100| | **cursor** | [**string**] | Pagination cursor | (optional) defaults to undefined| ### Return type **GetStructuredTargetsResponse** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Structured targets retrieved successfully | - | |**401** | Unauthorized | - | |**500** | Internal server error | - |