stx-python 0.6.0__py3-none-any.whl

stx/models.py

@@ -0,0 +1,2034 @@
+"""Response models for the STX REST API.
+
+Generated by ``python -m tools.generate_models`` from
+``spec/openapi.json`` (source commit ``6a6ca2731ac6870f65999f86c857a5e6a28b1f5b``).
+Do not edit by hand; regenerate after refreshing the spec.
+
+Money and quantity fields are ``str``, exactly as the API sends them.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Dict, List, Optional
+
+from pydantic import Field
+
+from stx._base import STXModel
+
+__all__ = [
+    "Balance",
+    "BookLevel",
+    "Cancellation",
+    "Error",
+    "Event",
+    "FeeTransaction",
+    "Fill",
+    "Market",
+    "MarketFilter",
+    "MarketStat",
+    "Me",
+    "NewOrder",
+    "Order",
+    "PaymentTransaction",
+    "Position",
+    "RecentTrade",
+    "Settlement",
+    "StatDetail",
+    "Transaction",
+]
+
+
+class Balance(STXModel):
+    """One account's balance and fee summary, in the dollar wire format."""
+
+    account_balance: Optional[str] = Field(
+        None,
+        description="The account's cash balance. Unaffected by placing an order - not all of it may be available. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    account_id: Optional[str] = Field(
+        None,
+        description='The account this balance is for.',
+    )
+
+    available_balance: Optional[str] = Field(
+        None,
+        description='The balance available to withdraw or place further orders with. Rounded **down** to the cent, so it never overstates what is spendable. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    base_fee_percent: Optional[float] = Field(
+        None,
+        description='The fee percentage on the `fixed_percent` schedule; `null` for any other schedule. A number, not a money string.',
+    )
+
+    buy_order_liability: Optional[str] = Field(
+        None,
+        description='Total liability from buy orders, including the potential trade-fee reserve. Rounded **up** to the cent. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    escrow: Optional[str] = Field(
+        None,
+        description="The account's escrow balance. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    fee_schedule: Optional[str] = Field(
+        None,
+        description="The account's fee schedule. One of: ``fixed_percent``, ``revenue_share``, ``loyalty_tier``, ``fixed_percent_market_group``, ``fixed_percent_event``, ``on_trade``, ``loyalty_tier_on_trade``.",
+    )
+
+    loyalty_tier: Optional[str] = Field(
+        None,
+        description="The account's loyalty tier. Every account has one; new accounts start at `rookie`. One of: ``rookie``, ``veteran``, ``all_star``, ``mvp``, ``hall_of_fame``.",
+    )
+
+    maker_factor: Optional[float] = Field(
+        None,
+        description='Per-trade maker fee factor, present only on the `on_trade` and `loyalty_tier_on_trade` schedules; `null` otherwise. A number, not a money string.',
+    )
+
+    points: Optional[int] = Field(
+        None,
+        description='Loyalty points the account has accumulated. A whole number, not a money string.',
+    )
+
+    position_premium_liability: Optional[str] = Field(
+        None,
+        description='Total liability from position premiums. Routinely negative. Rounded **up** to the cent in both signs. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    sell_order_liability: Optional[str] = Field(
+        None,
+        description='Total liability from sell orders, including the potential trade-fee reserve. Rounded **up** to the cent. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    taker_factor: Optional[float] = Field(
+        None,
+        description='Per-trade taker fee factor, present only on the `on_trade` and `loyalty_tier_on_trade` schedules; `null` otherwise. A number, not a money string.',
+    )
+
+    total_adjustments: Optional[str] = Field(
+        None,
+        description='Lifetime total balance adjustments. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_deposits: Optional[str] = Field(
+        None,
+        description='Lifetime total deposits. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_fees: Optional[str] = Field(
+        None,
+        description='Total fees from all settlements and other fees. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_settlement_pnl: Optional[str] = Field(
+        None,
+        description='Total gross profit and loss from all settlements. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_trade_count: Optional[int] = Field(
+        None,
+        description='The number of trades the account has made across every market.',
+    )
+
+    total_traded: Optional[str] = Field(
+        None,
+        description='The risk the account has committed across every market. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_withdrawals: Optional[str] = Field(
+        None,
+        description='Lifetime total withdrawals. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    user_id: Optional[str] = Field(
+        None,
+        description='The user that owns the account.',
+    )
+
+
+class BookLevel(STXModel):
+    """One price level of resting size on the book."""
+
+    price: Optional[str] = Field(
+        None,
+        description='The price of this level. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    quantity: Optional[str] = Field(
+        None,
+        description='Contracts resting at this price. Quantity as a decimal string, as sent by the API.',
+    )
+
+
+class Cancellation(STXModel):
+    """The outcome of cancelling one order."""
+
+    order_id: Optional[str] = Field(
+        None,
+        description='The order this outcome relates to.',
+    )
+
+    status: Optional[str] = Field(
+        None,
+        description='The order status after cancelling, or a reason it was not cancelled - "Order not found" for an unknown id.',
+    )
+
+
+class Error(STXModel):
+    """The failure envelope returned by every non-2xx response."""
+
+    error: Optional[str] = Field(
+        None,
+        description='Human-readable failure reason, e.g. "Missing or invalid API key credentials" or "The order\'s price must be lower than 1.00".',
+    )
+
+
+class Event(STXModel):
+    """A sporting event that markets hang off."""
+
+    archived: Optional[bool] = Field(
+        None,
+        description='Is this event archived or not',
+    )
+
+    competition: Optional[str] = Field(
+        None,
+        description='The competition for this event',
+    )
+
+    event_id: Optional[str] = Field(
+        None,
+        description='The event the market belongs to.',
+    )
+
+    event_type: Optional[str] = Field(
+        None,
+        description='The event_type of this event - ad_hoc, baseball_game, basketball_game etc',
+    )
+
+    participants: Optional[List[Dict[str, Any]]] = Field(
+        None,
+        description='The map of participants in the event.',
+    )
+
+    promoted: Optional[bool] = Field(
+        None,
+        description='Is this event promoted or not',
+    )
+
+    short_title: Optional[str] = Field(
+        None,
+        description='The short title for this event',
+    )
+
+    sport: Optional[str] = Field(
+        None,
+        description='The sport for this event',
+    )
+
+    start_time: Optional[int] = Field(
+        None,
+        description='Start time of this event UNIX microseconds.',
+    )
+
+    start_time_iso: Optional[str] = Field(
+        None,
+        description='Start time of this event',
+    )
+
+    status: Optional[str] = Field(
+        None,
+        description='The status of this event One of: ``scheduled``, ``in_progress``, ``completed``, ``cancelled``.',
+    )
+
+    symbol: Optional[str] = Field(
+        None,
+        description='The STX symbol for this event',
+    )
+
+    title: Optional[str] = Field(
+        None,
+        description='The title of this event',
+    )
+
+
+class FeeTransaction(STXModel):
+    """One fee charged against the account, or a refund of one."""
+
+    account_id: Optional[str] = Field(
+        None,
+        description='The account the record belongs to.',
+    )
+
+    amount: Optional[str] = Field(
+        None,
+        description='The monetary value the entry was calculated from. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    event_id: Optional[str] = Field(
+        None,
+        description='The event the market belongs to.',
+    )
+
+    fee_id: Optional[str] = Field(
+        None,
+        description='The fee that generated this entry, when it came from one.',
+    )
+
+    id: Optional[str] = Field(
+        None,
+        description='Unique identifier for the record.',
+    )
+
+    inserted_at: Optional[int] = Field(
+        None,
+        description='Creation time, as UNIX microseconds.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market this record relates to.',
+    )
+
+    payment_id: Optional[str] = Field(
+        None,
+        description='The payment that generated this entry, when it came from one.',
+    )
+
+    points: Optional[float] = Field(
+        None,
+        description='Points added by this entry. Negative when points were spent.',
+    )
+
+    settlement_id: Optional[str] = Field(
+        None,
+        description='The settlement that generated this entry, when it came from one.',
+    )
+
+    time: Optional[str] = Field(
+        None,
+        description='When the entry was recorded.',
+    )
+
+    type: Optional[str] = Field(
+        None,
+        description='What moved the money or the points - for example a deposit, a trade fee, a referral, or a manual adjustment. Each endpoint returns only its own subset of these. One of: ``deposit``, ``withdrawal``, ``settlement``, ``fee``, ``fee_refund``, ``casino``, ``adjustment``, ``loyalty``, ``loyalty_points_rollup``, ``loyalty_points_referral``.',
+    )
+
+
+class Fill(STXModel):
+    """One fill against one of your orders."""
+
+    account_id: Optional[str] = Field(
+        None,
+        description='The account the record belongs to.',
+    )
+
+    action: Optional[str] = Field(
+        None,
+        description='The action of the trade relative to the user. One of: ``buy``, ``sell``.',
+    )
+
+    admin_log: Optional[Dict[str, Any]] = Field(
+        None,
+        description='Internal. Operator audit trail, not part of the supported contract - do not depend on it.',
+    )
+
+    amended: Optional[bool] = Field(
+        None,
+        description='True if an operator has amended this trade. When true, compare `original_price` and `original_filled` against the current values.',
+    )
+
+    client_order_id: Optional[str] = Field(
+        None,
+        description='The client order id of the order that produced this trade, when one was supplied.',
+    )
+
+    closed_contracts: Optional[str] = Field(
+        None,
+        description='The number of contracts closed on this trade. Quantity as a decimal string, as sent by the API.',
+    )
+
+    closed_fee: Optional[str] = Field(
+        None,
+        description='The fee the user paid when closing the trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closed_net_pnl: Optional[str] = Field(
+        None,
+        description='Realised profit or loss on the closed portion. Negative for a loss. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closed_pnl: Optional[str] = Field(
+        None,
+        description='The profit or loss the user made by closing the trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closing: Optional[str] = Field(
+        None,
+        description='The amount of contracts (in position) that the trade is closing. Quantity as a decimal string, as sent by the API.',
+    )
+
+    device_id: Optional[str] = Field(
+        None,
+        description="The player's device associated with this trade",
+    )
+
+    expired_contracts: Optional[str] = Field(
+        None,
+        description='Number of contracts settled when market expired. Quantity as a decimal string, as sent by the API.',
+    )
+
+    expired_fee: Optional[str] = Field(
+        None,
+        description='The fee paid by the user when the market expired. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    expired_net_pnl: Optional[str] = Field(
+        None,
+        description='Realised profit or loss on the expired portion. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    expired_pnl: Optional[str] = Field(
+        None,
+        description='The profit or loss the user make on the trade when the market expired. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    expires_at: Optional[int] = Field(
+        None,
+        description='When the trade expires if the market has not settled, as UNIX microseconds.',
+    )
+
+    filled: Optional[str] = Field(
+        None,
+        description='The number of contracts that were traded. Quantity as a decimal string, as sent by the API.',
+    )
+
+    gross_pnl: Optional[str] = Field(
+        None,
+        description='The gross PNL as a result of the trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    inserted_at: Optional[int] = Field(
+        None,
+        description='Creation time, as UNIX microseconds.',
+    )
+
+    ip_address: Optional[str] = Field(
+        None,
+        description='The IP address associated with this trade',
+    )
+
+    last_modified_at: Optional[int] = Field(
+        None,
+        description='When an operator last amended this trade, as UNIX microseconds. Null unless `amended` is true.',
+    )
+
+    last_modified_by_admin_id: Optional[str] = Field(
+        None,
+        description='Internal. Operator audit field, not part of the supported contract - do not depend on it.',
+    )
+
+    liquidity_action: Optional[str] = Field(
+        None,
+        description='Whether the associated order was the `provider` or the `taker` of the liquidity. One of: ``provider``, ``taker``.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market this record relates to.',
+    )
+
+    opened_at: Optional[int] = Field(
+        None,
+        description='When the position opened, as UNIX microseconds.',
+    )
+
+    order_id: Optional[str] = Field(
+        None,
+        description='The ID of the order that caused the trade.',
+    )
+
+    original_filled: Optional[str] = Field(
+        None,
+        description='Contracts filled at execution, before any amendment. Quantity as a decimal string, as sent by the API.',
+    )
+
+    original_premium: Optional[str] = Field(
+        None,
+        description='The amount of premium received for the original trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    original_price: Optional[str] = Field(
+        None,
+        description='Fill price at execution. Unchanged by later amendments. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    original_risk: Optional[str] = Field(
+        None,
+        description='The original risk introduced for the original trade excluding `closed`. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    original_to_win: Optional[str] = Field(
+        None,
+        description='The original to win introduced for the original trade excluding `closed`. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    pc_premium: Optional[str] = Field(
+        None,
+        description='The amount of premium per contract. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    pc_risk: Optional[str] = Field(
+        None,
+        description='The amount of risk per contract. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    pc_to_win: Optional[str] = Field(
+        None,
+        description='The amount to win per contract. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    placed_pre_start: Optional[bool] = Field(
+        None,
+        description='True if the order was placed before the event started.',
+    )
+
+    points: Optional[float] = Field(
+        None,
+        description='The total number of loyalty points awarded as a result of making the trade.',
+    )
+
+    pre_start: Optional[bool] = Field(
+        None,
+        description='Whether the trade was based on pre-start activity.',
+    )
+
+    price: Optional[str] = Field(
+        None,
+        description='The price that the trade was executed at. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    remaining: Optional[str] = Field(
+        None,
+        description='The number of unsettled contracts in the trade. Quantity as a decimal string, as sent by the API.',
+    )
+
+    remaining_potential_fee: Optional[str] = Field(
+        None,
+        description='The potential fee from unsettled contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    remaining_premium: Optional[str] = Field(
+        None,
+        description='Premium as yet unsettled. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    remaining_risk: Optional[str] = Field(
+        None,
+        description='The total current risk for the trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    remaining_to_win: Optional[str] = Field(
+        None,
+        description='The remaining amount that the trade can win. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    settled_at: Optional[str] = Field(
+        None,
+        description="The timestamp when this trade's status was set to `settled`",
+    )
+
+    settled_contracts: Optional[str] = Field(
+        None,
+        description='Contracts already settled. Below `traded_contracts` on a partial settlement. Quantity as a decimal string, as sent by the API.',
+    )
+
+    settlements_count: Optional[int] = Field(
+        None,
+        description='The number of settlements where this `AccountTrade` is an opening trade.',
+    )
+
+    status: Optional[str] = Field(
+        None,
+        description='Fill state. `created` once the matching engine has written the fill, `open` while the position is live, `settled` once it no longer contributes to a position, and `cancelled` if an admin reversed it. One of: ``created``, ``open``, ``settled``, ``cancelled``.',
+    )
+
+    time: Optional[str] = Field(
+        None,
+        description='The ISO-8601 Date time the trade was created.',
+    )
+
+    total_fee: Optional[str] = Field(
+        None,
+        description='Sum of on-trade fee plus fees paid from settlements linked with the trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    trade_fee: Optional[str] = Field(
+        None,
+        description='Per-trade fee (on-trade fee schedule). Included in total_fee. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    trade_id: Optional[str] = Field(
+        None,
+        description='Unique identifier for the trade.',
+    )
+
+    traded_contracts: Optional[str] = Field(
+        None,
+        description='Number of contracts in this trade. Quantity as a decimal string, as sent by the API.',
+    )
+
+    unrounded_trade_fee: Optional[str] = Field(
+        None,
+        description='Fee before rounding. Use the rounded fee for reconciliation. In dollars. Carries up to 9 decimal places - parse money with a variable-scale decimal type, not a fixed-width one. Money as a decimal string, as sent by the API.',
+    )
+
+    updated_at: Optional[int] = Field(
+        None,
+        description='Time of the last change, as UNIX microseconds.',
+    )
+
+    virtual_remaining: Optional[str] = Field(
+        None,
+        description='Remaining contracts including unsettled exposure. Quantity as a decimal string, as sent by the API.',
+    )
+
+
+class Market(STXModel):
+    """A market you can trade, with its book and event context."""
+
+    archived: Optional[bool] = Field(
+        None,
+        description='Is the market archived or not.',
+    )
+
+    bids: Optional[List[BookLevel]] = Field(
+        None,
+        description='The available bids on the market, best first.',
+    )
+
+    competition: Optional[str] = Field(
+        None,
+        description='The text to use in describing the competition, e.g. NBA.',
+    )
+
+    description: Optional[str] = Field(
+        None,
+        description='The description of the market.',
+    )
+
+    event_id: Optional[str] = Field(
+        None,
+        description='The event the market belongs to.',
+    )
+
+    event_short_title: Optional[str] = Field(
+        None,
+        description='The short title of the event associated with the market.',
+    )
+
+    event_start: Optional[str] = Field(
+        None,
+        description='The UTC start date and time of the event.',
+    )
+
+    event_status: Optional[str] = Field(
+        None,
+        description='The status of the event that the market is attached to.',
+    )
+
+    event_title: Optional[str] = Field(
+        None,
+        description='The title of the event associated with the market.',
+    )
+
+    event_type: Optional[str] = Field(
+        None,
+        description='The type of event associated with the market.',
+    )
+
+    featured: Optional[bool] = Field(
+        None,
+        description='Is the market featured or not.',
+    )
+
+    featured_home: Optional[bool] = Field(
+        None,
+        description='Is the market featured on home page.',
+    )
+
+    filters: Optional[List[MarketFilter]] = Field(
+        None,
+        description='The categorisations under which the market appears. A list, not an object.',
+    )
+
+    group_title: Optional[str] = Field(
+        None,
+        description='The human readable group title for the market.',
+    )
+
+    grouping_id: Optional[str] = Field(
+        None,
+        description="Identity of the set of mutually exclusive outcomes this market prices against - the 30 World Series contracts, the 4 AFC East contracts, one fixture's moneyline pair. Opaque: compare for equality, never parse. Stable for the life of the market, and present in every status, so it is the field to map market data on. Unlike `symbol`, it does not move when a fixture is rescheduled.",
+    )
+
+    grouping_name: Optional[str] = Field(
+        None,
+        description='The grouping in words, e.g. `AL East Division`, `Spread - 1st Quarter`. Descriptive rather than stable - for a tournament it is the event title, which can be renamed. Display it; join on `grouping_id`.',
+    )
+
+    home_category: Optional[str] = Field(
+        None,
+        description='The category in which the market appears: `Upcoming`, `Live` or `nil`.',
+    )
+
+    in_play_delay_sec: Optional[int] = Field(
+        None,
+        description='The order delay (in seconds) when the event is in progress.',
+    )
+
+    keywords: Optional[List[str]] = Field(
+        None,
+        description='The keywords that are set for the market.',
+    )
+
+    last_probability_at: Optional[int] = Field(
+        None,
+        description='The time that the last probability update was received by the server. UNIX microseconds.',
+    )
+
+    last_traded_price: Optional[str] = Field(
+        None,
+        description='The price of the last executed trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    manual_probability: Optional[bool] = Field(
+        None,
+        description='`true` when the probability was set by hand, `false` when it came from the odds provider. A flag, not a probability figure.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market this record relates to.',
+    )
+
+    max_price: Optional[str] = Field(
+        None,
+        description='The highest price an order in this market may take, and the settlement value of one winning contract. Orders must price strictly below it. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    offers: Optional[List[BookLevel]] = Field(
+        None,
+        description='The available offers on the market, best first.',
+    )
+
+    open_interest: Optional[str] = Field(
+        None,
+        description='Current open interest in the market. In contracts. Quantity as a decimal string, as sent by the API.',
+    )
+
+    participants: Optional[List[Dict[str, Any]]] = Field(
+        None,
+        description='The map of participants in the market.',
+    )
+
+    points_cost: Optional[int] = Field(
+        None,
+        description='The cost of each loyalty point for amount risked by the user.',
+    )
+
+    position: Optional[str] = Field(
+        None,
+        description='Text describing the position this market takes, e.g. a participant name. A label, not a numeric ordering.',
+    )
+
+    powered_by: Optional[Dict[str, Any]] = Field(
+        None,
+        description='Powered by - provider used to result this market.',
+    )
+
+    price: Optional[str] = Field(
+        None,
+        description='The market price that the market is trading at. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    price_change24h: Optional[int] = Field(
+        None,
+        description='The change in price over the last 24 hours, as a percentage. Not money - it stays a number and must not be divided by 100.',
+    )
+
+    probability: Optional[float] = Field(
+        None,
+        description='What is the probability for the market',
+    )
+
+    question: Optional[str] = Field(
+        None,
+        description='The question that the market is asking.',
+    )
+
+    recent_trades: Optional[List[RecentTrade]] = Field(
+        None,
+        description='The last 15 trades on the market.',
+    )
+
+    result: Optional[str] = Field(
+        None,
+        description='The result of the market.',
+    )
+
+    rules: Optional[str] = Field(
+        None,
+        description='The rules for this market.',
+    )
+
+    settled_at: Optional[int] = Field(
+        None,
+        description='When the market was resulted or voided. A raw microsecond integer, unlike the ISO-8601 `timestamp` and `event_start` beside it. UNIX microseconds.',
+    )
+
+    short_title: Optional[str] = Field(
+        None,
+        description='The human readable short title for the market.',
+    )
+
+    specifier: Optional[str] = Field(
+        None,
+        description='The specifier for the rules to properly determine the market.',
+    )
+
+    sport: Optional[str] = Field(
+        None,
+        description='The text to use in describing the sport, e.g. Basketball.',
+    )
+
+    stat_detail: Optional[StatDetail] = Field(
+        None,
+        description='The stat line this market is derived from, or `null` for a market that is not a stat-line prop.',
+    )
+
+    status: Optional[str] = Field(
+        None,
+        description='Market state. See [Market and order status](/concepts/market-status/) - note that a market with `status: open` may still report as suspended when trading is halted. One of: ``scheduled``, ``pre_open``, ``open``, ``suspended``, ``closed``, ``resulted``, ``cancelled``, ``voided``.',
+    )
+
+    symbol: Optional[str] = Field(
+        None,
+        description='A unique symbol for this market.',
+    )
+
+    timestamp: Optional[str] = Field(
+        None,
+        description='Server time when this payload was generated, as an ISO-8601 string. The `timestamp_int` sibling carries the same instant as UNIX microseconds.',
+    )
+
+    timestamp_int: Optional[int] = Field(
+        None,
+        description='The UNIX microseconds timestamp of when this market info was created.',
+    )
+
+    title: Optional[str] = Field(
+        None,
+        description='The human readable title for the market.',
+    )
+
+    total_volume: Optional[str] = Field(
+        None,
+        description='Contracts traded on this market across its lifetime. Quantity as a decimal string, as sent by the API.',
+    )
+
+    trading: Optional[bool] = Field(
+        None,
+        description='Trading flag - if the market is open for trading or not',
+    )
+
+    trading_filters: Optional[List[MarketFilter]] = Field(
+        None,
+        description='The categorisations used for organising trades, settlements and related items. A list, not an object.',
+    )
+
+    volume24h: Optional[str] = Field(
+        None,
+        description='Trade volume this market has had in the last 24 hours. In contracts. Quantity as a decimal string, as sent by the API.',
+    )
+
+
+class MarketFilter(STXModel):
+    """One categorisation this market appears under."""
+
+    category: Optional[str] = Field(
+        None,
+        description='Top-level category, e.g. a sport or a promotional section.',
+    )
+
+    grouping: Optional[str] = Field(
+        None,
+        description='Grouping within the section.',
+    )
+
+    manual: Optional[bool] = Field(
+        None,
+        description='Whether the categorisation was assigned by hand.',
+    )
+
+    section: Optional[str] = Field(
+        None,
+        description='Section heading this market groups under.',
+    )
+
+    subcategory: Optional[str] = Field(
+        None,
+        description='Category within `category`, e.g. a competition.',
+    )
+
+    subgrouping: Optional[str] = Field(
+        None,
+        description='Grouping within `grouping`.',
+    )
+
+
+class MarketStat(STXModel):
+    """Your exposure and realised result in one market."""
+
+    account_id: Optional[str] = Field(
+        None,
+        description='The account the record belongs to.',
+    )
+
+    archived_at: Optional[int] = Field(
+        None,
+        description='DateTime at which the record is marked as archived. It will be `nil` until the market is archived. UNIX microseconds.',
+    )
+
+    available_position: Optional[str] = Field(
+        None,
+        description='The amount of the `position` that is not reserved for pending orders. In contracts. Quantity as a decimal string, as sent by the API.',
+    )
+
+    average_open_premium: Optional[str] = Field(
+        None,
+        description='The average premium of all open contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    buy_contracts_closed: Optional[str] = Field(
+        None,
+        description='The total number of buy contracts that were closed. Quantity as a decimal string, as sent by the API.',
+    )
+
+    buy_contracts_expired: Optional[str] = Field(
+        None,
+        description='The total number of buy contracts that were expired. Quantity as a decimal string, as sent by the API.',
+    )
+
+    buy_contracts_settled: Optional[str] = Field(
+        None,
+        description='The total number of buy contracts settled in the position. Quantity as a decimal string, as sent by the API.',
+    )
+
+    buy_contracts_traded: Optional[str] = Field(
+        None,
+        description="The total number of buy contracts the account has traded. Only opening trade's contracts are included. Quantity as a decimal string, as sent by the API.",
+    )
+
+    buy_order_liability: Optional[str] = Field(
+        None,
+        description='The order liability on this position from buy orders. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    buy_orders: Optional[int] = Field(
+        None,
+        description='Count of all buy orders.',
+    )
+
+    buy_original_risk: Optional[str] = Field(
+        None,
+        description='The original risk incurred by buy trades. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    buy_settlements: Optional[int] = Field(
+        None,
+        description='Count of all settlements from buy trades.',
+    )
+
+    buy_trade_count: Optional[int] = Field(
+        None,
+        description='The total number of buy trades the account has made on the market.',
+    )
+
+    cancelled_buy_contracts: Optional[str] = Field(
+        None,
+        description='Sum of all not matched contracts in buy cancelled orders. Quantity as a decimal string, as sent by the API.',
+    )
+
+    cancelled_buy_orders: Optional[int] = Field(
+        None,
+        description='Number of buy orders that were cancelled.',
+    )
+
+    cancelled_contracts: Optional[str] = Field(
+        None,
+        description='Sum of all not matched contracts in all cancelled orders. Quantity as a decimal string, as sent by the API.',
+    )
+
+    cancelled_orders: Optional[int] = Field(
+        None,
+        description='Number of orders that were cancelled.',
+    )
+
+    cancelled_sell_contracts: Optional[str] = Field(
+        None,
+        description='Sum of all not matched contracts in sell cancelled orders. Quantity as a decimal string, as sent by the API.',
+    )
+
+    cancelled_sell_orders: Optional[int] = Field(
+        None,
+        description='Number of sell orders that were cancelled.',
+    )
+
+    closed_buy_premium: Optional[str] = Field(
+        None,
+        description='Total premium from closed buy trade contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closed_fees: Optional[str] = Field(
+        None,
+        description='The total value of fees from closed settlements. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closed_gross_pnl: Optional[str] = Field(
+        None,
+        description='The profit or loss the account has made in `closed` settlements. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closed_net_pnl: Optional[str] = Field(
+        None,
+        description='The net profit or loss after subtracting `closed_fees`. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closed_premium: Optional[str] = Field(
+        None,
+        description='Total premium from closed contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closed_sell_premium: Optional[str] = Field(
+        None,
+        description='Total premium from closed sell trade contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    competition: Optional[str] = Field(
+        None,
+        description='The competition of this market',
+    )
+
+    contracts_closed: Optional[str] = Field(
+        None,
+        description='The total number of all contracts that were closed. Quantity as a decimal string, as sent by the API.',
+    )
+
+    contracts_expired: Optional[str] = Field(
+        None,
+        description='The total number of all contracts that were expired. Quantity as a decimal string, as sent by the API.',
+    )
+
+    contracts_in_buy_orders: Optional[str] = Field(
+        None,
+        description='Sum of all not matched contracts in buy orders. Quantity as a decimal string, as sent by the API.',
+    )
+
+    contracts_in_orders: Optional[str] = Field(
+        None,
+        description='Sum of all not matched contracts in all orders. Order.quanity - Order.filled. Quantity as a decimal string, as sent by the API.',
+    )
+
+    contracts_in_sell_orders: Optional[str] = Field(
+        None,
+        description='Sum of all not matched contracts in sell orders. Quantity as a decimal string, as sent by the API.',
+    )
+
+    contracts_settled: Optional[str] = Field(
+        None,
+        description='The number of contracts that have been settled. Quantity as a decimal string, as sent by the API.',
+    )
+
+    contracts_traded: Optional[str] = Field(
+        None,
+        description="The total number of all contracts (AccountTrade.filled). Only opening trade contracts are counted. Doesn't include contracts closing other trades. Quantity as a decimal string, as sent by the API.",
+    )
+
+    event_id: Optional[str] = Field(
+        None,
+        description='The event the market belongs to.',
+    )
+
+    event_start_time: Optional[int] = Field(
+        None,
+        description='The start time of the event. UNIX microseconds.',
+    )
+
+    expired_buy_premium: Optional[str] = Field(
+        None,
+        description='Total premium from expired buy trade contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    expired_fees: Optional[str] = Field(
+        None,
+        description='The total value of fees from expired settlements. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    expired_gross_pnl: Optional[str] = Field(
+        None,
+        description='The profit or loss the account has made in `expired` settlements. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    expired_net_pnl: Optional[str] = Field(
+        None,
+        description='The net profit or loss after subtracting `expired_fees`. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    expired_premium: Optional[str] = Field(
+        None,
+        description='Total premium from expired contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    expired_sell_premium: Optional[str] = Field(
+        None,
+        description='Total premium from expired sell trade contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    fee_plugin: Optional[str] = Field(
+        None,
+        description='Internal. Virtual field naming the fee module in use, not part of the supported contract.',
+    )
+
+    inserted_at: Optional[int] = Field(
+        None,
+        description='Creation time, as UNIX microseconds.',
+    )
+
+    last_settled_at: Optional[int] = Field(
+        None,
+        description='DateTime at which the last settlement was created. UNIX microseconds.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market this record relates to.',
+    )
+
+    market_max_price: Optional[str] = Field(
+        None,
+        description="The market's maximum price - the settlement value of one winning contract. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    max_liability_loss: Optional[str] = Field(
+        None,
+        description='Worst-case loss if this market settles against the position you hold. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    max_liability_win: Optional[str] = Field(
+        None,
+        description='Worst-case loss if this market settles in favour of the position you hold. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    max_potential_fee: Optional[str] = Field(
+        None,
+        description='The maximum potential fees including all actual fees paid. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    max_potential_profit: Optional[str] = Field(
+        None,
+        description='The maximum potential profit, including all actual profit. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    max_risk: Optional[str] = Field(
+        None,
+        description='The total amount of risk on unsettled contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    needs_rebuild: Optional[bool] = Field(
+        None,
+        description='Internal. Consistency flag used by position rebuilds, not part of the supported contract.',
+    )
+
+    open_order_count: Optional[int] = Field(
+        None,
+        description='The number of open orders the account has on the market.',
+    )
+
+    open_potential_fee: Optional[str] = Field(
+        None,
+        description='The amount of potential fee that is related to unsettled contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    open_potential_profit: Optional[str] = Field(
+        None,
+        description='The potential profit from the outstanding contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    open_premium: Optional[str] = Field(
+        None,
+        description="Total premium on the user's current position in the market. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    open_risk: Optional[str] = Field(
+        None,
+        description='The amount of risk associated with outstanding contracts. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    open_trade_count: Optional[int] = Field(
+        None,
+        description='The number of open trades the account has on the market.',
+    )
+
+    order_liability: Optional[str] = Field(
+        None,
+        description='The order liability on this position from all orders. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    orders: Optional[int] = Field(
+        None,
+        description='Count of all orders.',
+    )
+
+    original_risk: Optional[str] = Field(
+        None,
+        description='The original risk incurred by all trades. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    pending_close_fee: Optional[str] = Field(
+        None,
+        description='Fees that would be charged if the resting close orders all filled. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    pending_close_pnl: Optional[str] = Field(
+        None,
+        description='Profit or loss that would be realised if the resting close orders all filled. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    position: Optional[str] = Field(
+        None,
+        description='The numerical position of the account in the market. In contracts. Quantity as a decimal string, as sent by the API.',
+    )
+
+    position_accountability_alert_id: Optional[str] = Field(
+        None,
+        description='Internal. Links to a position-accountability alert, not part of the supported contract.',
+    )
+
+    position_premium_liability: Optional[str] = Field(
+        None,
+        description='The liability of the position that affects available balance. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    potential_order_trade_fee: Optional[str] = Field(
+        None,
+        description='Fees that would be charged if every open order on this market filled. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    rejected_buy_orders: Optional[int] = Field(
+        None,
+        description='Number of buy orders that were rejected.',
+    )
+
+    rejected_orders: Optional[int] = Field(
+        None,
+        description='Number of orders that were rejected.',
+    )
+
+    rejected_sell_orders: Optional[int] = Field(
+        None,
+        description='Number of sell orders that were rejected.',
+    )
+
+    sell_contracts_closed: Optional[str] = Field(
+        None,
+        description='The total number of buy contracts that were closed. Quantity as a decimal string, as sent by the API.',
+    )
+
+    sell_contracts_expired: Optional[str] = Field(
+        None,
+        description='The total number of sell contracts that were expired. Quantity as a decimal string, as sent by the API.',
+    )
+
+    sell_contracts_settled: Optional[str] = Field(
+        None,
+        description='The total number of sell contracts settled in the position. Quantity as a decimal string, as sent by the API.',
+    )
+
+    sell_contracts_traded: Optional[str] = Field(
+        None,
+        description="The total number of sell contracts the account has traded in the market. Only opening trade's contracts are included. Quantity as a decimal string, as sent by the API.",
+    )
+
+    sell_order_liability: Optional[str] = Field(
+        None,
+        description='The order liability on this position from sell orders. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    sell_orders: Optional[int] = Field(
+        None,
+        description='Count of all sell orders.',
+    )
+
+    sell_original_risk: Optional[str] = Field(
+        None,
+        description='The original risk incurred by sell trades. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    sell_settlements: Optional[int] = Field(
+        None,
+        description='Count of all settlements from sell trades.',
+    )
+
+    sell_trade_count: Optional[int] = Field(
+        None,
+        description='The total number of sell trades the account has made on the market.',
+    )
+
+    settled_at: Optional[int] = Field(
+        None,
+        description='DateTime at which the expired settlements were recorded which will be `nil` if the market has not resulted or voided yet. UNIX microseconds.',
+    )
+
+    settlements: Optional[int] = Field(
+        None,
+        description='Count of all settlements from all trades.',
+    )
+
+    sport: Optional[str] = Field(
+        None,
+        description='The sport of this market',
+    )
+
+    status: Optional[str] = Field(
+        None,
+        description='The status of the **market** this record covers, merged in from the live market index. `null` when the market is no longer held there.',
+    )
+
+    title: Optional[str] = Field(
+        None,
+        description='The title of the **market** this record covers, merged in from the live market index. `null` when the market is no longer held there.',
+    )
+
+    total_fees: Optional[str] = Field(
+        None,
+        description='The total fees that have been collected on the settlements. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_liability: Optional[str] = Field(
+        None,
+        description='The liability affecting avail. balance from open orders and position. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_net_pnl: Optional[str] = Field(
+        None,
+        description='The net profit or loss after subtracting `total_fees`. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_settlement_pnl: Optional[str] = Field(
+        None,
+        description='The total Profit or Loss on all settlements. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    trade_count: Optional[int] = Field(
+        None,
+        description='The total number of trades the account has made on the market.',
+    )
+
+    updated_at: Optional[int] = Field(
+        None,
+        description='Time of the last change, as UNIX microseconds.',
+    )
+
+
+class Me(STXModel):
+    """The account behind the API key."""
+
+    account_id: Optional[str] = Field(
+        None,
+        description='Your account id. Trades, settlements and balances are scoped to it.',
+    )
+
+    first_name: Optional[str] = Field(
+        None,
+        description='First name on the account, or `null` if no profile is loaded.',
+    )
+
+    key_id: Optional[str] = Field(
+        None,
+        description='The id of the API key that signed this request - the value sent in the access-key header.',
+    )
+
+    last_name: Optional[str] = Field(
+        None,
+        description='Last name on the account, or `null` if no profile is loaded.',
+    )
+
+    method: Optional[str] = Field(
+        None,
+        description='How this request authenticated. `api_key` for signed requests.',
+    )
+
+    scope: Optional[str] = Field(
+        None,
+        description='Access level granted to this key: `read_only`, or `read_write` for keys that may place and cancel orders. One of: ``read_only``, ``read_write``.',
+    )
+
+    user_id: Optional[str] = Field(
+        None,
+        description='Your user id. Substitute this into private channel topics such as `orders:{user_id}`.',
+    )
+
+
+class NewOrder(STXModel):
+    """A new order to place on the exchange."""
+
+    action: Optional[str] = Field(
+        None,
+        description='Which side of the book the order takes. One of: ``buy``, ``sell``.',
+    )
+
+    cancel_on_disconnect: Optional[bool] = Field(
+        None,
+        description='Cancel this order if the `orders` channel stops heartbeating. See the cancel_on_disconnect guide.',
+    )
+
+    client_order_id: Optional[str] = Field(
+        None,
+        description='Your own reference, echoed back unchanged. A free-form string, not a UUID - FIX clients routinely send ids like `my-order-001`.',
+    )
+
+    device_id: Optional[str] = Field(
+        None,
+        description='Identifier for the device placing the order.',
+    )
+
+    expiration: Optional[str] = Field(
+        None,
+        description='When the order should stop resting. One of: ``good_till_start``, ``good_till_time``.',
+    )
+
+    expiration_time: Optional[int] = Field(
+        None,
+        description='The moment a `good_till_time` order expires. Required when `expiration` is `good_till_time`. UNIX microseconds.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market to place the order on.',
+    )
+
+    order_type: Optional[str] = Field(
+        None,
+        description='Whether the order takes a price or rests on the book. One of: ``limit``, ``market``.',
+    )
+
+    price: Optional[str] = Field(
+        None,
+        description='Limit price in dollars, as a string - `"0.42"` is 42 cents and `"42.00"` is $42. A number is rejected outright rather than reinterpreted, because a bare `3000` is ambiguous between subunits and dollars and the wrong reading is a 100x overprice that still passes range validation. Must be strictly less than the market\'s `max_price`; read that from the market rather than assuming a fixed ceiling. Required for `limit` orders and unused by `market` orders, but validated whenever it is present: a malformed or sub-cent price is a 400 on a `market` order too, rather than being quietly dropped. An explicit `null` is accepted there, exactly as omitting the key is. Must be greater than zero and a whole number of cents - at most two decimal places, not counting trailing zeros. So "0.42" and "0.4200" are the same accepted value, and "0.001" is rejected. Money as a decimal string, as sent by the API.',
+    )
+
+    quantity: Optional[str] = Field(
+        None,
+        description='Number of contracts, greater than zero, as a decimal string: `"10"` and `"10.00"` are read the same. A number is rejected rather than converted, the same rule `price` follows, though for a different reason - a float arrives as a binary double, so the size that rests on the book would not always be the size that was sent. More than nine decimal places is rounded. Responses always return it as a string.',
+    )
+
+
+class Order(STXModel):
+    """An order resting on, or already matched against, the exchange book."""
+
+    accepted_at: Optional[int] = Field(
+        None,
+        description='When the matching engine accepted the order. `null` while the order is still pending. UNIX microseconds.',
+    )
+
+    action: Optional[str] = Field(
+        None,
+        description='The action of the order, either `buy` or `sell`. One of: ``buy``, ``sell``.',
+    )
+
+    amount: Optional[str] = Field(
+        None,
+        description='Order size expressed as stake, for orders placed by amount rather than quantity. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    avg_price: Optional[str] = Field(
+        None,
+        description='Volume-weighted average fill price. `null` until the order has its first fill. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    cancellation_reason: Optional[str] = Field(
+        None,
+        description='The cancellation reason, if the order was cancelled.',
+    )
+
+    client_order_id: Optional[str] = Field(
+        None,
+        description='Your own identifier, echoed back unchanged, or `null` if you sent none. A free-form string, not a UUID, and set by REST and FIX callers alike.',
+    )
+
+    delayed_until: Optional[int] = Field(
+        None,
+        description='The extended deadline for a delayed order. UNIX microseconds.',
+    )
+
+    device_id: Optional[str] = Field(
+        None,
+        description='The device from which this order was placed.',
+    )
+
+    expiration: Optional[str] = Field(
+        None,
+        description='The expiration condition for the order. One of: ``good_till_start``, ``good_till_time``.',
+    )
+
+    expiration_time: Optional[int] = Field(
+        None,
+        description='The expiration time for time-based expiration. UNIX microseconds.',
+    )
+
+    filled: Optional[str] = Field(
+        None,
+        description='Contracts filled so far. Compare with `quantity` to get remaining size. Quantity as a decimal string, as sent by the API.',
+    )
+
+    filled_amount: Optional[str] = Field(
+        None,
+        description='The portion of `amount` that has been filled. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    filled_percentage: Optional[int] = Field(
+        None,
+        description='The percentage of the contracts on the order that have been filled. A percentage, not money.',
+    )
+
+    fix_order: Optional[bool] = Field(
+        None,
+        description='True if the order arrived over FIX rather than REST.',
+    )
+
+    id: Optional[str] = Field(
+        None,
+        description='Unique identifier for the record.',
+    )
+
+    inserted_at: Optional[int] = Field(
+        None,
+        description='Creation time, as UNIX microseconds.',
+    )
+
+    ip_address: Optional[str] = Field(
+        None,
+        description='The IP address from which this order was placed.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market this record relates to.',
+    )
+
+    odds_type: Optional[str] = Field(
+        None,
+        description='The odds type used when placing the order.',
+    )
+
+    odds_value: Optional[str] = Field(
+        None,
+        description='The odds value used when placing the order.',
+    )
+
+    order_type: Optional[str] = Field(
+        None,
+        description='The type of order, either `limit` or `market`. One of: ``limit``, ``market``.',
+    )
+
+    placed_pre_start: Optional[bool] = Field(
+        None,
+        description='Whether the order was placed before the event started.',
+    )
+
+    price: Optional[str] = Field(
+        None,
+        description="Limit price. The ceiling is the market's `max_price`, not a fixed 99 - read it from the market. Absent for market orders. In dollars. Carries up to 7 decimal places - parse money with a variable-scale decimal type, not a fixed-width one. Money as a decimal string, as sent by the API.",
+    )
+
+    quantity: Optional[str] = Field(
+        None,
+        description='Order size in contracts. Quantity as a decimal string, as sent by the API.',
+    )
+
+    rejection_reason: Optional[str] = Field(
+        None,
+        description='The rejection reason, if the order was rejected.',
+    )
+
+    status: Optional[str] = Field(
+        None,
+        description='Order state - one of nine. See [Market and order status](/concepts/market-status/#order-statuses) for the full set and which are terminal. One of: ``created``, ``requested``, ``accepted``, ``delayed``, ``open``, ``filled``, ``rejected``, ``cancelled``, ``partially_cancelled``.',
+    )
+
+    time: Optional[str] = Field(
+        None,
+        description='The ISO-8601 timestamp of the time the order was placed.',
+    )
+
+    total_value: Optional[str] = Field(
+        None,
+        description='Total premium across all fills on this order. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+
+class PaymentTransaction(STXModel):
+    """One deposit, withdrawal or balance adjustment, enriched with its payment method."""
+
+    account_id: Optional[str] = Field(
+        None,
+        description='The account the record belongs to.',
+    )
+
+    amount: Optional[str] = Field(
+        None,
+        description='The monetary value the entry was calculated from. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    event_id: Optional[str] = Field(
+        None,
+        description='The event the market belongs to.',
+    )
+
+    fee_id: Optional[str] = Field(
+        None,
+        description='The fee that generated this entry, when it came from one.',
+    )
+
+    id: Optional[str] = Field(
+        None,
+        description='Unique identifier for the record.',
+    )
+
+    inserted_at: Optional[int] = Field(
+        None,
+        description='Creation time, as UNIX microseconds.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market this record relates to.',
+    )
+
+    method: Optional[str] = Field(
+        None,
+        description='The payment method the provider reports for this transaction.',
+    )
+
+    payment_id: Optional[str] = Field(
+        None,
+        description='The payment that generated this entry, when it came from one.',
+    )
+
+    points: Optional[float] = Field(
+        None,
+        description='Points added by this entry. Negative when points were spent.',
+    )
+
+    reason: Optional[str] = Field(
+        None,
+        description="The provider's reason or description for the transaction.",
+    )
+
+    settlement_id: Optional[str] = Field(
+        None,
+        description='The settlement that generated this entry, when it came from one.',
+    )
+
+    sub_method: Optional[str] = Field(
+        None,
+        description='For Interac, whether the transfer was a `Send` or a `Request`.',
+    )
+
+    time: Optional[str] = Field(
+        None,
+        description='When the entry was recorded.',
+    )
+
+    type: Optional[str] = Field(
+        None,
+        description='What moved the money or the points - for example a deposit, a trade fee, a referral, or a manual adjustment. Each endpoint returns only its own subset of these. One of: ``deposit``, ``withdrawal``, ``settlement``, ``fee``, ``fee_refund``, ``casino``, ``adjustment``, ``loyalty``, ``loyalty_points_rollup``, ``loyalty_points_referral``.',
+    )
+
+
+class Position(STXModel):
+    """Your position in one market."""
+
+    account_id: Optional[str] = Field(
+        None,
+        description='The account the position belongs to.',
+    )
+
+    average_open_premium: Optional[str] = Field(
+        None,
+        description='Average premium per contract for the open portion. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    buy_order_liability: Optional[str] = Field(
+        None,
+        description='Liability from your open buy orders on this market. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    contracts_settled: Optional[str] = Field(
+        None,
+        description='Contracts settled in the position so far. Quantity as a decimal string, as sent by the API.',
+    )
+
+    event_id: Optional[str] = Field(
+        None,
+        description='The event the market belongs to.',
+    )
+
+    gross_pnl: Optional[str] = Field(
+        None,
+        description='`total_settlement_pnl` plus any pending-close profit or loss that has not settled yet. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    id: Optional[str] = Field(
+        None,
+        description='The unique id of the position record.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market the position is on.',
+    )
+
+    max_potential_fee: Optional[str] = Field(
+        None,
+        description="Total potential fee across the position's settlements. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    max_potential_profit: Optional[str] = Field(
+        None,
+        description='Total possible profit for the position if everything settles favourably. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    max_risk: Optional[str] = Field(
+        None,
+        description='Account-level risk on the position, netting in already settled profit and loss. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    open_potential_fee: Optional[str] = Field(
+        None,
+        description='Potential fee on the open contracts when they settle. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    open_potential_profit: Optional[str] = Field(
+        None,
+        description="Possible profit on the position's open contracts. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    open_risk: Optional[str] = Field(
+        None,
+        description="Risk on the position's open (unsettled) contracts. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    position: Optional[str] = Field(
+        None,
+        description='Net position in the market: positive if long (bought), negative if short (sold). Can be `"0.00"` for a market you have traded and closed out that has not settled yet. In contracts. Quantity as a decimal string, as sent by the API.',
+    )
+
+    position_premium_liability: Optional[str] = Field(
+        None,
+        description="Liability from the position's premium that counts against available balance. Routinely negative. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    premium: Optional[str] = Field(
+        None,
+        description='Total premium paid or received for the open portion of the position. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    sell_order_liability: Optional[str] = Field(
+        None,
+        description='Liability from your open sell orders on this market. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    total_fee: Optional[str] = Field(
+        None,
+        description="Total fees paid across the position's settlements. In dollars. Money as a decimal string, as sent by the API.",
+    )
+
+    total_settlement_pnl: Optional[str] = Field(
+        None,
+        description='Profit or loss realised from settlements so far. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+
+class RecentTrade(STXModel):
+    """One recent public trade on the market."""
+
+    liquidity_taker: Optional[str] = Field(
+        None,
+        description="Which side took liquidity. `Trade.liquidity_taker/1` derives this from the resting side, so the values are `buyer` and `seller` - not `buy`/`sell` as on an order's `action`. One of: ``buyer``, ``seller``.",
+    )
+
+    price: Optional[str] = Field(
+        None,
+        description='The price the trade executed at. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    quantity: Optional[str] = Field(
+        None,
+        description='Contracts traded. Quantity as a decimal string, as sent by the API.',
+    )
+
+    timestamp: Optional[str] = Field(
+        None,
+        description='When the trade executed.',
+    )
+
+    timestamp_us: Optional[int] = Field(
+        None,
+        description='When the trade executed, as UNIX microseconds.',
+    )
+
+
+class Settlement(STXModel):
+    """One closed or expired position."""
+
+    account_id: Optional[str] = Field(
+        None,
+        description='The account the record belongs to.',
+    )
+
+    closing_placed_pre_start: Optional[bool] = Field(
+        None,
+        description="Whether the closing trade's order was placed before the event started.",
+    )
+
+    closing_price: Optional[str] = Field(
+        None,
+        description='The price of the contracts when the position was closed. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    closing_trade_id: Optional[str] = Field(
+        None,
+        description='The id of the trade that closed this settlement, if any.',
+    )
+
+    closing_traded_pre_start: Optional[bool] = Field(
+        None,
+        description='Whether the closing trade was placed before the event started.',
+    )
+
+    fee: Optional[str] = Field(
+        None,
+        description='The fee charged for the settlement. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    gross_pnl: Optional[str] = Field(
+        None,
+        description='The profit or loss associated with the position. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    id: Optional[str] = Field(
+        None,
+        description='Unique identifier for the record.',
+    )
+
+    inserted_at: Optional[int] = Field(
+        None,
+        description='Creation time, as UNIX microseconds.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market this record relates to.',
+    )
+
+    opening_placed_pre_start: Optional[bool] = Field(
+        None,
+        description="Whether the opening trade's order was placed before the event started.",
+    )
+
+    opening_price: Optional[str] = Field(
+        None,
+        description='The price of the contracts when the position was opened. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    opening_trade_id: Optional[str] = Field(
+        None,
+        description='The id of the trade that opened this settlement.',
+    )
+
+    opening_traded_pre_start: Optional[bool] = Field(
+        None,
+        description='Whether the opening trade was placed before the event started.',
+    )
+
+    pre_start: Optional[bool] = Field(
+        None,
+        description='Whether the settlement was placed before the event started.',
+    )
+
+    quantity: Optional[str] = Field(
+        None,
+        description='The number of contracts that were settled. Quantity as a decimal string, as sent by the API.',
+    )
+
+    realized_pnl: Optional[str] = Field(
+        None,
+        description='The net profit or loss minus fees. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    settled_premium: Optional[str] = Field(
+        None,
+        description='The amount of premium that was settled by the trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    settled_risk: Optional[str] = Field(
+        None,
+        description='The amount of risk that was settled by the trade. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    time: Optional[str] = Field(
+        None,
+        description='ISO-8601 timestamp of when the settlement was created. Same instant as `inserted_at`, which carries it as UNIX microseconds.',
+    )
+
+    type: Optional[str] = Field(
+        None,
+        description='The type of settlement. One of: ``closed_short``, ``closed_long``, ``expired_short``, ``expired_long``.',
+    )
+
+
+class StatDetail(STXModel):
+    """The stat line a prop market is derived from."""
+
+    jersey: Optional[str] = Field(
+        None,
+        description="The player's jersey number, when known.",
+    )
+
+    line: Optional[float] = Field(
+        None,
+        description='The line value the market sits at, when the prop carries one.',
+    )
+
+    participant: Optional[str] = Field(
+        None,
+        description='The participant the line belongs to, when applicable.',
+    )
+
+    player: Optional[str] = Field(
+        None,
+        description='The player the line belongs to, or `null` for a team line.',
+    )
+
+    prop_type: Optional[str] = Field(
+        None,
+        description='The shape of the prop. One of: ``ou``, ``yn``, ``1v2``, ``field``.',
+    )
+
+    stat: Optional[str] = Field(
+        None,
+        description='The stat being wagered on, e.g. `passingYards`.',
+    )
+
+    stat_display_name: Optional[str] = Field(
+        None,
+        description='Human-readable name for `stat`.',
+    )
+
+
+class Transaction(STXModel):
+    """One ledger entry on the account."""
+
+    account_id: Optional[str] = Field(
+        None,
+        description='The account the record belongs to.',
+    )
+
+    amount: Optional[str] = Field(
+        None,
+        description='The monetary value the entry was calculated from. In dollars. Money as a decimal string, as sent by the API.',
+    )
+
+    event_id: Optional[str] = Field(
+        None,
+        description='The event the market belongs to.',
+    )
+
+    fee_id: Optional[str] = Field(
+        None,
+        description='The fee that generated this entry, when it came from one.',
+    )
+
+    id: Optional[str] = Field(
+        None,
+        description='Unique identifier for the record.',
+    )
+
+    inserted_at: Optional[int] = Field(
+        None,
+        description='Creation time, as UNIX microseconds.',
+    )
+
+    market_id: Optional[str] = Field(
+        None,
+        description='The market this record relates to.',
+    )
+
+    payment_id: Optional[str] = Field(
+        None,
+        description='The payment that generated this entry, when it came from one.',
+    )
+
+    points: Optional[float] = Field(
+        None,
+        description='Points added by this entry. Negative when points were spent.',
+    )
+
+    referee_account_id: Optional[str] = Field(
+        None,
+        description='For referral entries, the account that was referred.',
+    )
+
+    referrer_account_id: Optional[str] = Field(
+        None,
+        description='For referral entries, the account that referred.',
+    )
+
+    settlement_id: Optional[str] = Field(
+        None,
+        description='The settlement that generated this entry, when it came from one.',
+    )
+
+    time: Optional[str] = Field(
+        None,
+        description='When the entry was recorded.',
+    )
+
+    type: Optional[str] = Field(
+        None,
+        description='What moved the money or the points - for example a deposit, a trade fee, a referral, or a manual adjustment. Each endpoint returns only its own subset of these. One of: ``deposit``, ``withdrawal``, ``settlement``, ``fee``, ``fee_refund``, ``casino``, ``adjustment``, ``loyalty``, ``loyalty_points_rollup``, ``loyalty_points_referral``.',
+    )
+
+Balance.model_rebuild()
+BookLevel.model_rebuild()
+Cancellation.model_rebuild()
+Error.model_rebuild()
+Event.model_rebuild()
+FeeTransaction.model_rebuild()
+Fill.model_rebuild()
+Market.model_rebuild()
+MarketFilter.model_rebuild()
+MarketStat.model_rebuild()
+Me.model_rebuild()
+NewOrder.model_rebuild()
+Order.model_rebuild()
+PaymentTransaction.model_rebuild()
+Position.model_rebuild()
+RecentTrade.model_rebuild()
+Settlement.model_rebuild()
+StatDetail.model_rebuild()
+Transaction.model_rebuild()