kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
37 lines (29 loc) • 2.51 kB
Markdown
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**market_ticker** | **string** | The ticker of the market for which to create an RFQ | [default to undefined]
**contracts** | **number** | The number of contracts for the RFQ. Whole contracts only. Contracts may be provided via contracts or contracts_fp; if both provided they must match. | [optional] [default to undefined]
**contracts_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]
**target_cost_centi_cents** | **number** | DEPRECATED: The target cost for the RFQ in centi-cents. Use target_cost_dollars instead. | [optional] [default to undefined]
**target_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\&
**rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [default to undefined]
**replace_existing** | **boolean** | Whether to delete existing RFQs as part of this RFQ\&
**subtrader_id** | **string** | The subtrader to create the RFQ for (FCM members only) | [optional] [default to undefined]
**subaccount** | **number** | The subaccount number to create the RFQ for (direct members only; 0 for primary, 1-32 for subaccounts) | [optional] [default to undefined]
## Example
```typescript
import { CreateRFQRequest } from 'kalshi-typescript';
const instance: CreateRFQRequest = {
market_ticker,
contracts,
contracts_fp,
target_cost_centi_cents,
target_cost_dollars,
rest_remainder,
replace_existing,
subtrader_id,
subaccount,
};
```
[[Back to Model list]](../README.md