# MultivariateApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createMarketInMultivariateEventCollection**](#createmarketinmultivariateeventcollection) | **POST** /multivariate_event_collections/{collection_ticker} | Create Market In Multivariate Event Collection|
|[**getMultivariateEventCollection**](#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection|
|[**getMultivariateEventCollectionLookupHistory**](#getmultivariateeventcollectionlookuphistory) | **GET** /multivariate_event_collections/{collection_ticker}/lookup | Get Multivariate Event Collection Lookup History|
|[**getMultivariateEventCollections**](#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections|
|[**lookupTickersForMarketInMultivariateEventCollection**](#lookuptickersformarketinmultivariateeventcollection) | **PUT** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Tickers For Market In Multivariate Event Collection|

# **createMarketInMultivariateEventCollection**
> CreateMarketInMultivariateEventCollectionResponse createMarketInMultivariateEventCollection(createMarketInMultivariateEventCollectionRequest)

Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **createMarketInMultivariateEventCollectionRequest** | **CreateMarketInMultivariateEventCollectionRequest**|  | |
| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|


### Return type

**CreateMarketInMultivariateEventCollectionResponse**

### Authorization

[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Market created successfully |  -  |
|**400** | Bad request - invalid input |  -  |
|**401** | Unauthorized - authentication required |  -  |
|**429** | Rate limit exceeded |  -  |
|**500** | Internal server error |  -  |

# **getMultivariateEventCollection**
> GetMultivariateEventCollectionResponse getMultivariateEventCollection()

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|


### Return type

**GetMultivariateEventCollectionResponse**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Collection retrieved successfully |  -  |
|**400** | Bad request - invalid input |  -  |
|**404** | Resource not found |  -  |
|**500** | Internal server error |  -  |

# **getMultivariateEventCollectionLookupHistory**
> GetMultivariateEventCollectionLookupHistoryResponse getMultivariateEventCollectionLookupHistory()

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
| **lookbackSeconds** | [**10 | 60 | 300 | 3600**]**Array<10 &#124; 60 &#124; 300 &#124; 3600>** | Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600. | defaults to undefined|


### Return type

**GetMultivariateEventCollectionLookupHistoryResponse**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Lookup history retrieved successfully |  -  |
|**400** | Bad request - invalid input |  -  |
|**500** | Internal server error |  -  |

# **getMultivariateEventCollections**
> GetMultivariateEventCollectionsResponse getMultivariateEventCollections()

 Endpoint for getting data about multivariate event collections.

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **status** | [**&#39;unopened&#39; | &#39;open&#39; | &#39;closed&#39;**]**Array<&#39;unopened&#39; &#124; &#39;open&#39; &#124; &#39;closed&#39;>** | Only return collections of a certain status. Can be unopened, open, or closed. | (optional) defaults to undefined|
| **associatedEventTicker** | [**string**] | Only return collections associated with a particular event ticker. | (optional) defaults to undefined|
| **seriesTicker** | [**string**] | Only return collections with a particular series ticker. | (optional) defaults to undefined|
| **limit** | [**number**] | Specify the maximum number of results. | (optional) defaults to undefined|
| **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point. | (optional) defaults to undefined|


### Return type

**GetMultivariateEventCollectionsResponse**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Collections retrieved successfully |  -  |
|**400** | Bad request - invalid input |  -  |
|**500** | Internal server error |  -  |

# **lookupTickersForMarketInMultivariateEventCollection**
> LookupTickersForMarketInMultivariateEventCollectionResponse lookupTickersForMarketInMultivariateEventCollection(lookupTickersForMarketInMultivariateEventCollectionRequest)

 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  | Notes|
|------------- | ------------- | ------------- | -------------|
| **lookupTickersForMarketInMultivariateEventCollectionRequest** | **LookupTickersForMarketInMultivariateEventCollectionRequest**|  | |
| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|


### Return type

**LookupTickersForMarketInMultivariateEventCollectionResponse**

### Authorization

[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Market looked up successfully |  -  |
|**400** | Bad request - invalid input |  -  |
|**401** | Unauthorized - authentication required |  -  |
|**404** | Resource not found |  -  |
|**500** | Internal server error |  -  |