kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
31 lines (23 loc) • 2.08 kB
Markdown
# MarketCandlestickHistorical
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**end_period_ts** | **number** | Unix timestamp for the inclusive end of the candlestick period. | [default to undefined]
**yes_bid** | [**BidAskDistributionHistorical**](BidAskDistributionHistorical.md) | | [default to undefined]
**yes_ask** | [**BidAskDistributionHistorical**](BidAskDistributionHistorical.md) | | [default to undefined]
**price** | [**PriceDistributionHistorical**](PriceDistributionHistorical.md) | | [default to undefined]
**volume** | **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** | **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 { MarketCandlestickHistorical } from 'kalshi-typescript';
const instance: MarketCandlestickHistorical = {
end_period_ts,
yes_bid,
yes_ask,
price,
volume,
open_interest,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)