Klineo/Docs
Open app ↗

API schemas

StructuredPolicyRequest

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
clauses Yes Array of object Min items: 1; Max items: 32
clauses[].field Yes string Allowed: EXECUTABLE_DEPTH_QUOTE, PRICE_BAND_PIPS, MAXIMUM_TREASURY_DEPLOYMENT_PIPS, MAXIMUM_SLIPPAGE_PIPS, MINIMUM_PRICE_X18, MAXIMUM_DAILY_TURNOVER_PIPS, COOLDOWN_SECONDS
clauses[].operator Yes string Allowed: EQ, LTE, GTE
clauses[].value Yes AtomicAmount —
clauses[].unit Yes string Allowed: QUOTE_ATOMIC, PIPS, PRICE_X18, SECONDS
reason Yes string Min length: 3; Max length: 500

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/StructuredPolicyRequest in the OpenAPI contract.