Skip to main content
All URIs are relative to https://api.elections.kalshi.com/trade-api/v2
MethodHTTP requestDescription
getMultivariateEventCollectionGET /multivariate_event_collections/Get Multivariate Event Collection
getMultivariateEventCollectionsGET /multivariate_event_collectionsGet Multivariate Event Collections
lookupMultivariateEventCollectionBundlePOST /multivariate_event_collections//lookupLookup Multivariate Event Collection Bundle

​
getMultivariateEventCollection

GetMultivariateEventCollectionResponse getMultivariateEventCollection()
Get a single multivariate event collection by ticker

​
Example

import {
    MultivariateCollectionsApi,
    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 MultivariateCollectionsApi(configuration);

let collectionTicker: string; //Collection ticker (default to undefined)

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

​
Parameters

NameTypeDescriptionNotes
collectionTicker[string]Collection tickerdefaults to undefined

​
Return type

GetMultivariateEventCollectionResponse

​
Authorization

bearerAuth

​
HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

​
HTTP response details

Status codeDescriptionResponse headers
200Collection retrieved successfully-
401Unauthorized - authentication required-
404Resource not found-
500Internal server error-
[Back to top] [Back to API list] [Back to Model list] [Back to README]

​
getMultivariateEventCollections

GetMultivariateEventCollectionsResponse getMultivariateEventCollections()
Get all multivariate event collections

​
Example

import {
    MultivariateCollectionsApi,
    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 MultivariateCollectionsApi(configuration);

let status: string; //Filter by multivariate collection status (optional) (default to undefined)

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

​
Parameters

NameTypeDescriptionNotes
status[string]Filter by multivariate collection status(optional) defaults to undefined

​
Return type

GetMultivariateEventCollectionsResponse

​
Authorization

bearerAuth

​
HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

​
HTTP response details

Status codeDescriptionResponse headers
200Collections retrieved successfully-
401Unauthorized - authentication required-
500Internal server error-
[Back to top] [Back to API list] [Back to Model list] [Back to README]

​
lookupMultivariateEventCollectionBundle

LookupBundleResponse lookupMultivariateEventCollectionBundle(lookupBundleRequest)
Lookup a bundle in a multivariate event collection

​
Example

import {
    MultivariateCollectionsApi,
    Configuration,
    LookupBundleRequest
} 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 MultivariateCollectionsApi(configuration);

let collectionTicker: string; //Collection ticker (default to undefined)
let lookupBundleRequest: LookupBundleRequest; //

const { status, data } = await apiInstance.lookupMultivariateEventCollectionBundle(
    collectionTicker,
    lookupBundleRequest
);

​
Parameters

NameTypeDescriptionNotes
lookupBundleRequestLookupBundleRequest
collectionTicker[string]Collection tickerdefaults to undefined

​
Return type

LookupBundleResponse

​
Authorization

bearerAuth

​
HTTP request headers

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

​
HTTP response details

Status codeDescriptionResponse headers
200Bundle lookup successful-
400Bad request - invalid input-
401Unauthorized - authentication required-
404Resource not found-
500Internal server error-
[Back to top] [Back to API list] [Back to Model list] [Back to README]