Set Self-Exclusion (set_self_exclusion)

Set Self-Exclusion (this call should be used in conjunction with get_self_exclusion)

Auth Scope(s): admin

set_self_exclusion(exclude_until: Optional[str] = None, max_30day_deposit: Optional[Union[int, float, Decimal]] = None, max_30day_losses: Optional[Union[int, float, Decimal]] = None, max_30day_turnover: Optional[Union[int, float, Decimal]] = None, max_7day_deposit: Optional[Union[int, float, Decimal]] = None, max_7day_losses: Optional[Union[int, float, Decimal]] = None, max_7day_turnover: Optional[Union[int, float, Decimal]] = None, max_balance: Optional[Union[int, float, Decimal]] = None, max_deposit: Optional[Union[int, float, Decimal]] = None, max_losses: Optional[Union[int, float, Decimal]] = None, max_open_bets: Optional[int] = None, max_turnover: Optional[Union[int, float, Decimal]] = None, session_duration_limit: Optional[int] = None, timeout_until: Optional[int] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • exclude_until (Optional[str]) – [Optional] Exclude me from the website (for a minimum of 6 months, up to a maximum of 5 years). Note: uplifting this self-exclusion may require contacting the company.
  • max_30day_deposit (Optional[Union[int, float, Decimal]]) – [Optional] 7-day limit on deposits.
  • max_30day_losses (Optional[Union[int, float, Decimal]]) – [Optional] 30-day limit on losses.
  • max_30day_turnover (Optional[Union[int, float, Decimal]]) – [Optional] 30-day turnover limit.
  • max_7day_deposit (Optional[Union[int, float, Decimal]]) – [Optional] 7-day limit on deposits.
  • max_7day_losses (Optional[Union[int, float, Decimal]]) – [Optional] 7-day limit on losses.
  • max_7day_turnover (Optional[Union[int, float, Decimal]]) – [Optional] 7-day turnover limit.
  • max_balance (Optional[Union[int, float, Decimal]]) – [Optional] Maximum account cash balance.
  • max_deposit (Optional[Union[int, float, Decimal]]) – [Optional] Daily deposit limit.
  • max_losses (Optional[Union[int, float, Decimal]]) – [Optional] Daily limit on losses.
  • max_open_bets (Optional[int]) – [Optional] Maximum number of open positions.
  • max_turnover (Optional[Union[int, float, Decimal]]) – [Optional] Daily turnover limit.
  • session_duration_limit (Optional[int]) – [Optional] Session duration limit, in minutes.
  • timeout_until (Optional[int]) – [Optional] Exclude me from the website (for up to 6 weeks). Requires time in epoch format. Note: unlike exclude_until, this self-exclusion will be lifted automatically at the expiry of the timeout period.
  • passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field.
  • req_id (Optional[int]) – [Optional] Used to map request to response.
Returns:

req_id
Return type:

int

Example

binary.api.set_self_exclusion(
    exclude_until='2020-01-01'
    max_30day_deposit=1000
    max_30day_losses=100000
    max_30day_turnover=1000
    max_7day_deposit=100
    max_7day_losses=100000
    max_7day_turnover=1000
    max_deposit=10
    max_losses=100000
    max_turnover=1000
    session_duration_limit=3600
    timeout_until=1497357184
)

See also