kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
77 lines (76 loc) • 3.4 kB
TypeScript
/**
* Kalshi Trade API Manual Endpoints
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
*
* The version of the OpenAPI document: 3.11.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { SettlementSource } from './settlement-source';
export interface Series {
/**
* Ticker that identifies this series.
*/
'ticker': 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.
*/
'frequency': 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.
*/
'title': string;
/**
* Category specifies the category which this series belongs to.
*/
'category': string;
/**
* Tags specifies the subjects that this series relates to, multiple series from different categories can have the same tags.
*/
'tags': Array<string>;
/**
* SettlementSources specifies the official sources used for the determination of markets within the series. Methodology is defined in the rulebook.
*/
'settlement_sources': Array<SettlementSource>;
/**
* ContractUrl provides a direct link to the original filing of the contract which underlies the series.
*/
'contract_url': string;
/**
* ContractTermsUrl is the URL to the current terms of the contract underlying the series.
*/
'contract_terms_url': string;
/**
* Internal product metadata of the series.
*/
'product_metadata'?: object | null;
/**
* 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.
*/
'fee_type': SeriesFeeTypeEnum;
/**
* FeeMultiplier is a floating point multiplier applied to the fee calculations.
*/
'fee_multiplier': number;
/**
* AdditionalProhibitions is a list of additional trading prohibitions for this series.
*/
'additional_prohibitions': Array<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.
*/
'volume_fp'?: string;
/**
* Timestamp of when this series\' metadata was last updated.
*/
'last_updated_ts'?: string;
}
export declare const SeriesFeeTypeEnum: {
readonly Quadratic: "quadratic";
readonly QuadraticWithMakerFees: "quadratic_with_maker_fees";
readonly Flat: "flat";
};
export type SeriesFeeTypeEnum = typeof SeriesFeeTypeEnum[keyof typeof SeriesFeeTypeEnum];