kalshi-typescript/docs/MarketCandlestick.md

OpenAPI client for kalshi-typescript

# MarketCandlestick


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**end_period_ts** | **number** | Unix timestamp for the inclusive end of the candlestick period. | [default to undefined]
**yes_bid** | [**BidAskDistribution**](BidAskDistribution.md) |  | [default to undefined]
**yes_ask** | [**BidAskDistribution**](BidAskDistribution.md) |  | [default to undefined]
**price** | [**PriceDistribution**](PriceDistribution.md) |  | [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]
**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]

## Example

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

const instance: MarketCandlestick = {
    end_period_ts,
    yes_bid,
    yes_ask,
    price,
    volume_fp,
    open_interest_fp,
};
```

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