Skip to content

Collection API Reference

Endpoints

Create Market In Multivariate Event Collection

Synchronous API Call

kalshi_py.api.collection.create_market_in_multivariate_event_collection.sync(collection_ticker: str, *, client: Union[AuthenticatedClient, Client], body: ModelCreateMarketInMultivariateEventCollectionRequest) -> Optional[ModelCreateMarketInMultivariateEventCollectionResponse]

Create Market In Multivariate Event Collection

Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

 required
body ModelCreateMarketInMultivariateEventCollectionRequest
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[ModelCreateMarketInMultivariateEventCollectionResponse]

ModelCreateMarketInMultivariateEventCollectionResponse
Source code in kalshi_py/api/collection/create_market_in_multivariate_event_collection.py 
 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
122
123
def sync(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateMarketInMultivariateEventCollectionRequest,
) -> Optional[ModelCreateMarketInMultivariateEventCollectionResponse]:
    """Create Market In Multivariate Event Collection

      Endpoint for looking up an individual market in a multivariate event collection. This endpoint must
    be hit at least once before trading or looking up a market.

    Args:
        collection_ticker (str): Collection ticker
        body (ModelCreateMarketInMultivariateEventCollectionRequest):

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

    return sync_detailed(
        collection_ticker=collection_ticker,
        client=client,
        body=body,
    ).parsed

Asynchronous API Call

kalshi_py.api.collection.create_market_in_multivariate_event_collection.asyncio(collection_ticker: str, *, client: Union[AuthenticatedClient, Client], body: ModelCreateMarketInMultivariateEventCollectionRequest) -> Optional[ModelCreateMarketInMultivariateEventCollectionResponse] async

Create Market In Multivariate Event Collection

Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

 required
body ModelCreateMarketInMultivariateEventCollectionRequest
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[ModelCreateMarketInMultivariateEventCollectionResponse]

ModelCreateMarketInMultivariateEventCollectionResponse
Source code in kalshi_py/api/collection/create_market_in_multivariate_event_collection.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
async def asyncio(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateMarketInMultivariateEventCollectionRequest,
) -> Optional[ModelCreateMarketInMultivariateEventCollectionResponse]:
    """Create Market In Multivariate Event Collection

      Endpoint for looking up an individual market in a multivariate event collection. This endpoint must
    be hit at least once before trading or looking up a market.

    Args:
        collection_ticker (str): Collection ticker
        body (ModelCreateMarketInMultivariateEventCollectionRequest):

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

    return (
        await asyncio_detailed(
            collection_ticker=collection_ticker,
            client=client,
            body=body,
        )
    ).parsed

Synchronous Detailed Response

kalshi_py.api.collection.create_market_in_multivariate_event_collection.sync_detailed(collection_ticker: str, *, client: Union[AuthenticatedClient, Client], body: ModelCreateMarketInMultivariateEventCollectionRequest) -> Response[ModelCreateMarketInMultivariateEventCollectionResponse]

Create Market In Multivariate Event Collection

Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

 required
body ModelCreateMarketInMultivariateEventCollectionRequest
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[ModelCreateMarketInMultivariateEventCollectionResponse]

Response[ModelCreateMarketInMultivariateEventCollectionResponse]
Source code in kalshi_py/api/collection/create_market_in_multivariate_event_collection.py 
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
def sync_detailed(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateMarketInMultivariateEventCollectionRequest,
) -> Response[ModelCreateMarketInMultivariateEventCollectionResponse]:
    """Create Market In Multivariate Event Collection

      Endpoint for looking up an individual market in a multivariate event collection. This endpoint must
    be hit at least once before trading or looking up a market.

    Args:
        collection_ticker (str): Collection ticker
        body (ModelCreateMarketInMultivariateEventCollectionRequest):

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

    kwargs = _get_kwargs(
        collection_ticker=collection_ticker,
        body=body,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.collection.create_market_in_multivariate_event_collection.asyncio_detailed(collection_ticker: str, *, client: Union[AuthenticatedClient, Client], body: ModelCreateMarketInMultivariateEventCollectionRequest) -> Response[ModelCreateMarketInMultivariateEventCollectionResponse] async

Create Market In Multivariate Event Collection

Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

 required
body ModelCreateMarketInMultivariateEventCollectionRequest
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[ModelCreateMarketInMultivariateEventCollectionResponse]

Response[ModelCreateMarketInMultivariateEventCollectionResponse]
Source code in kalshi_py/api/collection/create_market_in_multivariate_event_collection.py 
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
async def asyncio_detailed(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateMarketInMultivariateEventCollectionRequest,
) -> Response[ModelCreateMarketInMultivariateEventCollectionResponse]:
    """Create Market In Multivariate Event Collection

      Endpoint for looking up an individual market in a multivariate event collection. This endpoint must
    be hit at least once before trading or looking up a market.

    Args:
        collection_ticker (str): Collection ticker
        body (ModelCreateMarketInMultivariateEventCollectionRequest):

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

    kwargs = _get_kwargs(
        collection_ticker=collection_ticker,
        body=body,
    )

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

    return _build_response(client=client, response=response)

Get Multivariate Event Collection

Synchronous API Call

kalshi_py.api.collection.get_multivariate_event_collection.sync(collection_ticker: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetMultivariateEventCollectionResponse]

Get Multivariate Event Collection

Endpoint for getting data about a multivariate event collection by its ticker.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

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

ModelGetMultivariateEventCollectionResponse
Source code in kalshi_py/api/collection/get_multivariate_event_collection.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(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetMultivariateEventCollectionResponse]:
    """Get Multivariate Event Collection

      Endpoint for getting data about a multivariate event collection by its ticker.

    Args:
        collection_ticker (str): Collection ticker

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

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

Asynchronous API Call

kalshi_py.api.collection.get_multivariate_event_collection.asyncio(collection_ticker: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetMultivariateEventCollectionResponse] async

Get Multivariate Event Collection

Endpoint for getting data about a multivariate event collection by its ticker.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

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

ModelGetMultivariateEventCollectionResponse
Source code in kalshi_py/api/collection/get_multivariate_event_collection.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(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetMultivariateEventCollectionResponse]:
    """Get Multivariate Event Collection

      Endpoint for getting data about a multivariate event collection by its ticker.

    Args:
        collection_ticker (str): Collection ticker

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

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

Synchronous Detailed Response

kalshi_py.api.collection.get_multivariate_event_collection.sync_detailed(collection_ticker: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetMultivariateEventCollectionResponse]

Get Multivariate Event Collection

Endpoint for getting data about a multivariate event collection by its ticker.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

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

Response[ModelGetMultivariateEventCollectionResponse]
Source code in kalshi_py/api/collection/get_multivariate_event_collection.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(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetMultivariateEventCollectionResponse]:
    """Get Multivariate Event Collection

      Endpoint for getting data about a multivariate event collection by its ticker.

    Args:
        collection_ticker (str): Collection ticker

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

    kwargs = _get_kwargs(
        collection_ticker=collection_ticker,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.collection.get_multivariate_event_collection.asyncio_detailed(collection_ticker: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetMultivariateEventCollectionResponse] async

Get Multivariate Event Collection

Endpoint for getting data about a multivariate event collection by its ticker.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

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

Response[ModelGetMultivariateEventCollectionResponse]
Source code in kalshi_py/api/collection/get_multivariate_event_collection.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(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetMultivariateEventCollectionResponse]:
    """Get Multivariate Event Collection

      Endpoint for getting data about a multivariate event collection by its ticker.

    Args:
        collection_ticker (str): Collection ticker

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

    kwargs = _get_kwargs(
        collection_ticker=collection_ticker,
    )

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

    return _build_response(client=client, response=response)

Get Multivariate Event Collection Lookup History

Synchronous API Call

kalshi_py.api.collection.get_multivariate_event_collection_lookup_history.sync(collection_ticker: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetMultivariateEventCollectionLookupHistoryResponse]

Get Multivariate Event Collection Lookup History

Endpoint for retrieving which markets in an event collection were recently looked up.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

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

ModelGetMultivariateEventCollectionLookupHistoryResponse
Source code in kalshi_py/api/collection/get_multivariate_event_collection_lookup_history.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def sync(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetMultivariateEventCollectionLookupHistoryResponse]:
    """Get Multivariate Event Collection Lookup History

      Endpoint for retrieving which markets in an event collection were recently looked up.

    Args:
        collection_ticker (str): Collection ticker

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

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

Asynchronous API Call

kalshi_py.api.collection.get_multivariate_event_collection_lookup_history.asyncio(collection_ticker: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetMultivariateEventCollectionLookupHistoryResponse] async

Get Multivariate Event Collection Lookup History

Endpoint for retrieving which markets in an event collection were recently looked up.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

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

ModelGetMultivariateEventCollectionLookupHistoryResponse
Source code in kalshi_py/api/collection/get_multivariate_event_collection_lookup_history.py 
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
async def asyncio(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetMultivariateEventCollectionLookupHistoryResponse]:
    """Get Multivariate Event Collection Lookup History

      Endpoint for retrieving which markets in an event collection were recently looked up.

    Args:
        collection_ticker (str): Collection ticker

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

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

Synchronous Detailed Response

kalshi_py.api.collection.get_multivariate_event_collection_lookup_history.sync_detailed(collection_ticker: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetMultivariateEventCollectionLookupHistoryResponse]

Get Multivariate Event Collection Lookup History

Endpoint for retrieving which markets in an event collection were recently looked up.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

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

Response[ModelGetMultivariateEventCollectionLookupHistoryResponse]
Source code in kalshi_py/api/collection/get_multivariate_event_collection_lookup_history.py 
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
def sync_detailed(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetMultivariateEventCollectionLookupHistoryResponse]:
    """Get Multivariate Event Collection Lookup History

      Endpoint for retrieving which markets in an event collection were recently looked up.

    Args:
        collection_ticker (str): Collection ticker

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

    kwargs = _get_kwargs(
        collection_ticker=collection_ticker,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.collection.get_multivariate_event_collection_lookup_history.asyncio_detailed(collection_ticker: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetMultivariateEventCollectionLookupHistoryResponse] async

Get Multivariate Event Collection Lookup History

Endpoint for retrieving which markets in an event collection were recently looked up.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

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

Response[ModelGetMultivariateEventCollectionLookupHistoryResponse]
Source code in kalshi_py/api/collection/get_multivariate_event_collection_lookup_history.py 
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
async def asyncio_detailed(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetMultivariateEventCollectionLookupHistoryResponse]:
    """Get Multivariate Event Collection Lookup History

      Endpoint for retrieving which markets in an event collection were recently looked up.

    Args:
        collection_ticker (str): Collection ticker

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

    kwargs = _get_kwargs(
        collection_ticker=collection_ticker,
    )

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

    return _build_response(client=client, response=response)

Get Multivariate Event Collections

Synchronous API Call

kalshi_py.api.collection.get_multivariate_event_collections.sync(*, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetMultivariateEventCollectionsResponse]

Get Multivariate Event Collections

Endpoint for getting data about multivariate event collections.

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

ModelGetMultivariateEventCollectionsResponse
Source code in kalshi_py/api/collection/get_multivariate_event_collections.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetMultivariateEventCollectionsResponse]:
    """Get Multivariate Event Collections

      Endpoint for getting data about multivariate event collections.

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

    return sync_detailed(
        client=client,
    ).parsed

Asynchronous API Call

kalshi_py.api.collection.get_multivariate_event_collections.asyncio(*, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetMultivariateEventCollectionsResponse] async

Get Multivariate Event Collections

Endpoint for getting data about multivariate event collections.

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

ModelGetMultivariateEventCollectionsResponse
Source code in kalshi_py/api/collection/get_multivariate_event_collections.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetMultivariateEventCollectionsResponse]:
    """Get Multivariate Event Collections

      Endpoint for getting data about multivariate event collections.

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

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

Synchronous Detailed Response

kalshi_py.api.collection.get_multivariate_event_collections.sync_detailed(*, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetMultivariateEventCollectionsResponse]

Get Multivariate Event Collections

Endpoint for getting data about multivariate event collections.

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

Response[ModelGetMultivariateEventCollectionsResponse]
Source code in kalshi_py/api/collection/get_multivariate_event_collections.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetMultivariateEventCollectionsResponse]:
    """Get Multivariate Event Collections

      Endpoint for getting data about multivariate event collections.

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

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.collection.get_multivariate_event_collections.asyncio_detailed(*, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetMultivariateEventCollectionsResponse] async

Get Multivariate Event Collections

Endpoint for getting data about multivariate event collections.

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

Response[ModelGetMultivariateEventCollectionsResponse]
Source code in kalshi_py/api/collection/get_multivariate_event_collections.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetMultivariateEventCollectionsResponse]:
    """Get Multivariate Event Collections

      Endpoint for getting data about multivariate event collections.

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

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

Lookup Tickers For Market In Multivariate Event Collection

Synchronous API Call

kalshi_py.api.collection.lookup_tickers_for_market_in_multivariate_event_collection.sync(collection_ticker: str, *, client: Union[AuthenticatedClient, Client], body: ModelLookupTickersForMarketInMultivariateEventCollectionRequest) -> Optional[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]

Lookup Tickers For Market In Multivariate Event Collection

Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

 required
body ModelLookupTickersForMarketInMultivariateEventCollectionRequest
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[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]

ModelLookupTickersForMarketInMultivariateEventCollectionResponse
Source code in kalshi_py/api/collection/lookup_tickers_for_market_in_multivariate_event_collection.py 
 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
122
123
124
125
def sync(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelLookupTickersForMarketInMultivariateEventCollectionRequest,
) -> Optional[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]:
    """Lookup Tickers For Market In Multivariate Event Collection

      Endpoint for looking up an individual market in a multivariate event collection. If
    CreateMarketInMultivariateEventCollection has never been hit with that variable combination before,
    this will return a 404.

    Args:
        collection_ticker (str): Collection ticker
        body (ModelLookupTickersForMarketInMultivariateEventCollectionRequest):

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

    return sync_detailed(
        collection_ticker=collection_ticker,
        client=client,
        body=body,
    ).parsed

Asynchronous API Call

kalshi_py.api.collection.lookup_tickers_for_market_in_multivariate_event_collection.asyncio(collection_ticker: str, *, client: Union[AuthenticatedClient, Client], body: ModelLookupTickersForMarketInMultivariateEventCollectionRequest) -> Optional[ModelLookupTickersForMarketInMultivariateEventCollectionResponse] async

Lookup Tickers For Market In Multivariate Event Collection

Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

 required
body ModelLookupTickersForMarketInMultivariateEventCollectionRequest
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[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]

ModelLookupTickersForMarketInMultivariateEventCollectionResponse
Source code in kalshi_py/api/collection/lookup_tickers_for_market_in_multivariate_event_collection.py 
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
async def asyncio(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelLookupTickersForMarketInMultivariateEventCollectionRequest,
) -> Optional[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]:
    """Lookup Tickers For Market In Multivariate Event Collection

      Endpoint for looking up an individual market in a multivariate event collection. If
    CreateMarketInMultivariateEventCollection has never been hit with that variable combination before,
    this will return a 404.

    Args:
        collection_ticker (str): Collection ticker
        body (ModelLookupTickersForMarketInMultivariateEventCollectionRequest):

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

    return (
        await asyncio_detailed(
            collection_ticker=collection_ticker,
            client=client,
            body=body,
        )
    ).parsed

Synchronous Detailed Response

kalshi_py.api.collection.lookup_tickers_for_market_in_multivariate_event_collection.sync_detailed(collection_ticker: str, *, client: Union[AuthenticatedClient, Client], body: ModelLookupTickersForMarketInMultivariateEventCollectionRequest) -> Response[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]

Lookup Tickers For Market In Multivariate Event Collection

Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

 required
body ModelLookupTickersForMarketInMultivariateEventCollectionRequest
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[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]

Response[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]
Source code in kalshi_py/api/collection/lookup_tickers_for_market_in_multivariate_event_collection.py 
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
94
def sync_detailed(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelLookupTickersForMarketInMultivariateEventCollectionRequest,
) -> Response[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]:
    """Lookup Tickers For Market In Multivariate Event Collection

      Endpoint for looking up an individual market in a multivariate event collection. If
    CreateMarketInMultivariateEventCollection has never been hit with that variable combination before,
    this will return a 404.

    Args:
        collection_ticker (str): Collection ticker
        body (ModelLookupTickersForMarketInMultivariateEventCollectionRequest):

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

    kwargs = _get_kwargs(
        collection_ticker=collection_ticker,
        body=body,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.collection.lookup_tickers_for_market_in_multivariate_event_collection.asyncio_detailed(collection_ticker: str, *, client: Union[AuthenticatedClient, Client], body: ModelLookupTickersForMarketInMultivariateEventCollectionRequest) -> Response[ModelLookupTickersForMarketInMultivariateEventCollectionResponse] async

Lookup Tickers For Market In Multivariate Event Collection

Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.

Parameters:

Name Type Description Default
collection_ticker str

Collection ticker

 required
body ModelLookupTickersForMarketInMultivariateEventCollectionRequest
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[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]

Response[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]
Source code in kalshi_py/api/collection/lookup_tickers_for_market_in_multivariate_event_collection.py 
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
async def asyncio_detailed(
    collection_ticker: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelLookupTickersForMarketInMultivariateEventCollectionRequest,
) -> Response[ModelLookupTickersForMarketInMultivariateEventCollectionResponse]:
    """Lookup Tickers For Market In Multivariate Event Collection

      Endpoint for looking up an individual market in a multivariate event collection. If
    CreateMarketInMultivariateEventCollection has never been hit with that variable combination before,
    this will return a 404.

    Args:
        collection_ticker (str): Collection ticker
        body (ModelLookupTickersForMarketInMultivariateEventCollectionRequest):

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

    kwargs = _get_kwargs(
        collection_ticker=collection_ticker,
        body=body,
    )

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

    return _build_response(client=client, response=response)