Structs§
- Account
Balance - USDC balance for a single trading account.
- ApiResponse
- Generic envelope for all API responses.
- Competition
Data - Full metadata for a trading competition.
- Competition
Leaderboard Response - Paginated competition leaderboard with optional connected-user context.
- Competition
Response - Response containing a single competition.
- Competition
Update Request - Admin request to partially update an existing competition.
- Competition
Upsert Request - Admin request to create a new competition.
- Competitions
Response - Paginated list of competitions.
- Connected
User Rank - The requesting (connected) user’s own rank on the leaderboard.
- Delete
MmpConfig Request - Signed request to delete an MMP configuration.
- Delete
User Tier Request - Admin request to remove a custom tier assignment (revert to default).
- Exchange
Info Response - Public exchange configuration for frontend deposit/withdraw integration.
- Extended
Risk Matrix Response - Full risk matrix showing per-instrument PnL across all SPAN scenarios.
- Fill
ApiResponse - A single fill (one side of a trade) for a specific wallet.
- Fills
Response - Paginated list of fills.
- GetMmp
Config Query - GetUser
Tier Query - Health
Response - Simple health-check response from
GET /health. - Instrument
- Server-canonical representation of a tradable option instrument.
- Instrument
Risk RowResponse - Per-instrument row in the extended risk matrix.
- Leaderboard
Row - A single row on the competition leaderboard.
- Margin
Mode ApiResponse - API envelope for margin mode operations.
- Margin
Mode Response - Result of a margin mode switch.
- Margin
Summary - Unified margin summary that works for both Standard and Portfolio modes.
- Market
- Market
Info - Summary of a single expiry’s market data for one underlying.
- Markets
Response - Response containing all available markets.
- MmpConfig
Data - Market Maker Protection (MMP) configuration for a wallet and currency.
- MmpConfig
Response - Response listing MMP configurations for a wallet.
- Monitoring
Account Summary - Admin monitoring summary for a single account.
- Monitoring
Accounts Response - Admin monitoring response listing all accounts.
- Monitoring
Position Holder - A single wallet holding a position in a monitored symbol.
- Monitoring
Positions Response - Admin monitoring response listing positions grouped by symbol.
- Monitoring
Symbol Position - Aggregated position data for one symbol across all holders (admin monitoring).
- Options
Chain Greeks Abs - Absolute (per-contract) option Greeks.
- Options
Chain Greeks Cash - Cash-denominated option Greeks (dollar impact per unit move).
- Options
Chain Leg - A single call or put leg in the options chain, including top-of-book quotes and Greeks.
- Options
Chain Snapshot Response - Full options chain snapshot for one underlying and expiry.
- Options
Chain Strike Row - A single strike row in the options chain, pairing call and put legs.
- Order
- A resting or historical order on the matching engine.
- Orders
Response - Pagination
- Pagination info for list responses.
- Portfolio
- Full portfolio snapshot for a single account.
- Portfolio
Greeks Aggregate - Aggregate Greeks across all positions in a portfolio.
- Portfolio
Greeks Response - Full portfolio Greeks breakdown: per-leg detail and aggregate totals.
- Position
- A single open position for one instrument.
- Position
Greeks Leg - Greeks for a single position leg in a portfolio.
- Position
With Metrics - Position enriched with derived risk metrics. Flattened in JSON (no nested
positionkey). - Profile
Competition Rank Summary - Summary of a user’s rank in a specific competition, shown on their profile.
- Profile
Data - Aggregated profile data for a single user.
- Profile
Margin Stats - Margin statistics shown on a user’s profile.
- Profile
Metric Medals - Platform-wide medals earned by a user across all competitions.
- Profile
PnlStats - PnL statistics shown on a user’s profile.
- Profile
Response - Response containing a user’s full profile.
- Profile
Trades Response - Paginated list of a user’s trade fills, shown on their profile.
- Readiness
Component Report - Readiness status of one internal component (DB, engine, oracles, etc.).
- Ready
Response - Aggregated readiness probe response from
GET /ready. - Realized
PnlResponse - Response containing per-symbol realized PnL.
- Realized
PnlRow - Realized PnL breakdown for one instrument symbol.
- Reset
MmpRequest - Signed request to reset (unfreeze) a triggered MMP state.
- Risk
Grid Response - Top-level SPAN risk grid response for an account.
- Risk
Grid Scenario - A single SPAN risk-grid scenario with its computed PnL.
- Scenario
Definition - Definition of a risk scenario (without computed PnL).
- SetMargin
Mode Request - Request to set margin mode.
- SetMmp
Config Request - Signed request to create or update an MMP configuration.
- SetUser
Tier Request - Admin request to assign a fee/rate-limit tier to a wallet.
- Signing
Domain Info - EIP-712 domain parameters for frontend signing.
- Simulated
Greeks Order - A hypothetical order used for simulating portfolio Greeks impact.
- Span
Margin Summary - SPAN-based portfolio margin breakdown for an account.
- Trade
- Trade
ApiResponse - A matched trade between a maker and a taker.
- Trades
Response - Paginated list of trades.
- Trading
Limits - Rate and capacity limits for a given tier.
- User
Tier Data - A wallet’s assigned fee/rate-limit tier.
- User
Tier Response - Response containing a wallet’s current tier assignment.
- Version
Response - Build version and git metadata returned by
GET /version.
Enums§
- Competition
Sort ByValue - Field to sort the leaderboard by. Serialized as lowercase.
- Competition
Sort Order Value - Sort direction for leaderboard queries. Serialized as lowercase.
- Competition
State Value - Lifecycle state of a trading competition. Serialized as lowercase.
- Competition
WinCondition Value - Metric used to determine competition winners. Serialized as lowercase.
- Instrument
Status - Lifecycle state of a tradable instrument.