Skip to main content
14 operations.

​
account

Query — returns Account. Account Information Example 
result = client.account(selections=Selection(...))

​
accountLimitsHistoryNumber

Query — returns list[AccountLimitHistoryResultNumber]. History of account limits changes by the user. Example 
result = client.accountLimitsHistoryNumber(selections=Selection(...))

​
accountLimitsNumber

Query — returns AccountLimitResultNumber. Account limits for a single account - values are returned as integer numbers Example 
result = client.accountLimitsNumber(selections=Selection(...))

​
closeAccount

Mutation — returns SelfStatusChangeResult. Close a user’s account. This requires that the user has no positions in any market, and has withdrawn all funds. Closed accounts cannot be reversed. Parameters
NameGraphQL typeRequiredDescription
passwordStringNoUser’s password to close the account
Example 
result = client.closeAccount(params={"password": ...}, selections=Selection(...))

​
loyaltyHistory

Query — returns list[TransactionHistory]. List of all loyalty related transactions for the account Parameters
NameGraphQL typeRequiredDescription
paginationPaginationNo—
Example 
result = client.loyaltyHistory(params={"pagination": ...}, selections=Selection(...))

​
selfExclude

Mutation — returns SelfStatusChangeResult. (DEPRECATED) - USE set_limit_number instead. Parameters
NameGraphQL typeRequiredDescription
passwordStringNoUser’s password to self-exclude the account
Example 
result = client.selfExclude(params={"password": ...}, selections=Selection(...))

​
setLimitNumber

Mutation — returns AccountLimitResultNumber. Sets the user’s account limits. The account limits are constrained by the admin limits on the user’s account. Parameters
NameGraphQL typeRequiredDescription
keyLimitKeys!YesThe key of the limit that the user wishes to change.
valueNonNegIntNoThe new value for the limit.
passwordStringNoOptional password to set cool-off period and self-exclusion
Example 
result = client.setLimitNumber(params={"key": ..., "value": ..., "password": ...}, selections=Selection(...))

​
termsAndConditions

Query — returns TermsAndConditionsResult. Returns the latest TermsAndConditions version details Example 
result = client.termsAndConditions(selections=Selection(...))

​
tncAccepted

Mutation — returns str. Register that the user accepts the terms and conditions. Parameters
NameGraphQL typeRequiredDescription
inputTncAcceptanceInput!Yes—
Example 
result = client.tncAccepted(params={"input": ...}, selections=Selection(...))

​
updateProfile

Mutation — returns UpdateUserProfileResult. Allows a user to update phone and address in their profile using JSON input. Parameters
NameGraphQL typeRequiredDescription
inputUserProfileInputV2!YesThe data to update in the user profile.
Example 
result = client.updateProfile(params={"input": ...}, selections=Selection(...))

​
updateUserProfile

Mutation — returns UpdateUserProfileResult. Allows a user to update their profile with new information. Parameters
NameGraphQL typeRequiredDescription
inputUserProfileInput!YesThe data to update in the user profile.
Example 
result = client.updateUserProfile(params={"input": ...}, selections=Selection(...))

​
userProfile

Query — returns UserProfile. A user’s profile Example 
result = client.userProfile(selections=Selection(...))

​
verifyEmail

Mutation — returns VerificationResult. Verify a user’s email on registration or after change. Parameters
NameGraphQL typeRequiredDescription
codeString!YesThe code that was mailed to the user to accomplish the verification.
Example 
result = client.verifyEmail(params={"code": ...}, selections=Selection(...))

​
verifyPassword

Mutation — returns PasswordVerificationResult. Verifies if the user’s password is correct Parameters
NameGraphQL typeRequiredDescription
passwordString!YesThe password to verify
Example 
result = client.verifyPassword(params={"password": ...}, selections=Selection(...))