Skip to content

Communications API Reference

Endpoints

Accept Quote

Synchronous Detailed Response

kalshi_py.api.communications.accept_quote.sync_detailed(quote_id: str, *, client: Union[AuthenticatedClient, Client], body: ModelAcceptQuoteRequest) -> Response[Any]

Accept Quote

Endpoint for accepting a quote. This will require the quoter to confirm

Parameters:

Name Type Description Default
quote_id str

Quote ID

 required
body ModelAcceptQuoteRequest
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[Any]

Response[Any]
Source code in kalshi_py/api/communications/accept_quote.py 
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
def sync_detailed(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelAcceptQuoteRequest,
) -> Response[Any]:
    """Accept Quote

      Endpoint for accepting a quote. This will require the quoter to confirm

    Args:
        quote_id (str): Quote ID
        body (ModelAcceptQuoteRequest):

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

    kwargs = _get_kwargs(
        quote_id=quote_id,
        body=body,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.accept_quote.asyncio_detailed(quote_id: str, *, client: Union[AuthenticatedClient, Client], body: ModelAcceptQuoteRequest) -> Response[Any] async

Accept Quote

Endpoint for accepting a quote. This will require the quoter to confirm

Parameters:

Name Type Description Default
quote_id str

Quote ID

 required
body ModelAcceptQuoteRequest
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[Any]

Response[Any]
Source code in kalshi_py/api/communications/accept_quote.py 
 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
async def asyncio_detailed(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelAcceptQuoteRequest,
) -> Response[Any]:
    """Accept Quote

      Endpoint for accepting a quote. This will require the quoter to confirm

    Args:
        quote_id (str): Quote ID
        body (ModelAcceptQuoteRequest):

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

    kwargs = _get_kwargs(
        quote_id=quote_id,
        body=body,
    )

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

    return _build_response(client=client, response=response)

Confirm Quote

Synchronous Detailed Response

kalshi_py.api.communications.confirm_quote.sync_detailed(quote_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[Any]

Confirm Quote

Endpoint for confirming a quote. This will start a timer for order execution

Parameters:

Name Type Description Default
quote_id str

Quote 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[Any]

Response[Any]
Source code in kalshi_py/api/communications/confirm_quote.py 
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
def sync_detailed(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[Any]:
    """Confirm Quote

      Endpoint for confirming a quote. This will start a timer for order execution

    Args:
        quote_id (str): Quote 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[Any]
    """

    kwargs = _get_kwargs(
        quote_id=quote_id,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.confirm_quote.asyncio_detailed(quote_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[Any] async

Confirm Quote

Endpoint for confirming a quote. This will start a timer for order execution

Parameters:

Name Type Description Default
quote_id str

Quote 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[Any]

Response[Any]
Source code in kalshi_py/api/communications/confirm_quote.py 
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
async def asyncio_detailed(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[Any]:
    """Confirm Quote

      Endpoint for confirming a quote. This will start a timer for order execution

    Args:
        quote_id (str): Quote 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[Any]
    """

    kwargs = _get_kwargs(
        quote_id=quote_id,
    )

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

    return _build_response(client=client, response=response)

Create Quote

Synchronous API Call

kalshi_py.api.communications.create_quote.sync(*, client: Union[AuthenticatedClient, Client], body: ModelCreateQuoteRequest) -> Optional[ModelCreateQuoteResponse]

Create Quote

Endpoint for creating a quote in response to an RFQ

Parameters:

Name Type Description Default
body ModelCreateQuoteRequest
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[ModelCreateQuoteResponse]

ModelCreateQuoteResponse
Source code in kalshi_py/api/communications/create_quote.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateQuoteRequest,
) -> Optional[ModelCreateQuoteResponse]:
    """Create Quote

      Endpoint for creating a quote in response to an RFQ

    Args:
        body (ModelCreateQuoteRequest):

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

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

Asynchronous API Call

kalshi_py.api.communications.create_quote.asyncio(*, client: Union[AuthenticatedClient, Client], body: ModelCreateQuoteRequest) -> Optional[ModelCreateQuoteResponse] async

Create Quote

Endpoint for creating a quote in response to an RFQ

Parameters:

Name Type Description Default
body ModelCreateQuoteRequest
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[ModelCreateQuoteResponse]

ModelCreateQuoteResponse
Source code in kalshi_py/api/communications/create_quote.py 
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
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateQuoteRequest,
) -> Optional[ModelCreateQuoteResponse]:
    """Create Quote

      Endpoint for creating a quote in response to an RFQ

    Args:
        body (ModelCreateQuoteRequest):

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

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

Synchronous Detailed Response

kalshi_py.api.communications.create_quote.sync_detailed(*, client: Union[AuthenticatedClient, Client], body: ModelCreateQuoteRequest) -> Response[ModelCreateQuoteResponse]

Create Quote

Endpoint for creating a quote in response to an RFQ

Parameters:

Name Type Description Default
body ModelCreateQuoteRequest
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[ModelCreateQuoteResponse]

Response[ModelCreateQuoteResponse]
Source code in kalshi_py/api/communications/create_quote.py 
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
82
83
84
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateQuoteRequest,
) -> Response[ModelCreateQuoteResponse]:
    """Create Quote

      Endpoint for creating a quote in response to an RFQ

    Args:
        body (ModelCreateQuoteRequest):

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

    kwargs = _get_kwargs(
        body=body,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.create_quote.asyncio_detailed(*, client: Union[AuthenticatedClient, Client], body: ModelCreateQuoteRequest) -> Response[ModelCreateQuoteResponse] async

Create Quote

Endpoint for creating a quote in response to an RFQ

Parameters:

Name Type Description Default
body ModelCreateQuoteRequest
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[ModelCreateQuoteResponse]

Response[ModelCreateQuoteResponse]
Source code in kalshi_py/api/communications/create_quote.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateQuoteRequest,
) -> Response[ModelCreateQuoteResponse]:
    """Create Quote

      Endpoint for creating a quote in response to an RFQ

    Args:
        body (ModelCreateQuoteRequest):

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

    kwargs = _get_kwargs(
        body=body,
    )

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

    return _build_response(client=client, response=response)

Create Rfq

Synchronous API Call

kalshi_py.api.communications.create_rfq.sync(*, client: Union[AuthenticatedClient, Client], body: ModelCreateRFQRequest) -> Optional[ModelCreateRFQResponse]

Create RFQ

Endpoint for creating a new RFQ

Parameters:

Name Type Description Default
body ModelCreateRFQRequest
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[ModelCreateRFQResponse]

ModelCreateRFQResponse
Source code in kalshi_py/api/communications/create_rfq.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateRFQRequest,
) -> Optional[ModelCreateRFQResponse]:
    """Create RFQ

      Endpoint for creating a new RFQ

    Args:
        body (ModelCreateRFQRequest):

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

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

Asynchronous API Call

kalshi_py.api.communications.create_rfq.asyncio(*, client: Union[AuthenticatedClient, Client], body: ModelCreateRFQRequest) -> Optional[ModelCreateRFQResponse] async

Create RFQ

Endpoint for creating a new RFQ

Parameters:

Name Type Description Default
body ModelCreateRFQRequest
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[ModelCreateRFQResponse]

ModelCreateRFQResponse
Source code in kalshi_py/api/communications/create_rfq.py 
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
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateRFQRequest,
) -> Optional[ModelCreateRFQResponse]:
    """Create RFQ

      Endpoint for creating a new RFQ

    Args:
        body (ModelCreateRFQRequest):

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

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

Synchronous Detailed Response

kalshi_py.api.communications.create_rfq.sync_detailed(*, client: Union[AuthenticatedClient, Client], body: ModelCreateRFQRequest) -> Response[ModelCreateRFQResponse]

Create RFQ

Endpoint for creating a new RFQ

Parameters:

Name Type Description Default
body ModelCreateRFQRequest
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[ModelCreateRFQResponse]

Response[ModelCreateRFQResponse]
Source code in kalshi_py/api/communications/create_rfq.py 
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
82
83
84
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateRFQRequest,
) -> Response[ModelCreateRFQResponse]:
    """Create RFQ

      Endpoint for creating a new RFQ

    Args:
        body (ModelCreateRFQRequest):

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

    kwargs = _get_kwargs(
        body=body,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.create_rfq.asyncio_detailed(*, client: Union[AuthenticatedClient, Client], body: ModelCreateRFQRequest) -> Response[ModelCreateRFQResponse] async

Create RFQ

Endpoint for creating a new RFQ

Parameters:

Name Type Description Default
body ModelCreateRFQRequest
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[ModelCreateRFQResponse]

Response[ModelCreateRFQResponse]
Source code in kalshi_py/api/communications/create_rfq.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    body: ModelCreateRFQRequest,
) -> Response[ModelCreateRFQResponse]:
    """Create RFQ

      Endpoint for creating a new RFQ

    Args:
        body (ModelCreateRFQRequest):

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

    kwargs = _get_kwargs(
        body=body,
    )

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

    return _build_response(client=client, response=response)

Delete Quote

Synchronous Detailed Response

kalshi_py.api.communications.delete_quote.sync_detailed(quote_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[Any]

Delete Quote

Endpoint for deleting a quote, which means it can no longer be accepted.

Parameters:

Name Type Description Default
quote_id str

Quote 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[Any]

Response[Any]
Source code in kalshi_py/api/communications/delete_quote.py 
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
def sync_detailed(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[Any]:
    """Delete Quote

      Endpoint for deleting a quote, which means it can no longer be accepted.

    Args:
        quote_id (str): Quote 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[Any]
    """

    kwargs = _get_kwargs(
        quote_id=quote_id,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.delete_quote.asyncio_detailed(quote_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[Any] async

Delete Quote

Endpoint for deleting a quote, which means it can no longer be accepted.

Parameters:

Name Type Description Default
quote_id str

Quote 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[Any]

Response[Any]
Source code in kalshi_py/api/communications/delete_quote.py 
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
async def asyncio_detailed(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[Any]:
    """Delete Quote

      Endpoint for deleting a quote, which means it can no longer be accepted.

    Args:
        quote_id (str): Quote 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[Any]
    """

    kwargs = _get_kwargs(
        quote_id=quote_id,
    )

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

    return _build_response(client=client, response=response)

Delete Rfq

Synchronous Detailed Response

kalshi_py.api.communications.delete_rfq.sync_detailed(rfq_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[Any]

Delete RFQ

Endpoint for deleting an RFQ by ID

Parameters:

Name Type Description Default
rfq_id str

RFQ 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[Any]

Response[Any]
Source code in kalshi_py/api/communications/delete_rfq.py 
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
def sync_detailed(
    rfq_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[Any]:
    """Delete RFQ

      Endpoint for deleting an RFQ by ID

    Args:
        rfq_id (str): RFQ 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[Any]
    """

    kwargs = _get_kwargs(
        rfq_id=rfq_id,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.delete_rfq.asyncio_detailed(rfq_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[Any] async

Delete RFQ

Endpoint for deleting an RFQ by ID

Parameters:

Name Type Description Default
rfq_id str

RFQ 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[Any]

Response[Any]
Source code in kalshi_py/api/communications/delete_rfq.py 
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
async def asyncio_detailed(
    rfq_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[Any]:
    """Delete RFQ

      Endpoint for deleting an RFQ by ID

    Args:
        rfq_id (str): RFQ 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[Any]
    """

    kwargs = _get_kwargs(
        rfq_id=rfq_id,
    )

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

    return _build_response(client=client, response=response)

Get Communications Id

Synchronous API Call

kalshi_py.api.communications.get_communications_id.sync(*, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetCommunicationsIDResponse]

Get Communications ID

Endpoint for getting the communications ID of the logged-in user.

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

ModelGetCommunicationsIDResponse
Source code in kalshi_py/api/communications/get_communications_id.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[ModelGetCommunicationsIDResponse]:
    """Get Communications ID

      Endpoint for getting the communications ID of the logged-in user.

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

    return sync_detailed(
        client=client,
    ).parsed

Asynchronous API Call

kalshi_py.api.communications.get_communications_id.asyncio(*, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetCommunicationsIDResponse] async

Get Communications ID

Endpoint for getting the communications ID of the logged-in user.

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

ModelGetCommunicationsIDResponse
Source code in kalshi_py/api/communications/get_communications_id.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[ModelGetCommunicationsIDResponse]:
    """Get Communications ID

      Endpoint for getting the communications ID of the logged-in user.

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

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

Synchronous Detailed Response

kalshi_py.api.communications.get_communications_id.sync_detailed(*, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetCommunicationsIDResponse]

Get Communications ID

Endpoint for getting the communications ID of the logged-in user.

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

Response[ModelGetCommunicationsIDResponse]
Source code in kalshi_py/api/communications/get_communications_id.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[ModelGetCommunicationsIDResponse]:
    """Get Communications ID

      Endpoint for getting the communications ID of the logged-in user.

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

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.get_communications_id.asyncio_detailed(*, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetCommunicationsIDResponse] async

Get Communications ID

Endpoint for getting the communications ID of the logged-in user.

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

Response[ModelGetCommunicationsIDResponse]
Source code in kalshi_py/api/communications/get_communications_id.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[ModelGetCommunicationsIDResponse]:
    """Get Communications ID

      Endpoint for getting the communications ID of the logged-in user.

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

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

Get Quote

Synchronous API Call

kalshi_py.api.communications.get_quote.sync(quote_id: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetQuoteResponse]

Get Quote

Endpoint for getting a particular quote

Parameters:

Name Type Description Default
quote_id str

Quote 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[ModelGetQuoteResponse]

ModelGetQuoteResponse
Source code in kalshi_py/api/communications/get_quote.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(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetQuoteResponse]:
    """Get Quote

      Endpoint for getting a particular quote

    Args:
        quote_id (str): Quote 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:
        ModelGetQuoteResponse
    """

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

Asynchronous API Call

kalshi_py.api.communications.get_quote.asyncio(quote_id: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetQuoteResponse] async

Get Quote

Endpoint for getting a particular quote

Parameters:

Name Type Description Default
quote_id str

Quote 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[ModelGetQuoteResponse]

ModelGetQuoteResponse
Source code in kalshi_py/api/communications/get_quote.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(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetQuoteResponse]:
    """Get Quote

      Endpoint for getting a particular quote

    Args:
        quote_id (str): Quote 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:
        ModelGetQuoteResponse
    """

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

Synchronous Detailed Response

kalshi_py.api.communications.get_quote.sync_detailed(quote_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetQuoteResponse]

Get Quote

Endpoint for getting a particular quote

Parameters:

Name Type Description Default
quote_id str

Quote 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[ModelGetQuoteResponse]

Response[ModelGetQuoteResponse]
Source code in kalshi_py/api/communications/get_quote.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(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetQuoteResponse]:
    """Get Quote

      Endpoint for getting a particular quote

    Args:
        quote_id (str): Quote 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[ModelGetQuoteResponse]
    """

    kwargs = _get_kwargs(
        quote_id=quote_id,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.get_quote.asyncio_detailed(quote_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetQuoteResponse] async

Get Quote

Endpoint for getting a particular quote

Parameters:

Name Type Description Default
quote_id str

Quote 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[ModelGetQuoteResponse]

Response[ModelGetQuoteResponse]
Source code in kalshi_py/api/communications/get_quote.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(
    quote_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetQuoteResponse]:
    """Get Quote

      Endpoint for getting a particular quote

    Args:
        quote_id (str): Quote 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[ModelGetQuoteResponse]
    """

    kwargs = _get_kwargs(
        quote_id=quote_id,
    )

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

    return _build_response(client=client, response=response)

Get Quotes

Synchronous API Call

kalshi_py.api.communications.get_quotes.sync(*, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetQuotesResponse]

Get Quotes

Endpoint for getting quotes

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

ModelGetQuotesResponse
Source code in kalshi_py/api/communications/get_quotes.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[ModelGetQuotesResponse]:
    """Get Quotes

      Endpoint for getting quotes

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

    return sync_detailed(
        client=client,
    ).parsed

Asynchronous API Call

kalshi_py.api.communications.get_quotes.asyncio(*, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetQuotesResponse] async

Get Quotes

Endpoint for getting quotes

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

ModelGetQuotesResponse
Source code in kalshi_py/api/communications/get_quotes.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[ModelGetQuotesResponse]:
    """Get Quotes

      Endpoint for getting quotes

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

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

Synchronous Detailed Response

kalshi_py.api.communications.get_quotes.sync_detailed(*, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetQuotesResponse]

Get Quotes

Endpoint for getting quotes

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

Response[ModelGetQuotesResponse]
Source code in kalshi_py/api/communications/get_quotes.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[ModelGetQuotesResponse]:
    """Get Quotes

      Endpoint for getting quotes

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

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.get_quotes.asyncio_detailed(*, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetQuotesResponse] async

Get Quotes

Endpoint for getting quotes

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

Response[ModelGetQuotesResponse]
Source code in kalshi_py/api/communications/get_quotes.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[ModelGetQuotesResponse]:
    """Get Quotes

      Endpoint for getting quotes

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

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

Get Rf Qs

Synchronous API Call

kalshi_py.api.communications.get_rf_qs.sync(*, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetRFQsResponse]

Get RFQs

Endpoint for getting RFQs

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

ModelGetRFQsResponse
Source code in kalshi_py/api/communications/get_rf_qs.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[ModelGetRFQsResponse]:
    """Get RFQs

      Endpoint for getting RFQs

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

    return sync_detailed(
        client=client,
    ).parsed

Asynchronous API Call

kalshi_py.api.communications.get_rf_qs.asyncio(*, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetRFQsResponse] async

Get RFQs

Endpoint for getting RFQs

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

ModelGetRFQsResponse
Source code in kalshi_py/api/communications/get_rf_qs.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[ModelGetRFQsResponse]:
    """Get RFQs

      Endpoint for getting RFQs

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

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

Synchronous Detailed Response

kalshi_py.api.communications.get_rf_qs.sync_detailed(*, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetRFQsResponse]

Get RFQs

Endpoint for getting RFQs

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

Response[ModelGetRFQsResponse]
Source code in kalshi_py/api/communications/get_rf_qs.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[ModelGetRFQsResponse]:
    """Get RFQs

      Endpoint for getting RFQs

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

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.get_rf_qs.asyncio_detailed(*, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetRFQsResponse] async

Get RFQs

Endpoint for getting RFQs

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

Response[ModelGetRFQsResponse]
Source code in kalshi_py/api/communications/get_rf_qs.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[ModelGetRFQsResponse]:
    """Get RFQs

      Endpoint for getting RFQs

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

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

Get Rfq

Synchronous API Call

kalshi_py.api.communications.get_rfq.sync(rfq_id: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetRFQResponse]

Get RFQ

Endpoint for getting a single RFQ by id

Parameters:

Name Type Description Default
rfq_id str

RFQ 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[ModelGetRFQResponse]

ModelGetRFQResponse
Source code in kalshi_py/api/communications/get_rfq.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(
    rfq_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetRFQResponse]:
    """Get RFQ

      Endpoint for getting a single RFQ by id

    Args:
        rfq_id (str): RFQ 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:
        ModelGetRFQResponse
    """

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

Asynchronous API Call

kalshi_py.api.communications.get_rfq.asyncio(rfq_id: str, *, client: Union[AuthenticatedClient, Client]) -> Optional[ModelGetRFQResponse] async

Get RFQ

Endpoint for getting a single RFQ by id

Parameters:

Name Type Description Default
rfq_id str

RFQ 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[ModelGetRFQResponse]

ModelGetRFQResponse
Source code in kalshi_py/api/communications/get_rfq.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(
    rfq_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[ModelGetRFQResponse]:
    """Get RFQ

      Endpoint for getting a single RFQ by id

    Args:
        rfq_id (str): RFQ 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:
        ModelGetRFQResponse
    """

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

Synchronous Detailed Response

kalshi_py.api.communications.get_rfq.sync_detailed(rfq_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetRFQResponse]

Get RFQ

Endpoint for getting a single RFQ by id

Parameters:

Name Type Description Default
rfq_id str

RFQ 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[ModelGetRFQResponse]

Response[ModelGetRFQResponse]
Source code in kalshi_py/api/communications/get_rfq.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(
    rfq_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetRFQResponse]:
    """Get RFQ

      Endpoint for getting a single RFQ by id

    Args:
        rfq_id (str): RFQ 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[ModelGetRFQResponse]
    """

    kwargs = _get_kwargs(
        rfq_id=rfq_id,
    )

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

    return _build_response(client=client, response=response)

Asynchronous Detailed Response

kalshi_py.api.communications.get_rfq.asyncio_detailed(rfq_id: str, *, client: Union[AuthenticatedClient, Client]) -> Response[ModelGetRFQResponse] async

Get RFQ

Endpoint for getting a single RFQ by id

Parameters:

Name Type Description Default
rfq_id str

RFQ 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[ModelGetRFQResponse]

Response[ModelGetRFQResponse]
Source code in kalshi_py/api/communications/get_rfq.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(
    rfq_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[ModelGetRFQResponse]:
    """Get RFQ

      Endpoint for getting a single RFQ by id

    Args:
        rfq_id (str): RFQ 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[ModelGetRFQResponse]
    """

    kwargs = _get_kwargs(
        rfq_id=rfq_id,
    )

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

    return _build_response(client=client, response=response)