All URIs are relative to https://api.elections.kalshi.com/trade-api/v2

Method	HTTP request	Description
acceptQuote	PUT /communications/quotes//accept	Accept Quote
confirmQuote	PUT /communications/quotes//confirm	Confirm Quote
createQuote	POST /communications/quotes	Create Quote
createRFQ	POST /communications/rfqs	Create RFQ
deleteQuote	DELETE /communications/quotes/	Delete Quote
deleteRFQ	DELETE /communications/rfqs/	Delete RFQ
getCommunicationsID	GET /communications/id	Get Communications ID
getQuote	GET /communications/quotes/	Get Quote
getQuotes	GET /communications/quotes	Get Quotes
getRFQ	GET /communications/rfqs/	Get RFQ
getRFQs	GET /communications/rfqs	Get RFQs

acceptQuote

acceptQuote(acceptQuoteRequest)

Accept a quote. This will require the quoter to confirm

Example

import {
    CommunicationsApi,
    Configuration,
    AcceptQuoteRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

let quoteId: string; //Quote ID (default to undefined)
let acceptQuoteRequest: AcceptQuoteRequest; //

const { status, data } = await apiInstance.acceptQuote(
    quoteId,
    acceptQuoteRequest
);

Parameters

Name	Type	Description	Notes
acceptQuoteRequest	AcceptQuoteRequest
quoteId	[string]	Quote ID	defaults to undefined

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Quote accepted successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

confirmQuote

confirmQuote()

Confirm a quote. This will start a timer for order execution

Example

import {
    CommunicationsApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

let quoteId: string; //Quote ID (default to undefined)

const { status, data } = await apiInstance.confirmQuote(
    quoteId
);

Parameters

Name	Type	Description	Notes
quoteId	[string]	Quote ID	defaults to undefined

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Quote confirmed successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createQuote

CreateQuoteResponse createQuote(createQuoteRequest)

Create a quote in response to an RFQ

Example

import {
    CommunicationsApi,
    Configuration,
    CreateQuoteRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

let createQuoteRequest: CreateQuoteRequest; //

const { status, data } = await apiInstance.createQuote(
    createQuoteRequest
);

Parameters

Name	Type	Description	Notes
createQuoteRequest	CreateQuoteRequest

Return type

CreateQuoteResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Quote created successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createRFQ

CreateRFQResponse createRFQ(createRFQRequest)

Create a new RFQ

Example

import {
    CommunicationsApi,
    Configuration,
    CreateRFQRequest
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

let createRFQRequest: CreateRFQRequest; //

const { status, data } = await apiInstance.createRFQ(
    createRFQRequest
);

Parameters

Name	Type	Description	Notes
createRFQRequest	CreateRFQRequest

Return type

CreateRFQResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	RFQ created successfully	-
400	Bad request - invalid input	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteQuote

deleteQuote()

Delete a quote, which means it can no longer be accepted

Example

import {
    CommunicationsApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

let quoteId: string; //Quote ID (default to undefined)

const { status, data } = await apiInstance.deleteQuote(
    quoteId
);

Parameters

Name	Type	Description	Notes
quoteId	[string]	Quote ID	defaults to undefined

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Quote deleted successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteRFQ

deleteRFQ()

Delete an RFQ by ID

Example

import {
    CommunicationsApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

let rfqId: string; //RFQ ID (default to undefined)

const { status, data } = await apiInstance.deleteRFQ(
    rfqId
);

Parameters

Name	Type	Description	Notes
rfqId	[string]	RFQ ID	defaults to undefined

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	RFQ deleted successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCommunicationsID

GetCommunicationsIDResponse getCommunicationsID()

Get the communications ID of the logged-in user

Example

import {
    CommunicationsApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

const { status, data } = await apiInstance.getCommunicationsID();

Parameters

This endpoint does not have any parameters.

Return type

GetCommunicationsIDResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Communications ID retrieved successfully	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getQuote

GetQuoteResponse getQuote()

Get a particular quote by ID

Example

import {
    CommunicationsApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

let quoteId: string; //Quote ID (default to undefined)

const { status, data } = await apiInstance.getQuote(
    quoteId
);

Parameters

Name	Type	Description	Notes
quoteId	[string]	Quote ID	defaults to undefined

Return type

GetQuoteResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Quote retrieved successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getQuotes

GetQuotesResponse getQuotes()

Retrieve all quotes

Example

import {
    CommunicationsApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

const { status, data } = await apiInstance.getQuotes();

Parameters

This endpoint does not have any parameters.

Return type

GetQuotesResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Quotes retrieved successfully	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRFQ

GetRFQResponse getRFQ()

Get a single RFQ by ID

Example

import {
    CommunicationsApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

let rfqId: string; //RFQ ID (default to undefined)

const { status, data } = await apiInstance.getRFQ(
    rfqId
);

Parameters

Name	Type	Description	Notes
rfqId	[string]	RFQ ID	defaults to undefined

Return type

GetRFQResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	RFQ retrieved successfully	-
401	Unauthorized - authentication required	-
404	Resource not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRFQs

GetRFQsResponse getRFQs()

Retrieve all RFQs

Example

import {
    CommunicationsApi,
    Configuration
} from 'kalshi-typescript';

const configuration = new Configuration({
    apiKey: 'your-api-key-id',
    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
});
const apiInstance = new CommunicationsApi(configuration);

const { status, data } = await apiInstance.getRFQs();

Parameters

This endpoint does not have any parameters.

Return type

GetRFQsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	RFQs retrieved successfully	-
401	Unauthorized - authentication required	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Python

TypeScript

​acceptQuote

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​confirmQuote

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​createQuote

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​createRFQ

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​deleteQuote

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​deleteRFQ

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getCommunicationsID

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getQuote

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getQuotes

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getRFQ

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

​getRFQs

​Example

​Parameters

​Return type

​Authorization

​HTTP request headers

​HTTP response details

acceptQuote

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

confirmQuote

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createQuote

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createRFQ

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteQuote

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteRFQ

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCommunicationsID

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getQuote

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getQuotes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRFQ

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRFQs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details