Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sportsxapp.com/llms.txt

Use this file to discover all available pages before exploring further.

The SportsX Python SDK exposes 51 operations — 19 queries and 32 mutations — that map directly to the underlying GraphQL API. This page is a fast lookup index: find the operation name, check its signature, and follow the link to the category page for the full parameter table and a runnable example.
For complete parameter tables, type details, and worked code examples, use the per-category reference pages linked in each section heading below.

​
Market data

7 operations — all queries. Full details on the Market data reference page.
  • account_market_stats (pagination?, filter?) — Query. Returns list[AccountMarketStat]. Lists account-level statistics for every market in which you have activity.
  • geo_fencing_license — Query. Returns LicenseResponse. Returns the geo-fencing license for the current session.
  • market_filter_tree — Query. Returns MarketFilterTree. Returns the hierarchical tree of available market filter categories.
  • market_infos (input?) — Query. Returns list[MarketInfo]. Returns a flat list of markets matching the optional filter criteria.
  • market_infos_with_count (input?) — Query. Returns MarketInfosWithCount. Same as market_infos but also returns the total count of matching markets.
  • market_settlements (market_id, pagination?) — Query. Returns list[TransactionHistory]. Lists every settlement event for the given market.
  • trades_for_settlement (settlement_id) — Query. Returns SettlementTrades. Returns the opening and closing trades that make up a specific settlement.

​
Trading

11 operations — 4 queries, 7 mutations. Full details on the Trading reference page.
  • cancel_all_orders (geo_location?, device_info?) — Mutation. Returns list[BatchCancelOrdersResult]. Cancels every open order on your account.
  • cancel_order (order_id, geo_location?, device_info?) — Mutation. Returns CancelOrderResult. Cancels a single open order by ID.
  • cancel_orders (order_ids?, geo_location?, device_info?) — Mutation. Returns list[BatchCancelOrdersResult]. Cancels a specific set of open orders in one request.
  • confirm_order (user_order, geo_location?, device_info?) — Mutation. Returns OrderResult. Places a single new order on the exchange.
  • confirm_orders (user_orders, geo_location?, device_info?) — Mutation. Returns OrderResults. Places multiple orders in a single request.
  • my_order_history (order_ids?, client_order_ids?, market_ids?, status?, pagination?, sort_by?) — Query. Returns OrdersWithCount. Paginated, filterable list of all orders on your account.
  • my_settlements_history (pagination?, filter?) — Query. Returns NetSettlementHistory. Paginated history of all settlements applied to your account.
  • my_trades_for_order (order_id) — Query. Returns list[Trade]. Lists every trade execution associated with a specific order.
  • my_trades_history (sort_by?, filter?, settlement_type?, settled_on?, pagination?) — Query. Returns TradesWithCount. Comprehensive, paginated history of all trade executions on your account.
  • place_odds_order (odds_order, geo_location?, device_info?) — Mutation. Returns OrderResult. Places a limit order using odds and a stake amount instead of raw price and quantity.
  • place_risk_order (risk_order, geo_location?, device_info?) — Mutation. Returns OrderResult. Places a market order that fills up to a maximum stake amount.

​
Account

14 operations — 6 queries, 8 mutations. Full details on the Account reference page.
  • account — Query. Returns Account. Retrieves top-level account information including balance and status.
  • account_limits_history_number — Query. Returns list[AccountLimitHistoryResultNumber]. Chronological log of every responsible-gambling limit change.
  • account_limits_number — Query. Returns AccountLimitResultNumber. Current responsible-gambling limit values as integers.
  • close_account (password?) — Mutation. Returns SelfStatusChangeResult. Permanently closes your account (irreversible; requires zero balance and no open positions).
  • loyalty_history (pagination?) — Query. Returns list[TransactionHistory]. Lists all loyalty-program transactions on your account.
  • self_exclude (password?) — Mutation. Returns SelfStatusChangeResult. Deprecated — use set_limit_number instead.
  • set_limit_number (key, value?, password?) — Mutation. Returns AccountLimitResultNumber. Sets a single responsible-gambling limit, constrained by admin-configured bounds.
  • terms_and_conditions — Query. Returns TermsAndConditionsResult. Fetches the current platform terms and conditions version.
  • tnc_accepted (input) — Mutation. Returns str. Records acceptance of the current terms and conditions version.
  • update_profile (input) — Mutation. Returns UpdateUserProfileResult. Updates phone and address fields on your profile.
  • update_user_profile (input) — Mutation. Returns UpdateUserProfileResult. Updates a broader set of profile fields including name.
  • user_profile — Query. Returns UserProfile. Fetches the full profile record for your account.
  • verify_email (code) — Mutation. Returns VerificationResult. Confirms your email address using a one-time verification code.
  • verify_password (password) — Mutation. Returns PasswordVerificationResult. Checks whether a password string matches your account credentials.

​
Auth & 2FA

14 operations — all mutations. Full details on the Auth & 2FA reference page.
  • change_password (old_password, new_password) — Mutation. Returns LoginResult. Changes your password; triggers a 2FA challenge if 2FA is enabled.
  • confirm2_fa (code, session_id, email, timestamp?) — Mutation. Returns LoginResult. Completes a login paused by a 2FA challenge.
  • confirm_change_password2_fa (code) — Mutation. Returns LoginResult. Confirms the 2FA challenge raised by change_password.
  • confirm_password_reset (password_reset_params) — Mutation. Returns PasswordResetResult. Completes the forgotten-password flow using the emailed reset token.
  • disable2_fa (password?) — Mutation. Returns TwoFactorAuthResult. Disables two-factor authentication on your account.
  • enable2_fa (password?) — Mutation. Returns TwoFactorAuthResult. Enables two-factor authentication on your account.
  • forgot_password (email) — Mutation. Returns ForgotPasswordResult. Initiates the forgotten-password flow by sending a reset token by email.
  • login (credentials) — Mutation. Returns LoginResult. Authenticates with email and password; returns a session ID when 2FA is required.
  • logout (device_info?) — Mutation. Returns LogoutResult. Invalidates all tokens for the current session or a specific device.
  • new_token (refresh_token) — Mutation. Returns LoginResult. Exchanges a refresh token for a new access token and refresh token.
  • register (input) — Mutation. Returns RegisterUserResult. Creates a new user account.
  • resend2_fa (session_id, email) — Mutation. Returns TwoFactorAuthResult. Resends the 2FA code for an in-progress login session.
  • resend_change_password2_fa — Mutation. Returns TwoFactorAuthResult. Resends the 2FA code for a pending password change.
  • send2_fa — Mutation. Returns TwoFactorAuthResult. Requests a fresh 2FA code for a non-login action such as profile update.

​
Payments

5 operations — 2 queries, 3 mutations. Full details on the Payments reference page.
  • my_deposit_and_withdrawal_history (pagination?) — Query. Returns list[TransactionHistory]. Paginated list of every deposit and withdrawal on your account.
  • payment_settings — Query. Returns PaymentProviders. Fetches payment provider configuration and available methods for your account.
  • paysafe_deposit (amount, type, handle?, handle_id?, method?, api?, description?, interac_method?) — Mutation. Returns PaysafeTransactionResult. Initiates a deposit via the Paysafe payment gateway.
  • paysafe_withdrawal (amount, method, type, handle?, handle_id?, description?) — Mutation. Returns PaysafeTransactionResult. Requests a withdrawal via Paysafe (currently ACH only).
  • update_paysafe_settings (vip_registration_id) — Mutation. Returns bool. Stores your VIP Preferred registration ID against your account.