Module responses
Expand description
API response types.
Structs§
- ApiResponse
- Generic API response wrapper.
- Approve
Agent Response - Response for approving an agent.
- Authorized
Agents Response - Response listing authorized agents.
- Bulk
Cancel Order Response - Response from bulk cancel operation.
- Bulk
Order Result - Result for a single order in a bulk operation.
- Bulk
Place Order Response - Response from bulk order placement.
- Competition
Account Pnl - Competition account PnL response payload.
- Competition
Account Response - Competition account response.
- Competition
Connected User Rank - Connected wallet summary on a competition leaderboard response.
- Competition
Leaderboard Response - Competition leaderboard response.
- Competition
Leaderboard Row - Competition leaderboard row.
- Competition
PnlStanding - Competition PnL standing for a single wallet.
- Competition
PnlSummary - Competition PnL summary for a wallet.
- Competition
PnlSummary Response - Competition summary response.
- Fill
- Fill (trade execution) information.
- Historical
PnlPoint - A single historical equity point.
- Historical
PnlResponse - Historical equity response for a wallet and interval.
- Historical
Theo Point - A single historical theoretical-price point.
- Historical
Theo Response - Historical theo response for an instrument and interval.
- Instrument
- Server-canonical representation of a tradable option instrument.
- Instrument
Response - Instrument information response.
- Instrument
Spec Response - Canonical instrument specification for discovery, quoting, and lifecycle consumers.
- Json
RpcError - JSON-RPC error information.
- Json
RpcResponse - JSON-RPC style response.
- L2Message
- L2 message (orderbook delta).
- L2Update
- L2 update (price level change).
- Margin
Summary - Unified margin summary that works for both Standard and Portfolio modes.
- Market
- Market information.
- Market
Info - Summary of a single expiry’s market data for one underlying.
- Market
Response - Simple market response (for create/delete).
- Market
Update Message - Market update message.
- Markets
Response - Response containing all available markets.
- Option
Greeks - Option
Summary - Option summary (for fetching underlying price).
- Order
Book Greeks - Option Greeks for order book.
- Order
Book Response - Orderbook response.
- Order
Book Stats - Order book statistics.
- Order
Info - Order information.
- Order
Message - Order message (response from order placement).
- Order
Update Message - Order update message.
- Orderbook
Update - Orderbook snapshot.
- Orders
Response - Orders list response.
- Pagination
- Pagination info for list responses.
- Portfolio
Position - Position information in portfolio response.
- Portfolio
Response - Portfolio response from the API.
- Quote
Provider Response - Quote provider info (admin response).
- Revoke
Agent Response - Response for revoking an agent.
- RfqAccept
Response - Response after accepting an RFQ quote.
- RfqHistory
Response - RFQ history response.
- RfqLeg
Response - RFQ leg in status response.
- RfqQuote
LegResponse - Response for an RFQ quote leg.
- RfqQuote
Response - A single quote from a QP.
- RfqStatus
Response - Full RFQ status response.
- Tick
Size Step - Tick size step for instrument pricing.
- Trade
Message - Trade message.
Enums§
- Historical
PnlInterval - Historical equity interval identifier.
- Historical
Theo Interval - Historical theo interval identifier.
Constants§
- HISTORICAL_
PNL_ INTERVAL_ 1D_ MS - Supported historical equity snapshot intervals.
- HISTORICAL_
PNL_ INTERVAL_ 1H_ MS - Supported historical equity snapshot intervals.
- HISTORICAL_
PNL_ INTERVAL_ 5M_ MS - Supported historical equity snapshot intervals.
- HISTORICAL_
THEO_ INTERVAL_ 1D_ MS - Supported historical theo snapshot intervals.
- HISTORICAL_
THEO_ INTERVAL_ 1H_ MS - Supported historical theo snapshot intervals.
- HISTORICAL_
THEO_ INTERVAL_ 5M_ MS - Supported historical theo snapshot intervals.