kalshi-typescript 2.1.2 → 3.0.0

package/docs/PriceDistribution.md

@@ -0,0 +1,50 @@
+# PriceDistribution
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**open** | **number** | First traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
+**open_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
+**low** | **number** | Lowest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
+**low_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
+**high** | **number** | Highest traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
+**high_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
+**close** | **number** | Last traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
+**close_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
+**mean** | **number** | Mean traded YES contract price on the market during the candlestick period (in cents). May be null if there was no trade during the period. | [optional] [default to undefined]
+**mean_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
+**previous** | **number** | Last traded YES contract price on the market before the candlestick period (in cents). May be null if there were no trades before the period. | [optional] [default to undefined]
+**previous_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
+**min** | **number** | Minimum close price of any market during the candlestick period (in cents). | [optional] [default to undefined]
+**min_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
+**max** | **number** | Maximum close price of any market during the candlestick period (in cents). | [optional] [default to undefined]
+**max_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PriceDistribution } from 'kalshi-typescript';
+
+const instance: PriceDistribution = {
+    open,
+    open_dollars,
+    low,
+    low_dollars,
+    high,
+    high_dollars,
+    close,
+    close_dollars,
+    mean,
+    mean_dollars,
+    previous,
+    previous_dollars,
+    min,
+    min_dollars,
+    max,
+    max_dollars,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PriceRange.md

@@ -0,0 +1,24 @@
+# PriceRange
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **string** | Starting price for this range in dollars | [default to undefined]
+**end** | **string** | Ending price for this range in dollars | [default to undefined]
+**step** | **string** | Price step/tick size for this range in dollars | [default to undefined]
+
+## Example
+
+```typescript
+import { PriceRange } from 'kalshi-typescript';
+
+const instance: PriceRange = {
+    start,
+    end,
+    step,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Quote.md

@@ -5,15 +5,31 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**quote_id** | **string** |  | [optional] [default to undefined]
-**rfq_id** | **string** |  | [optional] [default to undefined]
-**quoter_id** | **string** |  | [optional] [default to undefined]
-**price** | **number** |  | [optional] [default to undefined]
-**size** | **number** |  | [optional] [default to undefined]
-**side** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**created_ts** | **string** |  | [optional] [default to undefined]
-**expires_ts** | **string** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier for the quote | [default to undefined]
+**rfq_id** | **string** | ID of the RFQ this quote is responding to | [default to undefined]
+**creator_id** | **string** | Public communications ID of the quote creator | [default to undefined]
+**rfq_creator_id** | **string** | Public communications ID of the RFQ creator | [default to undefined]
+**market_ticker** | **string** | The ticker of the market this quote is for | [default to undefined]
+**contracts** | **number** | Number of contracts in the quote | [default to undefined]
+**yes_bid** | **number** | Bid price for YES contracts, in cents | [default to undefined]
+**no_bid** | **number** | Bid price for NO contracts, in cents | [default to undefined]
+**yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
+**no_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
+**created_ts** | **string** | Timestamp when the quote was created | [default to undefined]
+**updated_ts** | **string** | Timestamp when the quote was last updated | [default to undefined]
+**status** | **string** | Current status of the quote | [default to undefined]
+**accepted_side** | **string** | The side that was accepted (yes or no) | [optional] [default to undefined]
+**accepted_ts** | **string** | Timestamp when the quote was accepted | [optional] [default to undefined]
+**confirmed_ts** | **string** | Timestamp when the quote was confirmed | [optional] [default to undefined]
+**executed_ts** | **string** | Timestamp when the quote was executed | [optional] [default to undefined]
+**cancelled_ts** | **string** | Timestamp when the quote was cancelled | [optional] [default to undefined]
+**rest_remainder** | **boolean** | Whether to rest the remainder of the quote after execution | [optional] [default to undefined]
+**cancellation_reason** | **string** | Reason for quote cancellation if cancelled | [optional] [default to undefined]
+**creator_user_id** | **string** | User ID of the quote creator (private field) | [optional] [default to undefined]
+**rfq_creator_user_id** | **string** | User ID of the RFQ creator (private field) | [optional] [default to undefined]
+**rfq_target_cost_centi_cents** | **number** | Total value requested in the RFQ in centi-cents | [optional] [default to undefined]
+**rfq_creator_order_id** | **string** | Order ID for the RFQ creator (private field) | [optional] [default to undefined]
+**creator_order_id** | **string** | Order ID for the quote creator (private field) | [optional] [default to undefined]
 
 ## Example
 
@@ -21,15 +37,31 @@ Name | Type | Description | Notes
 import { Quote } from 'kalshi-typescript';
 
 const instance: Quote = {
-    quote_id,
+    id,
     rfq_id,
-    quoter_id,
-    price,
-    size,
-    side,
-    status,
+    creator_id,
+    rfq_creator_id,
+    market_ticker,
+    contracts,
+    yes_bid,
+    no_bid,
+    yes_bid_dollars,
+    no_bid_dollars,
     created_ts,
-    expires_ts,
+    updated_ts,
+    status,
+    accepted_side,
+    accepted_ts,
+    confirmed_ts,
+    executed_ts,
+    cancelled_ts,
+    rest_remainder,
+    cancellation_reason,
+    creator_user_id,
+    rfq_creator_user_id,
+    rfq_target_cost_centi_cents,
+    rfq_creator_order_id,
+    creator_order_id,
 };
 ```
 

package/docs/RFQ.md

@@ -5,14 +5,20 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**rfq_id** | **string** |  | [optional] [default to undefined]
-**requester_id** | **string** |  | [optional] [default to undefined]
-**ticker** | **string** |  | [optional] [default to undefined]
-**side** | **string** |  | [optional] [default to undefined]
-**size** | **number** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**created_ts** | **string** |  | [optional] [default to undefined]
-**expires_ts** | **string** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier for the RFQ | [default to undefined]
+**creator_id** | **string** | Public communications ID of the RFQ creator | [default to undefined]
+**market_ticker** | **string** | The ticker of the market this RFQ is for | [default to undefined]
+**contracts** | **number** | Number of contracts requested in the RFQ | [default to undefined]
+**target_cost_centi_cents** | **number** | Total value of the RFQ in centi-cents | [optional] [default to undefined]
+**status** | **string** | Current status of the RFQ (open, closed) | [default to undefined]
+**created_ts** | **string** | Timestamp when the RFQ was created | [default to undefined]
+**mve_collection_ticker** | **string** | Ticker of the MVE collection this market belongs to | [optional] [default to undefined]
+**mve_selected_legs** | [**Array<MveSelectedLeg>**](MveSelectedLeg.md) | Selected legs for the MVE collection | [optional] [default to undefined]
+**rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [optional] [default to undefined]
+**cancellation_reason** | **string** | Reason for RFQ cancellation if cancelled | [optional] [default to undefined]
+**creator_user_id** | **string** | User ID of the RFQ creator (private field) | [optional] [default to undefined]
+**cancelled_ts** | **string** | Timestamp when the RFQ was cancelled | [optional] [default to undefined]
+**updated_ts** | **string** | Timestamp when the RFQ was last updated | [optional] [default to undefined]
 
 ## Example
 
@@ -20,14 +26,20 @@ Name | Type | Description | Notes
 import { RFQ } from 'kalshi-typescript';
 
 const instance: RFQ = {
-    rfq_id,
-    requester_id,
-    ticker,
-    side,
-    size,
+    id,
+    creator_id,
+    market_ticker,
+    contracts,
+    target_cost_centi_cents,
     status,
     created_ts,
-    expires_ts,
+    mve_collection_ticker,
+    mve_selected_legs,
+    rest_remainder,
+    cancellation_reason,
+    creator_user_id,
+    cancelled_ts,
+    updated_ts,
 };
 ```
 

package/docs/Schedule.md

@@ -0,0 +1,22 @@
+# Schedule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**standard_hours** | [**Array<WeeklySchedule>**](WeeklySchedule.md) | The standard operating hours of the exchange. All times are expressed in ET. Outside of these times trading will be unavailable. | [default to undefined]
+**maintenance_windows** | [**Array<MaintenanceWindow>**](MaintenanceWindow.md) | Scheduled maintenance windows, during which the exchange may be unavailable. | [default to undefined]
+
+## Example
+
+```typescript
+import { Schedule } from 'kalshi-typescript';
+
+const instance: Schedule = {
+    standard_hours,
+    maintenance_windows,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ScopeList.md

@@ -0,0 +1,20 @@
+# ScopeList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scopes** | **Array<string>** | List of scopes | [default to undefined]
+
+## Example
+
+```typescript
+import { ScopeList } from 'kalshi-typescript';
+
+const instance: ScopeList = {
+    scopes,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SearchApi.md

@@ -0,0 +1,69 @@
+# SearchApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFiltersForSports**](#getfiltersforsports) | **GET** /search/filters_by_sport | Get Filters for Sports|
+|[**getTagsForSeriesCategories**](#gettagsforseriescategories) | **GET** /search/tags_by_categories | Get Tags for Series Categories|
+
+# **getFiltersForSports**
+> GetFiltersBySportsResponse getFiltersForSports()
+
+Retrieve available filters organized by sport.  This endpoint returns filtering options available for each sport, including scopes and competitions. It also provides an ordered list of sports for display purposes. 
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetFiltersBySportsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Filters retrieved successfully |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getTagsForSeriesCategories**
+> GetTagsForSeriesCategoriesResponse getTagsForSeriesCategories()
+
+Retrieve tags organized by series categories.  This endpoint returns a mapping of series categories to their associated tags, which can be used for filtering and search functionality. 
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetTagsForSeriesCategoriesResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Tags retrieved successfully |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/SelfTradePreventionType.md

@@ -0,0 +1,11 @@
+# SelfTradePreventionType
+
+The self-trade prevention type for orders
+
+## Enum
+
+* `TakerAtCross` (value: `'taker_at_cross'`)
+
+* `Maker` (value: `'maker'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Series.md

@@ -5,10 +5,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ticker** | **string** | The ticker symbol for this series | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**category** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
+**ticker** | **string** | Ticker that identifies this series. | [default to undefined]
+**frequency** | **string** | Description of the frequency of the series. There is no fixed value set here, but will be something human-readable like weekly, daily, one-off. | [default to undefined]
+**title** | **string** | Title describing the series. For full context use you should use this field with the title field of the events belonging to this series. | [default to undefined]
+**category** | **string** | Category specifies the category which this series belongs to. | [default to undefined]
+**tags** | **Array<string>** | Tags specifies the subjects that this series relates to, multiple series from different categories can have the same tags. | [default to undefined]
+**settlement_sources** | [**Array<SettlementSource>**](SettlementSource.md) | SettlementSources specifies the official sources used for the determination of markets within the series. Methodology is defined in the rulebook. | [default to undefined]
+**contract_url** | **string** | ContractUrl provides a direct link to the original filing of the contract which underlies the series. | [default to undefined]
+**contract_terms_url** | **string** | ContractTermsUrl is the URL to the current terms of the contract underlying the series. | [default to undefined]
+**product_metadata** | **object** | Internal product metadata of the series. | [optional] [default to undefined]
+**fee_type** | **string** | FeeType is a string representing the series\' fee structure. Fee structures can be found at https://kalshi.com/docs/kalshi-fee-schedule.pdf. \'quadratic\' is described by the General Trading Fees Table, \'quadratic_with_maker_fees\' is described by the General Trading Fees Table with maker fees described in the Maker Fees section, \'flat\' is described by the Specific Trading Fees Table. | [default to undefined]
+**fee_multiplier** | **number** | FeeMultiplier is a floating point multiplier applied to the fee calculations. | [default to undefined]
+**additional_prohibitions** | **Array<string>** | AdditionalProhibitions is a list of additional trading prohibitions for this series. | [default to undefined]
 
 ## Example
 
@@ -17,9 +25,17 @@ import { Series } from 'kalshi-typescript';
 
 const instance: Series = {
     ticker,
+    frequency,
     title,
     category,
-    status,
+    tags,
+    settlement_sources,
+    contract_url,
+    contract_terms_url,
+    product_metadata,
+    fee_type,
+    fee_multiplier,
+    additional_prohibitions,
 };
 ```
 

package/docs/SeriesApi.md

@@ -119,4 +119,3 @@ const { status, data } = await apiInstance.getSeriesByTicker(
 |**500** | Internal server error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/SeriesFeeChange.md

@@ -0,0 +1,28 @@
+# SeriesFeeChange
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for this fee change | [default to undefined]
+**series_ticker** | **string** | Series ticker this fee change applies to | [default to undefined]
+**fee_type** | **string** | New fee type for the series | [default to undefined]
+**fee_multiplier** | **number** | New fee multiplier for the series | [default to undefined]
+**scheduled_ts** | **string** | Timestamp when this fee change is scheduled to take effect | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesFeeChange } from 'kalshi-typescript';
+
+const instance: SeriesFeeChange = {
+    id,
+    series_ticker,
+    fee_type,
+    fee_multiplier,
+    scheduled_ts,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Settlement.md

@@ -5,12 +5,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ticker** | **string** |  | [optional] [default to undefined]
-**result** | **string** |  | [optional] [default to undefined]
-**yes_count** | **number** |  | [optional] [default to undefined]
-**no_count** | **number** |  | [optional] [default to undefined]
-**revenue** | **number** |  | [optional] [default to undefined]
-**settled_time** | **string** |  | [optional] [default to undefined]
+**ticker** | **string** | The ticker symbol of the market that was settled. | [default to undefined]
+**market_result** | **string** | The outcome of the market settlement. \'yes\' = market resolved to YES, \'no\' = market resolved to NO, \'scalar\' = scalar market settled at a specific value, \'void\' = market was voided/cancelled and all positions returned at original cost. | [default to undefined]
+**yes_count** | **number** | Number of YES contracts owned at the time of settlement. | [default to undefined]
+**yes_total_cost** | **number** | Total cost basis of all YES contracts in cents. | [default to undefined]
+**no_count** | **number** | Number of NO contracts owned at the time of settlement. | [default to undefined]
+**no_total_cost** | **number** | Total cost basis of all NO contracts in cents. | [default to undefined]
+**revenue** | **number** | Total revenue earned from this settlement in cents (winning contracts pay out 100 cents each). | [default to undefined]
+**settled_time** | **string** | Timestamp when the market was settled and payouts were processed. | [default to undefined]
+**fee_cost** | **string** | Total fees paid in fixed point dollars. | [default to undefined]
+**value** | **number** | Payout of a single yes contract in cents. | [optional] [default to undefined]
 
 ## Example
 
@@ -19,11 +23,15 @@ import { Settlement } from 'kalshi-typescript';
 
 const instance: Settlement = {
     ticker,
-    result,
+    market_result,
     yes_count,
+    yes_total_cost,
     no_count,
+    no_total_cost,
     revenue,
     settled_time,
+    fee_cost,
+    value,
 };
 ```
 

package/docs/SettlementSource.md

@@ -0,0 +1,22 @@
+# SettlementSource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the settlement source | [optional] [default to undefined]
+**url** | **string** | URL to the settlement source | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SettlementSource } from 'kalshi-typescript';
+
+const instance: SettlementSource = {
+    name,
+    url,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SportFilterDetails.md

@@ -0,0 +1,22 @@
+# SportFilterDetails
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scopes** | **Array<string>** | List of scopes available for this sport | [default to undefined]
+**competitions** | [**{ [key: string]: ScopeList; }**](ScopeList.md) | Mapping of competitions to their scope lists | [default to undefined]
+
+## Example
+
+```typescript
+import { SportFilterDetails } from 'kalshi-typescript';
+
+const instance: SportFilterDetails = {
+    scopes,
+    competitions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StructuredTarget.md

@@ -5,9 +5,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**structured_target_id** | **string** |  | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier for the structured target. | [optional] [default to undefined]
+**name** | **string** | Name of the structured target. | [optional] [default to undefined]
+**type** | **string** | Type of the structured target. | [optional] [default to undefined]
+**details** | **object** | Additional details about the structured target. Contains flexible JSON data specific to the target type. | [optional] [default to undefined]
+**source_id** | **string** | External source identifier for the structured target, if available (e.g., third-party data provider ID). | [optional] [default to undefined]
+**last_updated_ts** | **string** | Timestamp when this structured target was last updated. | [optional] [default to undefined]
 
 ## Example
 
@@ -15,9 +18,12 @@ Name | Type | Description | Notes
 import { StructuredTarget } from 'kalshi-typescript';
 
 const instance: StructuredTarget = {
-    structured_target_id,
-    title,
-    status,
+    id,
+    name,
+    type,
+    details,
+    source_id,
+    last_updated_ts,
 };
 ```
 

package/docs/StructuredTargetsApi.md

@@ -10,28 +10,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
 # **getStructuredTarget**
 > GetStructuredTargetResponse getStructuredTarget()
 
-Get a single structured target by ID
-
-### Example
-
-```typescript
-import {
-    StructuredTargetsApi,
-    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 StructuredTargetsApi(configuration);
-
-let structuredTargetId: string; //Structured target ID (default to undefined)
-
-const { status, data } = await apiInstance.getStructuredTarget(
-    structuredTargetId
-);
-```
+ Endpoint for getting data about a specific structured target by its ID.
 
 ### Parameters
 
@@ -46,7 +25,7 @@ const { status, data } = await apiInstance.getStructuredTarget(
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+No authorization required
 
 ### HTTP request headers
 
@@ -58,46 +37,23 @@ const { status, data } = await apiInstance.getStructuredTarget(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Structured target retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**404** | Resource not found |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
 |**500** | Internal server error |  -  |
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **getStructuredTargets**
 > GetStructuredTargetsResponse getStructuredTargets()
 
-Get all structured targets
-
-### Example
-
-```typescript
-import {
-    StructuredTargetsApi,
-    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 StructuredTargetsApi(configuration);
-
-let status: string; //Filter by structured target status (optional) (default to undefined)
-let pageSize: number; //Number of items per page (minimum 100, default 100) (optional) (default to 100)
-
-const { status, data } = await apiInstance.getStructuredTargets(
-    status,
-    pageSize
-);
-```
+Page size (min: 1, max: 2000)
 
 ### Parameters
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **status** | [**string**] | Filter by structured target status | (optional) defaults to undefined|
-| **pageSize** | [**number**] | Number of items per page (minimum 100, default 100) | (optional) defaults to 100|
+| **type** | [**string**] | Filter by structured target type | (optional) defaults to undefined|
+| **competition** | [**string**] | Filter by competition | (optional) defaults to undefined|
+| **pageSize** | [**number**] | Number of items per page (min 1, max 2000, default 100) | (optional) defaults to 100|
+| **cursor** | [**string**] | Pagination cursor | (optional) defaults to undefined|
 
 
 ### Return type
@@ -106,7 +62,7 @@ const { status, data } = await apiInstance.getStructuredTargets(
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+No authorization required
 
 ### HTTP request headers
 
@@ -118,8 +74,6 @@ const { status, data } = await apiInstance.getStructuredTargets(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Structured targets retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
+|**401** | Unauthorized |  -  |
 |**500** | Internal server error |  -  |
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-