Skip to content

Milestone API Reference

Endpoints

Get Milestone

Synchronous API Call

kalshi_py.api.milestone.get_milestone.sync(milestone_id: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetMilestoneResponse]

Get Milestone

Endpoint for getting data about a specific milestone by its ID.

Parameters:

Name Type Description Default
milestone_id str

Milestone 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[ModelGetMilestoneResponse]

ModelGetMilestoneResponse
Source code in kalshi_py/api/milestone/get_milestone.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(
    milestone_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetMilestoneResponse]:
    """Get Milestone

      Endpoint for getting data about a specific milestone by its ID.

    Args:
        milestone_id (str): Milestone 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:
        ModelGetMilestoneResponse
    """

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

Asynchronous API Call

kalshi_py.api.milestone.get_milestone.asyncio(milestone_id: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetMilestoneResponse] async

Get Milestone

Endpoint for getting data about a specific milestone by its ID.

Parameters:

Name Type Description Default
milestone_id str

Milestone 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[ModelGetMilestoneResponse]

ModelGetMilestoneResponse
Source code in kalshi_py/api/milestone/get_milestone.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(
    milestone_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetMilestoneResponse]:
    """Get Milestone

      Endpoint for getting data about a specific milestone by its ID.

    Args:
        milestone_id (str): Milestone 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:
        ModelGetMilestoneResponse
    """

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

Synchronous Detailed Response

kalshi_py.api.milestone.get_milestone.sync_detailed(milestone_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetMilestoneResponse]

Get Milestone

Endpoint for getting data about a specific milestone by its ID.

Parameters:

Name Type Description Default
milestone_id str

Milestone 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[ModelGetMilestoneResponse]

Response[ModelGetMilestoneResponse]
Source code in kalshi_py/api/milestone/get_milestone.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(
    milestone_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetMilestoneResponse]:
    """Get Milestone

      Endpoint for getting data about a specific milestone by its ID.

    Args:
        milestone_id (str): Milestone 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[ModelGetMilestoneResponse]
    """

    kwargs = _get_kwargs(
        milestone_id=milestone_id,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.milestone.get_milestone.asyncio_detailed(milestone_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetMilestoneResponse] async

Get Milestone

Endpoint for getting data about a specific milestone by its ID.

Parameters:

Name Type Description Default
milestone_id str

Milestone 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[ModelGetMilestoneResponse]

Response[ModelGetMilestoneResponse]
Source code in kalshi_py/api/milestone/get_milestone.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(
    milestone_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetMilestoneResponse]:
    """Get Milestone

      Endpoint for getting data about a specific milestone by its ID.

    Args:
        milestone_id (str): Milestone 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[ModelGetMilestoneResponse]
    """

    kwargs = _get_kwargs(
        milestone_id=milestone_id,
    )

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

    return _build_response(client=client, response=response)

Get Milestones

Synchronous API Call

kalshi_py.api.milestone.get_milestones.sync(*, client: Union[AuthenticatedClient, Client], minimum_start_date: Union[Unset, str] = UNSET, category: Union[Unset, str] = UNSET, competition: Union[Unset, str] = UNSET, type_: Union[Unset, str] = UNSET, related_event_ticker: Union[Unset, str] = UNSET, limit: int, cursor: Union[Unset, str] = UNSET) -> Optional[ModelGetMilestonesResponse]

Get Milestones

Endpoint for getting data about milestones with optional filtering.

Parameters:

Name Type Description Default
minimum_start_date Union[Unset, str]

Minimum start date to filter milestones. Format: RFC3339 timestamp

 UNSET
category Union[Unset, str]

Filter by milestone category

 UNSET
competition Union[Unset, str]

Filter by competition

 UNSET
type_ Union[Unset, str]

Filter by milestone type

 UNSET
related_event_ticker Union[Unset, str]

Filter by related event ticker

 UNSET
limit int

Number of milestones to return per page

 required
cursor Union[Unset, str]

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results

 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[ModelGetMilestonesResponse]

ModelGetMilestonesResponse
Source code in kalshi_py/api/milestone/get_milestones.py 
124
125
126
127
128
129
130
131
132
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
159
160
161
162
163
164
165
166
167
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    minimum_start_date: Union[Unset, str] = UNSET,
    category: Union[Unset, str] = UNSET,
    competition: Union[Unset, str] = UNSET,
    type_: Union[Unset, str] = UNSET,
    related_event_ticker: Union[Unset, str] = UNSET,
    limit: int,
    cursor: Union[Unset, str] = UNSET,
) -> Optional[ModelGetMilestonesResponse]:
    """Get Milestones

      Endpoint for getting data about milestones with optional filtering.

    Args:
        minimum_start_date (Union[Unset, str]): Minimum start date to filter milestones. Format:
            RFC3339 timestamp
        category (Union[Unset, str]): Filter by milestone category
        competition (Union[Unset, str]): Filter by competition
        type_ (Union[Unset, str]): Filter by milestone type
        related_event_ticker (Union[Unset, str]): Filter by related event ticker
        limit (int): Number of milestones to return per page
        cursor (Union[Unset, str]): Pagination cursor. Use the cursor value returned from the
            previous response to get the next page of results

    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:
        ModelGetMilestonesResponse
    """

    return sync_detailed(
        client=client,
        minimum_start_date=minimum_start_date,
        category=category,
        competition=competition,
        type_=type_,
        related_event_ticker=related_event_ticker,
        limit=limit,
        cursor=cursor,
    ).parsed

Asynchronous API Call

kalshi_py.api.milestone.get_milestones.asyncio(*, client: Union[AuthenticatedClient, Client], minimum_start_date: Union[Unset, str] = UNSET, category: Union[Unset, str] = UNSET, competition: Union[Unset, str] = UNSET, type_: Union[Unset, str] = UNSET, related_event_ticker: Union[Unset, str] = UNSET, limit: int, cursor: Union[Unset, str] = UNSET) -> Optional[ModelGetMilestonesResponse] async

Get Milestones

Endpoint for getting data about milestones with optional filtering.

Parameters:

Name Type Description Default
minimum_start_date Union[Unset, str]

Minimum start date to filter milestones. Format: RFC3339 timestamp

 UNSET
category Union[Unset, str]

Filter by milestone category

 UNSET
competition Union[Unset, str]

Filter by competition

 UNSET
type_ Union[Unset, str]

Filter by milestone type

 UNSET
related_event_ticker Union[Unset, str]

Filter by related event ticker

 UNSET
limit int

Number of milestones to return per page

 required
cursor Union[Unset, str]

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results

 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[ModelGetMilestonesResponse]

ModelGetMilestonesResponse
Source code in kalshi_py/api/milestone/get_milestones.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    minimum_start_date: Union[Unset, str] = UNSET,
    category: Union[Unset, str] = UNSET,
    competition: Union[Unset, str] = UNSET,
    type_: Union[Unset, str] = UNSET,
    related_event_ticker: Union[Unset, str] = UNSET,
    limit: int,
    cursor: Union[Unset, str] = UNSET,
) -> Optional[ModelGetMilestonesResponse]:
    """Get Milestones

      Endpoint for getting data about milestones with optional filtering.

    Args:
        minimum_start_date (Union[Unset, str]): Minimum start date to filter milestones. Format:
            RFC3339 timestamp
        category (Union[Unset, str]): Filter by milestone category
        competition (Union[Unset, str]): Filter by competition
        type_ (Union[Unset, str]): Filter by milestone type
        related_event_ticker (Union[Unset, str]): Filter by related event ticker
        limit (int): Number of milestones to return per page
        cursor (Union[Unset, str]): Pagination cursor. Use the cursor value returned from the
            previous response to get the next page of results

    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:
        ModelGetMilestonesResponse
    """

    return (
        await asyncio_detailed(
            client=client,
            minimum_start_date=minimum_start_date,
            category=category,
            competition=competition,
            type_=type_,
            related_event_ticker=related_event_ticker,
            limit=limit,
            cursor=cursor,
        )
    ).parsed

Synchronous Detailed Response

kalshi_py.api.milestone.get_milestones.sync_detailed(*, client: Union[AuthenticatedClient, Client], minimum_start_date: Union[Unset, str] = UNSET, category: Union[Unset, str] = UNSET, competition: Union[Unset, str] = UNSET, type_: Union[Unset, str] = UNSET, related_event_ticker: Union[Unset, str] = UNSET, limit: int, cursor: Union[Unset, str] = UNSET) -> Response[ModelGetMilestonesResponse]

Get Milestones

Endpoint for getting data about milestones with optional filtering.

Parameters:

Name Type Description Default
minimum_start_date Union[Unset, str]

Minimum start date to filter milestones. Format: RFC3339 timestamp

 UNSET
category Union[Unset, str]

Filter by milestone category

 UNSET
competition Union[Unset, str]

Filter by competition

 UNSET
type_ Union[Unset, str]

Filter by milestone type

 UNSET
related_event_ticker Union[Unset, str]

Filter by related event ticker

 UNSET
limit int

Number of milestones to return per page

 required
cursor Union[Unset, str]

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results

 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[ModelGetMilestonesResponse]

Response[ModelGetMilestonesResponse]
Source code in kalshi_py/api/milestone/get_milestones.py 
 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    minimum_start_date: Union[Unset, str] = UNSET,
    category: Union[Unset, str] = UNSET,
    competition: Union[Unset, str] = UNSET,
    type_: Union[Unset, str] = UNSET,
    related_event_ticker: Union[Unset, str] = UNSET,
    limit: int,
    cursor: Union[Unset, str] = UNSET,
) -> Response[ModelGetMilestonesResponse]:
    """Get Milestones

      Endpoint for getting data about milestones with optional filtering.

    Args:
        minimum_start_date (Union[Unset, str]): Minimum start date to filter milestones. Format:
            RFC3339 timestamp
        category (Union[Unset, str]): Filter by milestone category
        competition (Union[Unset, str]): Filter by competition
        type_ (Union[Unset, str]): Filter by milestone type
        related_event_ticker (Union[Unset, str]): Filter by related event ticker
        limit (int): Number of milestones to return per page
        cursor (Union[Unset, str]): Pagination cursor. Use the cursor value returned from the
            previous response to get the next page of results

    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[ModelGetMilestonesResponse]
    """

    kwargs = _get_kwargs(
        minimum_start_date=minimum_start_date,
        category=category,
        competition=competition,
        type_=type_,
        related_event_ticker=related_event_ticker,
        limit=limit,
        cursor=cursor,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.milestone.get_milestones.asyncio_detailed(*, client: Union[AuthenticatedClient, Client], minimum_start_date: Union[Unset, str] = UNSET, category: Union[Unset, str] = UNSET, competition: Union[Unset, str] = UNSET, type_: Union[Unset, str] = UNSET, related_event_ticker: Union[Unset, str] = UNSET, limit: int, cursor: Union[Unset, str] = UNSET) -> Response[ModelGetMilestonesResponse] async

Get Milestones

Endpoint for getting data about milestones with optional filtering.

Parameters:

Name Type Description Default
minimum_start_date Union[Unset, str]

Minimum start date to filter milestones. Format: RFC3339 timestamp

 UNSET
category Union[Unset, str]

Filter by milestone category

 UNSET
competition Union[Unset, str]

Filter by competition

 UNSET
type_ Union[Unset, str]

Filter by milestone type

 UNSET
related_event_ticker Union[Unset, str]

Filter by related event ticker

 UNSET
limit int

Number of milestones to return per page

 required
cursor Union[Unset, str]

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results

 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[ModelGetMilestonesResponse]

Response[ModelGetMilestonesResponse]
Source code in kalshi_py/api/milestone/get_milestones.py 
170
171
172
173
174
175
176
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
212
213
214
215
216
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    minimum_start_date: Union[Unset, str] = UNSET,
    category: Union[Unset, str] = UNSET,
    competition: Union[Unset, str] = UNSET,
    type_: Union[Unset, str] = UNSET,
    related_event_ticker: Union[Unset, str] = UNSET,
    limit: int,
    cursor: Union[Unset, str] = UNSET,
) -> Response[ModelGetMilestonesResponse]:
    """Get Milestones

      Endpoint for getting data about milestones with optional filtering.

    Args:
        minimum_start_date (Union[Unset, str]): Minimum start date to filter milestones. Format:
            RFC3339 timestamp
        category (Union[Unset, str]): Filter by milestone category
        competition (Union[Unset, str]): Filter by competition
        type_ (Union[Unset, str]): Filter by milestone type
        related_event_ticker (Union[Unset, str]): Filter by related event ticker
        limit (int): Number of milestones to return per page
        cursor (Union[Unset, str]): Pagination cursor. Use the cursor value returned from the
            previous response to get the next page of results

    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[ModelGetMilestonesResponse]
    """

    kwargs = _get_kwargs(
        minimum_start_date=minimum_start_date,
        category=category,
        competition=competition,
        type_=type_,
        related_event_ticker=related_event_ticker,
        limit=limit,
        cursor=cursor,
    )

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

    return _build_response(client=client, response=response)