kalshi-typescript/docs/Market.md

OpenAPI client for kalshi-typescript

# Market


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ticker** | **string** |  | [default to undefined]
**event_ticker** | **string** |  | [default to undefined]
**market_type** | **string** | Identifies the type of market | [default to undefined]
**title** | **string** |  | [optional] [default to undefined]
**subtitle** | **string** |  | [optional] [default to undefined]
**yes_sub_title** | **string** | Shortened title for the yes side of this market | [default to undefined]
**no_sub_title** | **string** | Shortened title for the no side of this market | [default to undefined]
**created_time** | **string** |  | [default to undefined]
**updated_time** | **string** | Time of the last non-trading metadata update. | [default to undefined]
**open_time** | **string** |  | [default to undefined]
**close_time** | **string** |  | [default to undefined]
**expected_expiration_time** | **string** | Time when this market is expected to expire | [optional] [default to undefined]
**expiration_time** | **string** |  | [optional] [default to undefined]
**latest_expiration_time** | **string** | Latest possible time for this market to expire | [default to undefined]
**settlement_timer_seconds** | **number** | The amount of time after determination that the market settles | [default to undefined]
**status** | **string** | The current status of the market in its lifecycle. | [default to undefined]
**response_price_units** | **string** | DEPRECATED: Use price_level_structure and price_ranges instead. | [optional] [default to undefined]
**yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**yes_bid_size_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
**yes_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**yes_ask_size_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
**no_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**no_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**last_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**volume_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
**volume_24h_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
**result** | **string** |  | [default to undefined]
**can_close_early** | **boolean** |  | [default to undefined]
**fractional_trading_enabled** | **boolean** |  | [default to undefined]
**open_interest_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
**notional_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**previous_yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**previous_yes_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**previous_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**liquidity_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
**settlement_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
**settlement_ts** | **string** | Timestamp when the market was settled. Only filled for settled markets | [optional] [default to undefined]
**expiration_value** | **string** | The value that was considered for the settlement | [default to undefined]
**fee_waiver_expiration_time** | **string** | Time when this market\'s fee waiver expires | [optional] [default to undefined]
**early_close_condition** | **string** | The condition under which the market can close early | [optional] [default to undefined]
**tick_size** | **number** | DEPRECATED: Use price_level_structure and price_ranges instead. | [optional] [default to undefined]
**strike_type** | **string** | Strike type defines how the market strike is defined and evaluated | [optional] [default to undefined]
**floor_strike** | **number** | Minimum expiration value that leads to a YES settlement | [optional] [default to undefined]
**cap_strike** | **number** | Maximum expiration value that leads to a YES settlement | [optional] [default to undefined]
**functional_strike** | **string** | Mapping from expiration values to settlement values | [optional] [default to undefined]
**custom_strike** | **object** | Expiration value for each target that leads to a YES settlement | [optional] [default to undefined]
**rules_primary** | **string** | A plain language description of the most important market terms | [default to undefined]
**rules_secondary** | **string** | A plain language description of secondary market terms | [default to undefined]
**mve_collection_ticker** | **string** | The ticker of the multivariate event collection | [optional] [default to undefined]
**mve_selected_legs** | [**Array<MveSelectedLeg>**](MveSelectedLeg.md) |  | [optional] [default to undefined]
**primary_participant_key** | **string** |  | [optional] [default to undefined]
**price_level_structure** | **string** | Price level structure for this market, defining price ranges and tick sizes | [default to undefined]
**price_ranges** | [**Array<PriceRange>**](PriceRange.md) | Valid price ranges for orders on this market | [default to undefined]
**is_provisional** | **boolean** | If true, the market may be removed after determination if there is no activity on it | [optional] [default to undefined]

## Example

```typescript
import { Market } from 'kalshi-typescript';

const instance: Market = {
    ticker,
    event_ticker,
    market_type,
    title,
    subtitle,
    yes_sub_title,
    no_sub_title,
    created_time,
    updated_time,
    open_time,
    close_time,
    expected_expiration_time,
    expiration_time,
    latest_expiration_time,
    settlement_timer_seconds,
    status,
    response_price_units,
    yes_bid_dollars,
    yes_bid_size_fp,
    yes_ask_dollars,
    yes_ask_size_fp,
    no_bid_dollars,
    no_ask_dollars,
    last_price_dollars,
    volume_fp,
    volume_24h_fp,
    result,
    can_close_early,
    fractional_trading_enabled,
    open_interest_fp,
    notional_value_dollars,
    previous_yes_bid_dollars,
    previous_yes_ask_dollars,
    previous_price_dollars,
    liquidity_dollars,
    settlement_value_dollars,
    settlement_ts,
    expiration_value,
    fee_waiver_expiration_time,
    early_close_condition,
    tick_size,
    strike_type,
    floor_strike,
    cap_strike,
    functional_strike,
    custom_strike,
    rules_primary,
    rules_secondary,
    mve_collection_ticker,
    mve_selected_legs,
    primary_participant_key,
    price_level_structure,
    price_ranges,
    is_provisional,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)