Skip to main content
POST
Verify originator capacity without reserving it

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
market_id
string
required
Maximum string length: 128
outcome_id
string
required
Maximum string length: 128
side
enum<string>
required
Available options:
BUY,
SELL
fill_instruction
enum<string>
required
Available options:
FOK,
FLEXIBLE
hard_reserve_price_atoms
integer<int64>
required

One atom is 0.01 cent of probability-dollar price.

Required range: 0 <= x <= 10000
slippage_reference_policy
enum<string>
required
Available options:
PUBLIC_EXECUTABLE_VWAP,
APPROVED_EXPLICIT
max_cumulative_slippage_bps
integer<int64>
required
Required range: 0 <= x <= 10000
allocation_priority_policy
enum<string>
required

Frozen before invitations; price-first minimizes marginal economics while completion-first may prefer one firm able to complete the target.

Available options:
PRICE_FIRST,
COMPLETION_FIRST
venue_scope
string[]
required
Required array length: 1 - 8 elements
Maximum string length: 64
audience_mode
enum<string>
required
Available options:
MANUAL,
SAVED_GROUP,
RECOMMENDED
identity_disclosure_mode
enum<string>
required
Available options:
CLASS_ONLY,
REVEAL_TO_INVITEES,
REVEAL_ON_AWARD
max_total_execution_time_ms
integer<int64>
required
Required range: 1 <= x <= 120000
idempotency_key
string

May be supplied instead of the header

fixed_quantity_atoms
integer<int64>
Required range: x >= 1
flexible_fill
object

Minimum, target, and maximum are always explicit; SEEK_MAXIMUM may continue beyond the target but never beyond maximum.

slippage_reference_price_atoms
integer<int64>

Required only when slippage_reference_policy is APPROVED_EXPLICIT.

Required range: 0 <= x <= 10000
minimum_private_improvement_bps
integer<int64>
Required range: 0 <= x <= 10000
maximum_mm_concentration_bps
integer<int64>
default:10000
Required range: 1 <= x <= 10000
minimum_mm_reliability_tier
enum<string>
default:UNRATED
Available options:
UNRATED,
C,
B,
A
auction_ttl_ms
integer<int64>
default:5000

Custom sealed bidding window from 2 seconds through 30 days. Omit or send 0 to accept the 5-second default.

Required range: 2000 <= x <= 2592000000
allowed_participants
string[]
Maximum array length: 16
Maximum string length: 128
saved_group_id
string
Maximum string length: 128
excluded_participants
string[]
Maximum array length: 16
Maximum string length: 128
max_recipients
integer
default:16
Required range: 1 <= x <= 16
fallback_ladder
object[]
Maximum array length: 4
client_metadata
object

Bounded non-authoritative display metadata, at most 32 entries and 4 KiB total. market_title and market_provider provide the catalog label. Optional client_order_id is a 1–64 character desk reconciliation reference using letters, numbers, or . _ : / -; it is originator-only and should also derive the create idempotency key.

Response

Current originator route-capacity evidence

status
enum<string>
required
Available options:
EXECUTABLE,
INSUFFICIENT_CAPACITY
requested_quantity_atoms
string
required

Requested maximum quantity encoded exactly.

Pattern: ^[1-9]\d*$
maximum_executable_quantity_atoms
string
required

Minimum currently executable quantity across all requested routes.

Pattern: ^(0|[1-9]\d*)$
checked_at
string<date-time>
required
valid_until
string<date-time>
required

Earliest risk

routes
object[]
required
Required array length: 1 - 5 elements