UNPKG

kalshi-typescript

Version:
35 lines (27 loc) 2.65 kB
# MarketPosition ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ticker** | **string** | Unique identifier for the market | [default to undefined] **total_traded_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] **position_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] **market_exposure_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] **realized_pnl_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] **resting_orders_count** | **number** | [DEPRECATED] Aggregate size of resting orders in contract units | [default to undefined] **fees_paid_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_updated_ts** | **string** | Last time the position is updated | [default to undefined] ## Example ```typescript import { MarketPosition } from 'kalshi-typescript'; const instance: MarketPosition = { ticker, total_traded_dollars, position_fp, market_exposure_dollars, realized_pnl_dollars, resting_orders_count, fees_paid_dollars, last_updated_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)