New Virtual-Money Account (new_account_virtual)

Create a new virtual-money account.

new_account_virtual(affiliate_token: Optional[str] = None, client_password: Optional[str] = None, date_first_contact: Optional[str] = None, email_consent: Optional[int] = None, gclid_url: Optional[str] = None, residence: Optional[str] = None, signup_device: Optional[str] = None, type: Optional[str] = None, utm_ad_id=None, utm_adgroup_id=None, utm_adrollclk_id=None, utm_campaign=None, utm_campaign_id=None, utm_content=None, utm_fbcl_id=None, utm_gl_client_id=None, utm_medium=None, utm_msclk_id=None, utm_source=None, utm_term=None, verification_code: Optional[str] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • affiliate_token (Optional[str]) – [Optional] Affiliate token, within 32 characters.
  • client_password (Optional[str]) – Password (Accepts any printable ASCII character. Must be within 8-25 characters, and include numbers, lowercase and uppercase letters. Must not be the same as the user’s email address).
  • date_first_contact (Optional[str]) – [Optional] Date of first contact, format: yyyy-mm-dd in GMT timezone.
  • email_consent (Optional[int]) – [Optional] Boolean value: 1 or 0, indicating whether the client has given consent for marketing emails.
  • gclid_url (Optional[str]) – [Optional] Google Click Identifier to track source.
  • residence (Optional[str]) – 2-letter country code (obtained from residence_list call).
  • signup_device (Optional[str]) – [Optional] Show whether user has used mobile or desktop.
  • type (Optional[str]) – Account type
  • utm_ad_id – [Optional] Identifier of particular ad. Value must match Regex pattern to be recorded
  • utm_adgroup_id – [Optional] Identifier of ad group in the campaign. Value must match Regex pattern to be recorded
  • utm_adrollclk_id – [Optional] Unique identifier of click on AdRoll ads platform. Value must match Regex pattern to be recorded
  • utm_campaign – [Optional] Identifies a specific product promotion or strategic campaign such as a spring sale or other promotions. Value must match Regex pattern to be recorded
  • utm_campaign_id – [Optional] Identifier of paid ad campaign. Value must match Regex pattern to be recorded
  • utm_content – [Optional] Used to differentiate similar content, or links within the same ad. Value must match Regex pattern to be recorded
  • utm_fbcl_id – [Optional] Unique identifier of click on Facebook ads platform. Value must match Regex pattern to be recorded
  • utm_gl_client_id – [Optional] Unique visitor identifier on Google Ads platform. Value must match Regex pattern to be recorded
  • utm_medium – [Optional] Identifies the medium the link was used upon such as: email, CPC, or other methods of sharing. Value must match Regex pattern to be recorded
  • utm_msclk_id – [Optional] Unique click identifier on Microsoft Bing ads platform. Value must match Regex pattern to be recorded
  • utm_source – [Optional] Identifies the source of traffic such as: search engine, newsletter, or other referral. Value must match Regex pattern to be recorded
  • utm_term – [Optional] Used to send information related to the campaign term like paid search keywords. Value must match Regex pattern to be recorded
  • verification_code (Optional[str]) – Email verification code (received from a verify_email call, which must be done first).
  • 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.new_account_virtual(
    type='trading'
    client_password='C0rrect_p4ssword'
    residence='id'
    verification_code='uoJvVuQ6'
)

See also