Skip to content

Structured_Target API Reference

Endpoints

Get Structured Target

Synchronous API Call

kalshi_py.api.structured_target.get_structured_target.sync(structured_target_id: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetStructuredTargetResponse]

Get Structured Target

Endpoint for getting data about a specific structured target by its ID.

Parameters:

Name Type Description Default
structured_target_id str

Structured Target ID

 required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[ModelGetStructuredTargetResponse]

ModelGetStructuredTargetResponse
Source code in kalshi_py/api/structured_target/get_structured_target.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def sync(
    structured_target_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetStructuredTargetResponse]:
    """Get Structured Target

      Endpoint for getting data about a specific structured target by its ID.

    Args:
        structured_target_id (str): Structured Target ID

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        ModelGetStructuredTargetResponse
    """

    return sync_detailed(
        structured_target_id=structured_target_id,
        client=client,
    ).parsed

Asynchronous API Call

kalshi_py.api.structured_target.get_structured_target.asyncio(structured_target_id: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetStructuredTargetResponse] async

Get Structured Target

Endpoint for getting data about a specific structured target by its ID.

Parameters:

Name Type Description Default
structured_target_id str

Structured Target ID

 required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[ModelGetStructuredTargetResponse]

ModelGetStructuredTargetResponse
Source code in kalshi_py/api/structured_target/get_structured_target.py 
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
async def asyncio(
    structured_target_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetStructuredTargetResponse]:
    """Get Structured Target

      Endpoint for getting data about a specific structured target by its ID.

    Args:
        structured_target_id (str): Structured Target ID

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        ModelGetStructuredTargetResponse
    """

    return (
        await asyncio_detailed(
            structured_target_id=structured_target_id,
            client=client,
        )
    ).parsed

Synchronous Detailed Response

kalshi_py.api.structured_target.get_structured_target.sync_detailed(structured_target_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetStructuredTargetResponse]

Get Structured Target

Endpoint for getting data about a specific structured target by its ID.

Parameters:

Name Type Description Default
structured_target_id str

Structured Target ID

 required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[ModelGetStructuredTargetResponse]

Response[ModelGetStructuredTargetResponse]
Source code in kalshi_py/api/structured_target/get_structured_target.py 
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
def sync_detailed(
    structured_target_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetStructuredTargetResponse]:
    """Get Structured Target

      Endpoint for getting data about a specific structured target by its ID.

    Args:
        structured_target_id (str): Structured Target ID

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[ModelGetStructuredTargetResponse]
    """

    kwargs = _get_kwargs(
        structured_target_id=structured_target_id,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.structured_target.get_structured_target.asyncio_detailed(structured_target_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetStructuredTargetResponse] async

Get Structured Target

Endpoint for getting data about a specific structured target by its ID.

Parameters:

Name Type Description Default
structured_target_id str

Structured Target ID

 required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[ModelGetStructuredTargetResponse]

Response[ModelGetStructuredTargetResponse]
Source code in kalshi_py/api/structured_target/get_structured_target.py 
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
async def asyncio_detailed(
    structured_target_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetStructuredTargetResponse]:
    """Get Structured Target

      Endpoint for getting data about a specific structured target by its ID.

    Args:
        structured_target_id (str): Structured Target ID

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[ModelGetStructuredTargetResponse]
    """

    kwargs = _get_kwargs(
        structured_target_id=structured_target_id,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

Get Structured Targets

Synchronous API Call

kalshi_py.api.structured_target.get_structured_targets.sync(*, client: Union[AuthenticatedClient, Client], type_: Union[Unset, str] = UNSET, competition: Union[Unset, str] = UNSET, page_size: Union[Unset, int] = UNSET, cursor: Union[Unset, str] = UNSET) -> Optional[ModelGetStructuredTargetsResponse]

Get Structured Targets

Endpoint for getting data about structured targets.

Parameters:

Name Type Description Default
type_ Union[Unset, str]

Type of structured target

 UNSET
competition Union[Unset, str]

Competition filter

 UNSET
page_size Union[Unset, int]

Page size (min: 1, max: 2000)

 UNSET
cursor Union[Unset, str]

Pagination cursor

 UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[ModelGetStructuredTargetsResponse]

ModelGetStructuredTargetsResponse
Source code in kalshi_py/api/structured_target/get_structured_targets.py 
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
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    type_: Union[Unset, str] = UNSET,
    competition: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = UNSET,
    cursor: Union[Unset, str] = UNSET,
) -> Optional[ModelGetStructuredTargetsResponse]:
    """Get Structured Targets

      Endpoint for getting data about structured targets.

    Args:
        type_ (Union[Unset, str]): Type of structured target
        competition (Union[Unset, str]): Competition filter
        page_size (Union[Unset, int]): Page size (min: 1, max: 2000)
        cursor (Union[Unset, str]): Pagination cursor

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        ModelGetStructuredTargetsResponse
    """

    return sync_detailed(
        client=client,
        type_=type_,
        competition=competition,
        page_size=page_size,
        cursor=cursor,
    ).parsed

Asynchronous API Call

kalshi_py.api.structured_target.get_structured_targets.asyncio(*, client: Union[AuthenticatedClient, Client], type_: Union[Unset, str] = UNSET, competition: Union[Unset, str] = UNSET, page_size: Union[Unset, int] = UNSET, cursor: Union[Unset, str] = UNSET) -> Optional[ModelGetStructuredTargetsResponse] async

Get Structured Targets

Endpoint for getting data about structured targets.

Parameters:

Name Type Description Default
type_ Union[Unset, str]

Type of structured target

 UNSET
competition Union[Unset, str]

Competition filter

 UNSET
page_size Union[Unset, int]

Page size (min: 1, max: 2000)

 UNSET
cursor Union[Unset, str]

Pagination cursor

 UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[ModelGetStructuredTargetsResponse]

ModelGetStructuredTargetsResponse
Source code in kalshi_py/api/structured_target/get_structured_targets.py 
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
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    type_: Union[Unset, str] = UNSET,
    competition: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = UNSET,
    cursor: Union[Unset, str] = UNSET,
) -> Optional[ModelGetStructuredTargetsResponse]:
    """Get Structured Targets

      Endpoint for getting data about structured targets.

    Args:
        type_ (Union[Unset, str]): Type of structured target
        competition (Union[Unset, str]): Competition filter
        page_size (Union[Unset, int]): Page size (min: 1, max: 2000)
        cursor (Union[Unset, str]): Pagination cursor

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        ModelGetStructuredTargetsResponse
    """

    return (
        await asyncio_detailed(
            client=client,
            type_=type_,
            competition=competition,
            page_size=page_size,
            cursor=cursor,
        )
    ).parsed

Synchronous Detailed Response

kalshi_py.api.structured_target.get_structured_targets.sync_detailed(*, client: Union[AuthenticatedClient, Client], type_: Union[Unset, str] = UNSET, competition: Union[Unset, str] = UNSET, page_size: Union[Unset, int] = UNSET, cursor: Union[Unset, str] = UNSET) -> Response[ModelGetStructuredTargetsResponse]

Get Structured Targets

Endpoint for getting data about structured targets.

Parameters:

Name Type Description Default
type_ Union[Unset, str]

Type of structured target

 UNSET
competition Union[Unset, str]

Competition filter

 UNSET
page_size Union[Unset, int]

Page size (min: 1, max: 2000)

 UNSET
cursor Union[Unset, str]

Pagination cursor

 UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[ModelGetStructuredTargetsResponse]

Response[ModelGetStructuredTargetsResponse]
Source code in kalshi_py/api/structured_target/get_structured_targets.py 
 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
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    type_: Union[Unset, str] = UNSET,
    competition: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = UNSET,
    cursor: Union[Unset, str] = UNSET,
) -> Response[ModelGetStructuredTargetsResponse]:
    """Get Structured Targets

      Endpoint for getting data about structured targets.

    Args:
        type_ (Union[Unset, str]): Type of structured target
        competition (Union[Unset, str]): Competition filter
        page_size (Union[Unset, int]): Page size (min: 1, max: 2000)
        cursor (Union[Unset, str]): Pagination cursor

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[ModelGetStructuredTargetsResponse]
    """

    kwargs = _get_kwargs(
        type_=type_,
        competition=competition,
        page_size=page_size,
        cursor=cursor,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.structured_target.get_structured_targets.asyncio_detailed(*, client: Union[AuthenticatedClient, Client], type_: Union[Unset, str] = UNSET, competition: Union[Unset, str] = UNSET, page_size: Union[Unset, int] = UNSET, cursor: Union[Unset, str] = UNSET) -> Response[ModelGetStructuredTargetsResponse] async

Get Structured Targets

Endpoint for getting data about structured targets.

Parameters:

Name Type Description Default
type_ Union[Unset, str]

Type of structured target

 UNSET
competition Union[Unset, str]

Competition filter

 UNSET
page_size Union[Unset, int]

Page size (min: 1, max: 2000)

 UNSET
cursor Union[Unset, str]

Pagination cursor

 UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[ModelGetStructuredTargetsResponse]

Response[ModelGetStructuredTargetsResponse]
Source code in kalshi_py/api/structured_target/get_structured_targets.py 
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
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    type_: Union[Unset, str] = UNSET,
    competition: Union[Unset, str] = UNSET,
    page_size: Union[Unset, int] = UNSET,
    cursor: Union[Unset, str] = UNSET,
) -> Response[ModelGetStructuredTargetsResponse]:
    """Get Structured Targets

      Endpoint for getting data about structured targets.

    Args:
        type_ (Union[Unset, str]): Type of structured target
        competition (Union[Unset, str]): Competition filter
        page_size (Union[Unset, int]): Page size (min: 1, max: 2000)
        cursor (Union[Unset, str]): Pagination cursor

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[ModelGetStructuredTargetsResponse]
    """

    kwargs = _get_kwargs(
        type_=type_,
        competition=competition,
        page_size=page_size,
        cursor=cursor,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)