kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
47 lines (39 loc) • 2.81 kB
Markdown
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique identifier for the RFQ | [default to undefined]
**creator_id** | **string** | Public communications ID of the RFQ creator. | [default to undefined]
**market_ticker** | **string** | The ticker of the market this RFQ is for | [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. | [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\&
**status** | **string** | Current status of the RFQ (open, closed) | [default to undefined]
**created_ts** | **string** | Timestamp when the RFQ was created | [default to undefined]
**mve_collection_ticker** | **string** | Ticker of the MVE collection this market belongs to | [optional] [default to undefined]
**mve_selected_legs** | [**Array<MveSelectedLeg>**](MveSelectedLeg.md) | Selected legs for the MVE collection | [optional] [default to undefined]
**rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [optional] [default to undefined]
**cancellation_reason** | **string** | Reason for RFQ cancellation if cancelled | [optional] [default to undefined]
**creator_user_id** | **string** | User ID of the RFQ creator (private field) | [optional] [default to undefined]
**cancelled_ts** | **string** | Timestamp when the RFQ was cancelled | [optional] [default to undefined]
**updated_ts** | **string** | Timestamp when the RFQ was last updated | [optional] [default to undefined]
## Example
```typescript
import { RFQ } from 'kalshi-typescript';
const instance: RFQ = {
id,
creator_id,
market_ticker,
contracts_fp,
target_cost_dollars,
status,
created_ts,
mve_collection_ticker,
mve_selected_legs,
rest_remainder,
cancellation_reason,
creator_user_id,
cancelled_ts,
updated_ts,
};
```
[[Back to Model list]](../README.md