kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
39 lines (31 loc) • 2.08 kB
Markdown
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique identifier for the incentive program | [default to undefined]
**market_id** | **string** | The unique identifier of the market associated with this incentive program | [default to undefined]
**market_ticker** | **string** | The ticker symbol of the market associated with this incentive program | [default to undefined]
**incentive_type** | **string** | Type of incentive program | [default to undefined]
**start_date** | **string** | Start date of the incentive program | [default to undefined]
**end_date** | **string** | End date of the incentive program | [default to undefined]
**period_reward** | **number** | Total reward for the period in centi-cents | [default to undefined]
**paid_out** | **boolean** | Whether the incentive has been paid out | [default to undefined]
**discount_factor_bps** | **number** | Discount factor in basis points (optional) | [optional] [default to undefined]
**target_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. | [optional] [default to undefined]
```typescript
import { IncentiveProgram } from 'kalshi-typescript';
const instance: IncentiveProgram = {
id,
market_id,
market_ticker,
incentive_type,
start_date,
end_date,
period_reward,
paid_out,
discount_factor_bps,
target_size_fp,
};
```
[[Back to Model list]](../README.md