kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
69 lines (61 loc) • 5.45 kB
Markdown
# Quote
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique identifier for the quote | [default to undefined]
**rfq_id** | **string** | ID of the RFQ this quote is responding to | [default to undefined]
**creator_id** | **string** | Public communications ID of the quote creator | [default to undefined]
**rfq_creator_id** | **string** | Public communications ID of the RFQ creator | [default to undefined]
**market_ticker** | **string** | The ticker of the market this quote 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]
**yes_bid_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\'s price level structure. | [default to undefined]
**no_bid_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\'s price level structure. | [default to undefined]
**created_ts** | **string** | Timestamp when the quote was created | [default to undefined]
**updated_ts** | **string** | Timestamp when the quote was last updated | [default to undefined]
**status** | **string** | Current status of the quote | [default to undefined]
**accepted_side** | **string** | The side that was accepted (yes or no) | [optional] [default to undefined]
**accepted_ts** | **string** | Timestamp when the quote was accepted | [optional] [default to undefined]
**confirmed_ts** | **string** | Timestamp when the quote was confirmed | [optional] [default to undefined]
**executed_ts** | **string** | Timestamp when the quote was executed | [optional] [default to undefined]
**cancelled_ts** | **string** | Timestamp when the quote was cancelled | [optional] [default to undefined]
**rest_remainder** | **boolean** | Whether to rest the remainder of the quote after execution | [optional] [default to undefined]
**cancellation_reason** | **string** | Reason for quote cancellation if cancelled | [optional] [default to undefined]
**creator_user_id** | **string** | User ID of the quote creator (private field) | [optional] [default to undefined]
**rfq_creator_user_id** | **string** | User ID of the RFQ creator (private field) | [optional] [default to undefined]
**rfq_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\'s price level structure. | [optional] [default to undefined]
**rfq_creator_order_id** | **string** | Order ID for the RFQ creator (private field) | [optional] [default to undefined]
**creator_order_id** | **string** | Order ID for the quote creator (private field) | [optional] [default to undefined]
**yes_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]
**no_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]
## Example
```typescript
import { Quote } from 'kalshi-typescript';
const instance: Quote = {
id,
rfq_id,
creator_id,
rfq_creator_id,
market_ticker,
contracts_fp,
yes_bid_dollars,
no_bid_dollars,
created_ts,
updated_ts,
status,
accepted_side,
accepted_ts,
confirmed_ts,
executed_ts,
cancelled_ts,
rest_remainder,
cancellation_reason,
creator_user_id,
rfq_creator_user_id,
rfq_target_cost_dollars,
rfq_creator_order_id,
creator_order_id,
yes_contracts_fp,
no_contracts_fp,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)