kalshi-typescript/docs/Series.md

OpenAPI client for kalshi-typescript

# Series


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ticker** | **string** | Ticker that identifies this series. | [default to undefined]
**frequency** | **string** | Description of the frequency of the series. There is no fixed value set here, but will be something human-readable like weekly, daily, one-off. | [default to undefined]
**title** | **string** | Title describing the series. For full context use you should use this field with the title field of the events belonging to this series. | [default to undefined]
**category** | **string** | Category specifies the category which this series belongs to. | [default to undefined]
**tags** | **Array<string>** | Tags specifies the subjects that this series relates to, multiple series from different categories can have the same tags. | [default to undefined]
**settlement_sources** | [**Array<SettlementSource>**](SettlementSource.md) | SettlementSources specifies the official sources used for the determination of markets within the series. Methodology is defined in the rulebook. | [default to undefined]
**contract_url** | **string** | ContractUrl provides a direct link to the original filing of the contract which underlies the series. | [default to undefined]
**contract_terms_url** | **string** | ContractTermsUrl is the URL to the current terms of the contract underlying the series. | [default to undefined]
**product_metadata** | **object** | Internal product metadata of the series. | [optional] [default to undefined]
**fee_type** | **string** | FeeType is a string representing the series\' fee structure. Fee structures can be found at https://kalshi.com/docs/kalshi-fee-schedule.pdf. \'quadratic\' is described by the General Trading Fees Table, \'quadratic_with_maker_fees\' is described by the General Trading Fees Table with maker fees described in the Maker Fees section, \'flat\' is described by the Specific Trading Fees Table. | [default to undefined]
**fee_multiplier** | **number** | FeeMultiplier is a floating point multiplier applied to the fee calculations. | [default to undefined]
**additional_prohibitions** | **Array<string>** | AdditionalProhibitions is a list of additional trading prohibitions for this series. | [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. | [optional] [default to undefined]
**last_updated_ts** | **string** | Timestamp of when this series\' metadata was last updated. | [optional] [default to undefined]

## Example

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

const instance: Series = {
    ticker,
    frequency,
    title,
    category,
    tags,
    settlement_sources,
    contract_url,
    contract_terms_url,
    product_metadata,
    fee_type,
    fee_multiplier,
    additional_prohibitions,
    volume_fp,
    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)