kalshi-typescript/docs/Settlement.md

OpenAPI client for kalshi-typescript

# Settlement


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ticker** | **string** | The ticker symbol of the market that was settled. | [default to undefined]
**event_ticker** | **string** | The event 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_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_total_cost_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_count_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_total_cost_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]
**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** | 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]
**value** | **number** | Payout of a single yes contract in cents. | [optional] [default to undefined]

## Example

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

const instance: Settlement = {
    ticker,
    event_ticker,
    market_result,
    yes_count_fp,
    yes_total_cost_dollars,
    no_count_fp,
    no_total_cost_dollars,
    revenue,
    settled_time,
    fee_cost,
    value,
};
```

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