The SDK exposes 51 operations (19 queries, 32 mutations). Full typed signatures live in the .pyi stubs — use your IDE’s autocomplete for per-argument detail. This page is a Ctrl-F index.
Prefer the narrative guides for learning the SDK. The reference is here for lookup when you already know what op you want.
Market data
See the market data guide for worked examples.
accountMarketStats (pagination?, filter?) — Query. Returns list[AccountMarketStat].
List of all account market stats for a given account
geoFencingLicense — Query. Returns LicenseResponse.
Returns the Geo fencing license
marketFilterTree — Query. Returns MarketFilterTree.
Returns a JSON string representation of the marketFilters (Name, [Children]).
marketInfos (input?) — Query. Returns list[MarketInfo].
Returns a list of the markets and filtered details
marketInfosWithCount (input?) — Query. Returns MarketInfosWithCount.
Returns a list of the markets and filtered details with the count of entries
marketSettlements (marketId, pagination?) — Query. Returns list[TransactionHistory].
List of all settlement for a given market
tradesForSettlement (settlementId) — Query. Returns SettlementTrades.
Opening and closing Trades for given settlement_id
Trading
See the trading guide for worked examples.
cancelAllOrders (geoLocation?, deviceInfo?) — Mutation. Returns list[BatchCancelOrdersResult].
Cancel of all open orders of an account.
cancelOrder (orderId, geoLocation?, deviceInfo?) — Mutation. Returns CancelOrderResult.
Cancels an order.
cancelOrders (orderIds?, geoLocation?, deviceInfo?) — Mutation. Returns list[BatchCancelOrdersResult].
Batch cancel of orders.
confirmOrder (userOrder, geoLocation?, deviceInfo?) — Mutation. Returns OrderResult.
Creates a new order.
confirmOrders (userOrders, geoLocation?, deviceInfo?) — Mutation. Returns OrderResults.
Creates a set of new orders.
myOrderHistory (orderIds?, clientOrderIds?, marketIds?, status?, pagination?, sortBy?) — Query. Returns OrdersWithCount.
List of all orders for a user, all criteria is combined in an AND.
mySettlementsHistory (pagination?, filter?) — Query. Returns NetSettlementHistory.
History of all settlements
myTradesForOrder (orderId) — Query. Returns list[Trade].
List of trades associated with provided order id
myTradesHistory (sortBy?, filter?, settlementType?, settledOn?, pagination?) — Query. Returns TradesWithCount.
List of the user’s trades
placeOddsOrder (oddsOrder, geoLocation?, deviceInfo?) — Mutation. Returns OrderResult.
Place Limit Order with Odds and Amount
placeRiskOrder (riskOrder, geoLocation?, deviceInfo?) — Mutation. Returns OrderResult.
Place Market Order with Amount
Account
account — Query. Returns Account.
Account Information
accountLimitsHistoryNumber — Query. Returns list[AccountLimitHistoryResultNumber].
History of account limits changes by the user.
accountLimitsNumber — Query. Returns AccountLimitResultNumber.
Account limits for a single account - values are returned as integer numbers
closeAccount (password?) — Mutation. Returns SelfStatusChangeResult.
Close a user’s account. This requires that the user has no positions in any market, and
loyaltyHistory (pagination?) — Query. Returns list[TransactionHistory].
List of all loyalty related transactions for the account
selfExclude (password?) — Mutation. Returns SelfStatusChangeResult.
(DEPRECATED) - USE set_limit_number instead.
setLimitNumber (key, value?, password?) — Mutation. Returns AccountLimitResultNumber.
Sets the user’s account limits. The account limits are constrained by the admin limits
termsAndConditions — Query. Returns TermsAndConditionsResult.
Returns the latest TermsAndConditions version details
tncAccepted (input) — Mutation. Returns str.
Register that the user accepts the terms and conditions.
updateProfile (input) — Mutation. Returns UpdateUserProfileResult.
Allows a user to update phone and address in their profile using JSON input.
updateUserProfile (input) — Mutation. Returns UpdateUserProfileResult.
Allows a user to update their profile with new information.
userProfile — Query. Returns UserProfile.
A user’s profile
verifyEmail (code) — Mutation. Returns VerificationResult.
Verify a user’s email on registration or after change.
verifyPassword (password) — Mutation. Returns PasswordVerificationResult.
Verifies if the user’s password is correct
Auth & 2FA
See the auth & 2fa guide for worked examples.
changePassword (oldPassword, newPassword) — Mutation. Returns LoginResult.
Change the current user’s password to the password provided. Note that the means for making
confirm2Fa (code, sessionId, email, timestamp?) — Mutation. Returns LoginResult.
User submitting the 2FA code in order to login.
confirmChangePassword2Fa (code) — Mutation. Returns LoginResult.
Confirm the 2FA code for the password change.
confirmPasswordReset (passwordResetParams) — Mutation. Returns PasswordResetResult.
Completes the forgotten password flow.
disable2Fa (password?) — Mutation. Returns TwoFactorAuthResult.
Disable 2FA on the currently logged in user’s account. This mutation will do nothing if
enable2Fa (password?) — Mutation. Returns TwoFactorAuthResult.
Enable 2FA on the currently logged in user’s account.
forgotPassword (email) — Mutation. Returns ForgotPasswordResult.
Invoked to initiate the forgotten password flow.
login (credentials) — Mutation. Returns LoginResult.
Login to the platform using the credentials. Please note that if the user has 2FA enabled
logout (deviceInfo?) — Mutation. Returns LogoutResult.
Logout of the platform on a specific device, invalidating all tokens.
newToken (refreshToken) — Mutation. Returns LoginResult.
Create a new authorization token from the user’s refresh token.
register (input) — Mutation. Returns RegisterUserResult.
New user registration based on JSON document
resend2Fa (sessionId, email) — Mutation. Returns TwoFactorAuthResult.
Request that another 2FA code be sent when apparently the user didnt get the code.
resendChangePassword2Fa — Mutation. Returns TwoFactorAuthResult.
Request that another 2FA code for password reset when the user didn’t receive or use the previous 2fa code.
send2Fa — Mutation. Returns TwoFactorAuthResult.
Request a new 2FA code providing the reason - i.e. updating user profile for example.
Payments
myDepositAndWithdrawalHistory (pagination?) — Query. Returns list[TransactionHistory].
List of all deposits and withdrawals for account
paymentSettings — Query. Returns PaymentProviders.
Returns Payment provider’s settings
paysafeDeposit (amount, type, handle?, handleId?, method?, api?, description?, interacMethod?) — Mutation. Returns PaysafeTransactionResult.
Called to deposit money in a user’s account via paysafe.
paysafeWithdrawal (amount, method, type, handle?, handleId?, description?) — Mutation. Returns PaysafeTransactionResult.
Called to withdraw funds from the platform, currently only ACH paysafe supported.
updatePaysafeSettings (vipRegistrationId) — Mutation. Returns bool.
Updates user’s payment settings.