├── .github ├── ISSUE_TEMPLATE │ ├── config.yml │ └── custom.md └── workflows │ └── publish.yml ├── setup.cfg ├── ws_api ├── __init__.py ├── exceptions.py ├── session.py └── wealthsimple_api.py ├── setup.py ├── .gitignore ├── README.md └── LICENSE /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | license_files = LICENSE 4 | -------------------------------------------------------------------------------- /ws_api/__init__.py: -------------------------------------------------------------------------------- 1 | from ws_api.exceptions import * 2 | from ws_api.session import WSAPISession 3 | from ws_api.wealthsimple_api import WealthsimpleAPI 4 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/custom.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Custom issue template 3 | about: Please always use this template. It provides some guidance about anonymizing 4 | sensitive information. 5 | title: '' 6 | labels: '' 7 | assignees: '' 8 | 9 | --- 10 | 11 | 12 | -------------------------------------------------------------------------------- /ws_api/exceptions.py: -------------------------------------------------------------------------------- 1 | 2 | class CurlException(Exception): 3 | pass 4 | 5 | class ManualLoginRequired(Exception): 6 | pass 7 | 8 | class OTPRequiredException(Exception): 9 | pass 10 | 11 | class UnexpectedException(Exception): 12 | pass 13 | 14 | class WSApiException(Exception): 15 | def __init__(self, message: str, response=None): 16 | """ 17 | Initialize the WSApiException. 18 | 19 | :param message: The error message. 20 | :param code: The error code. 21 | :param response: Optional response data associated with the exception. 22 | """ 23 | super().__init__(message) 24 | self.response = response 25 | 26 | def __str__(self): 27 | return f"{super().__str__()}; Response: {self.response}" 28 | 29 | class LoginFailedException(WSApiException): 30 | pass 31 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | setuptools.setup( 4 | name = 'WS-API', 5 | packages = ['ws_api'], 6 | version = '0.25.0', 7 | license = 'GPL-3.0', 8 | description = 'Access your Wealthsimple account using their (GraphQL) API.', 9 | author = 'Guillaume Boudreau', 10 | author_email = 'guillaume@pommepause.com', 11 | url = 'https://github.com/gboudreau/ws-api-python', 12 | keywords = ['wealthsimple'], 13 | python_requires='>=3.10', 14 | install_requires = [ 15 | 'requests', 16 | ], 17 | classifiers = [ 18 | 'Development Status :: 3 - Alpha', 19 | 'Intended Audience :: Developers', 20 | 'Operating System :: OS Independent', 21 | 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', 22 | 'Programming Language :: Python :: 3', 23 | "Programming Language :: Python :: 3.13" 24 | ], 25 | ) 26 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Upload Python Package to PyPI when a Release is Created 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | jobs: 8 | pypi-publish: 9 | name: Publish release to PyPI 10 | runs-on: ubuntu-latest 11 | environment: 12 | name: pypi 13 | url: https://pypi.org/p/WS-API 14 | permissions: 15 | id-token: write 16 | steps: 17 | - uses: actions/checkout@v4 18 | - name: Set up Python 19 | uses: actions/setup-python@v4 20 | with: 21 | python-version: "3.x" 22 | - name: Install dependencies 23 | run: | 24 | python -m pip install --upgrade pip 25 | pip install setuptools wheel 26 | - name: Build package 27 | run: | 28 | python setup.py sdist bdist_wheel # Could also be python -m build 29 | - name: Publish package distributions to PyPI 30 | uses: pypa/gh-action-pypi-publish@release/v1 31 | -------------------------------------------------------------------------------- /ws_api/session.py: -------------------------------------------------------------------------------- 1 | import json 2 | from abc import ABC 3 | 4 | 5 | class OAuthSession(ABC): 6 | """ 7 | A class representing an OAuth session. 8 | 9 | Attributes: 10 | client_id (str or None): OAuth Client ID, used in OAuth requests. 11 | access_token (str or None): OAuth Access Token, used to authenticate API requests. 12 | refresh_token (str or None): OAuth Refresh Token, used to obtain new access tokens when they expire. 13 | """ 14 | 15 | def __init__(self): 16 | self.client_id: str | None = None 17 | self.access_token = None 18 | self.refresh_token = None 19 | 20 | 21 | 22 | class WSAPISession(OAuthSession): 23 | """ 24 | A class representing a WSAPI session, extending OAuthSession. 25 | 26 | Attributes: 27 | session_id (str or None): Session ID, sent in headers for OAuth requests. 28 | wssdi (str or None): Device ID, sent in headers of API requests. 29 | token_info (object or None): Cached result of getTokenInfo(). 30 | """ 31 | 32 | def __init__(self): 33 | super().__init__() 34 | self.session_id: str | None = None 35 | self.wssdi: str | None = None 36 | self.token_info = None 37 | 38 | def to_json(self): 39 | return json.dumps(self, default=lambda o: o.__dict__, ensure_ascii=False) 40 | 41 | @classmethod 42 | def from_json(cls, json_str): 43 | data = json.loads(json_str) 44 | obj = cls() 45 | obj.__dict__.update(data) 46 | return obj 47 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Python template 2 | # Byte-compiled / optimized / DLL files 3 | __pycache__/ 4 | *.py[cod] 5 | *$py.class 6 | 7 | # C extensions 8 | *.so 9 | 10 | # Distribution / packaging 11 | .Python 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | cover/ 54 | 55 | # Translations 56 | *.mo 57 | *.pot 58 | 59 | # Django stuff: 60 | *.log 61 | local_settings.py 62 | db.sqlite3 63 | db.sqlite3-journal 64 | 65 | # Flask stuff: 66 | instance/ 67 | .webassets-cache 68 | 69 | # Scrapy stuff: 70 | .scrapy 71 | 72 | # Sphinx documentation 73 | docs/_build/ 74 | 75 | # PyBuilder 76 | .pybuilder/ 77 | target/ 78 | 79 | # Jupyter Notebook 80 | .ipynb_checkpoints 81 | 82 | # IPython 83 | profile_default/ 84 | ipython_config.py 85 | 86 | # pyenv 87 | # For a library or package, you might want to ignore these files since the code is 88 | # intended to run in multiple environments; otherwise, check them in: 89 | # .python-version 90 | 91 | # pipenv 92 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 93 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 94 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 95 | # install all needed dependencies. 96 | #Pipfile.lock 97 | 98 | # poetry 99 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 100 | # This is especially recommended for binary packages to ensure reproducibility, and is more 101 | # commonly ignored for libraries. 102 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 103 | #poetry.lock 104 | 105 | # pdm 106 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 107 | #pdm.lock 108 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 109 | # in version control. 110 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 111 | .pdm.toml 112 | .pdm-python 113 | .pdm-build/ 114 | 115 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 116 | __pypackages__/ 117 | 118 | # Celery stuff 119 | celerybeat-schedule 120 | celerybeat.pid 121 | 122 | # SageMath parsed files 123 | *.sage.py 124 | 125 | # Environments 126 | .env 127 | .venv 128 | env/ 129 | venv/ 130 | ENV/ 131 | env.bak/ 132 | venv.bak/ 133 | 134 | # Spyder project settings 135 | .spyderproject 136 | .spyproject 137 | 138 | # Rope project settings 139 | .ropeproject 140 | 141 | # mkdocs documentation 142 | /site 143 | 144 | # mypy 145 | .mypy_cache/ 146 | .dmypy.json 147 | dmypy.json 148 | 149 | # Pyre type checker 150 | .pyre/ 151 | 152 | # pytype static type analyzer 153 | .pytype/ 154 | 155 | # Cython debug symbols 156 | cython_debug/ 157 | 158 | # PyCharm 159 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 160 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 161 | # and can be added to the global gitignore or merged into this file. For a more nuclear 162 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 163 | #.idea/ 164 | 165 | # VS Code 166 | .vscode/ 167 | 168 | # Dev dependencies 169 | ruff.toml 170 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Unofficial Wealthsimple API Library for Python 2 | ============================================== 3 | 4 | This library allows you to access your own account using the Wealthsimple (GraphQL) API using Python. 5 | 6 | Installation 7 | ------------ 8 | 9 | ```bash 10 | pip install ws-api 11 | ``` 12 | 13 | Usage 14 | ----- 15 | 16 | Note: You'll need the keyring package to run the code below. Install with: `pip install keyring` 17 | 18 | ```python 19 | from datetime import datetime 20 | import json 21 | import keyring 22 | import os 23 | import tempfile 24 | from ws_api import WealthsimpleAPI, OTPRequiredException, LoginFailedException, WSAPISession 25 | 26 | class WSApiTest: 27 | def main(self): 28 | # 1. Define a function that will be called when the session is created or updated. Persist the session to a safe place, like in the keyring 29 | keyring_service_name = "foo.bar" 30 | persist_session_fct = lambda sess, uname: keyring.set_password(f"{keyring_service_name}.{uname}", "session", sess) 31 | # The session contains tokens that can be used to empty your Wealthsimple account, so treat it with respect! 32 | # i.e. don't store it in a Git repository, or anywhere it can be accessed by others! 33 | 34 | # If you want, you can set a custom User-Agent for the requests to the WealthSimple API: 35 | WealthsimpleAPI.set_user_agent("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36") 36 | 37 | # 2. If it's the first time you run this, create a new session using the username & password (and TOTP answer, if needed). Do NOT save those infos in your code! 38 | username = input("Wealthsimple username (email): ") 39 | session = keyring.get_password(f"{keyring_service_name}.{username}", "session") 40 | if session: 41 | session = WSAPISession.from_json(session) 42 | if not session: 43 | username = None 44 | password = None 45 | otp_answer = None 46 | while True: 47 | try: 48 | if not username: 49 | username = input("Wealthsimple username (email): ") 50 | session = keyring.get_password(f"{keyring_service_name}.{username}", "session") 51 | if session: 52 | session = WSAPISession.from_json(session) 53 | break 54 | if not password: 55 | password = input("Password: ") 56 | WealthsimpleAPI.login(username, password, otp_answer, persist_session_fct=persist_session_fct) 57 | # The above will throw exceptions if login failed 58 | # So we break (out of the login "while True" loop) on success: 59 | session = WSAPISession.from_json(keyring.get_password(keyring_service_name, "session")) 60 | break 61 | except OTPRequiredException: 62 | otp_answer = input("TOTP code: ") 63 | except LoginFailedException: 64 | print("Login failed. Try again.") 65 | username = None 66 | password = None 67 | 68 | # 3. Use the session object to instantiate the API object 69 | ws = WealthsimpleAPI.from_token(session, persist_session_fct, username) 70 | # persist_session_fct is needed here too, because the session may be updated if the access token expired, and thus this function will be called to save the new session 71 | 72 | # Optionally define functions to cache market data, if you want transactions' descriptions and accounts balances to show the security's symbol instead of its ID 73 | # eg. sec-s-e7947deb977341ff9f0ddcf13703e9a6 => TSX:XEQT 74 | def sec_info_getter_fn(ws_security_id: str): 75 | cache_file_path = os.path.join(tempfile.gettempdir(), f"ws-api-{ws_security_id}.json") 76 | if os.path.exists(cache_file_path): 77 | return json.load(open(cache_file_path, 'r')) 78 | return None 79 | def sec_info_setter_fn(ws_security_id: str, market_data: object): 80 | cache_file_path = os.path.join(tempfile.gettempdir(), f"ws-api-{ws_security_id}.json") 81 | # noinspection PyTypeChecker 82 | json.dump(market_data, open(cache_file_path, 'w')) 83 | return market_data 84 | ws.set_security_market_data_cache(sec_info_getter_fn, sec_info_setter_fn) 85 | 86 | # 4. Use the API object to access your WS accounts 87 | accounts = ws.get_accounts() 88 | 89 | print("All Accounts Historical Value & Gains:") 90 | historical_fins = ws.get_identity_historical_financials([a['id'] for a in accounts]) 91 | for hf in historical_fins: 92 | value = float(hf['netLiquidationValueV2']['amount']) 93 | deposits = float(hf['netDepositsV2']['amount']) 94 | gains = value - deposits 95 | print(f" - {hf['date']} = ${value:,.0f} - {deposits:,.0f} (deposits) = {gains:,.0f} (gains)") 96 | 97 | for account in accounts: 98 | print(f"Account: {account['description']} ({account['number']})") 99 | if account['description'] == account['unifiedAccountType']: 100 | # This is an "unknown" account, for which description is generic; please open an issue on https://github.com/gboudreau/ws-api-python/issues and include the following: 101 | print(f" Unknown account: {account}") 102 | 103 | if account['currency'] == 'CAD': 104 | value = account['financials']['currentCombined']['netLiquidationValue']['amount'] 105 | print(f" Net worth: {value} {account['currency']}") 106 | # Note: For USD accounts, value is the CAD value converted to USD 107 | # For USD accounts, only the balance & positions are relevant 108 | 109 | # Cash and positions balances 110 | balances = ws.get_account_balances(account['id']) 111 | cash_balance_key = 'sec-c-usd' if account['currency'] == 'USD' else 'sec-c-cad' 112 | cash_balance = float(balances.get(cash_balance_key, 0)) 113 | print(f" Available (cash) balance: {cash_balance} {account['currency']}") 114 | 115 | if len(balances) > 1: 116 | print(" Assets:") 117 | for security, bal in balances.items(): 118 | if security in ['sec-c-cad', 'sec-c-usd']: 119 | continue 120 | print(f" - {security} x {bal}") 121 | 122 | print(" Historical Value & Gains:") 123 | historical_fins = ws.get_account_historical_financials(account['id'], account['currency']) 124 | for hf in historical_fins: 125 | value = hf['netLiquidationValueV2']['cents'] / 100 126 | deposits = hf['netDepositsV2']['cents'] / 100 127 | gains = value - deposits 128 | print(f" - {hf['date']} = ${value:,.0f} - {deposits:,.0f} (deposits) = {gains:,.0f} (gains)") 129 | 130 | # Fetch activities (transactions) 131 | acts = ws.get_activities(account['id']) 132 | if acts: 133 | print(" Transactions:") 134 | acts.reverse() # Activities are sorted by OCCURRED_AT_DESC by default 135 | 136 | for act in acts: 137 | if act['type'] == 'DIY_BUY': 138 | act['amountSign'] = 'negative' 139 | 140 | # Print transaction details 141 | print( 142 | f" - [{datetime.strptime(act['occurredAt'].replace(':', ''), '%Y-%m-%dT%H%M%S.%f%z')}] [{act['canonicalId']}] {act['description']} " 143 | f"{'+' if act['amountSign'] == 'positive' else '-'}{act['amount']} {act['currency']}") 144 | 145 | if act['description'] == f"{act['type']}: {act['subType']}": 146 | # This is an "unknown" transaction, for which description is generic; please open an issue on https://github.com/gboudreau/ws-api-python/issues and include the following: 147 | print(f" Unknown activity: {act}") 148 | 149 | print() 150 | 151 | if __name__ == "__main__": 152 | WSApiTest().main() 153 | 154 | ``` 155 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /ws_api/wealthsimple_api.py: -------------------------------------------------------------------------------- 1 | import re 2 | import uuid 3 | from collections.abc import Callable 4 | from datetime import datetime, timedelta 5 | from inspect import signature 6 | from typing import Any 7 | 8 | import requests 9 | 10 | from ws_api.exceptions import ( 11 | CurlException, 12 | LoginFailedException, 13 | ManualLoginRequired, 14 | OTPRequiredException, 15 | UnexpectedException, 16 | WSApiException, 17 | ) 18 | from ws_api.session import WSAPISession 19 | 20 | 21 | class WealthsimpleAPIBase: 22 | OAUTH_BASE_URL = 'https://api.production.wealthsimple.com/v1/oauth/v2' 23 | GRAPHQL_URL = 'https://my.wealthsimple.com/graphql' 24 | GRAPHQL_VERSION = '12' 25 | 26 | GRAPHQL_QUERIES = { 27 | 'FetchAllAccountFinancials': "query FetchAllAccountFinancials($identityId: ID!, $startDate: Date, $pageSize: Int = 25, $cursor: String) {\n identity(id: $identityId) {\n id\n ...AllAccountFinancials\n __typename\n }\n}\n\nfragment AllAccountFinancials on Identity {\n accounts(filter: {}, first: $pageSize, after: $cursor) {\n pageInfo {\n hasNextPage\n endCursor\n __typename\n }\n edges {\n cursor\n node {\n ...AccountWithFinancials\n __typename\n }\n __typename\n }\n __typename\n }\n __typename\n}\n\nfragment AccountWithFinancials on Account {\n ...AccountWithLink\n ...AccountFinancials\n __typename\n}\n\nfragment AccountWithLink on Account {\n ...Account\n linkedAccount {\n ...Account\n __typename\n }\n __typename\n}\n\nfragment Account on Account {\n ...AccountCore\n custodianAccounts {\n ...CustodianAccount\n __typename\n }\n __typename\n}\n\nfragment AccountCore on Account {\n id\n archivedAt\n branch\n closedAt\n createdAt\n cacheExpiredAt\n currency\n requiredIdentityVerification\n unifiedAccountType\n supportedCurrencies\n nickname\n status\n accountOwnerConfiguration\n accountFeatures {\n ...AccountFeature\n __typename\n }\n accountOwners {\n ...AccountOwner\n __typename\n }\n type\n __typename\n}\n\nfragment AccountFeature on AccountFeature {\n name\n enabled\n __typename\n}\n\nfragment AccountOwner on AccountOwner {\n accountId\n identityId\n accountNickname\n clientCanonicalId\n accountOpeningAgreementsSigned\n name\n email\n ownershipType\n activeInvitation {\n ...AccountOwnerInvitation\n __typename\n }\n sentInvitations {\n ...AccountOwnerInvitation\n __typename\n }\n __typename\n}\n\nfragment AccountOwnerInvitation on AccountOwnerInvitation {\n id\n createdAt\n inviteeName\n inviteeEmail\n inviterName\n inviterEmail\n updatedAt\n sentAt\n status\n __typename\n}\n\nfragment CustodianAccount on CustodianAccount {\n id\n branch\n custodian\n status\n updatedAt\n __typename\n}\n\nfragment AccountFinancials on Account {\n id\n custodianAccounts {\n id\n branch\n financials {\n current {\n ...CustodianAccountCurrentFinancialValues\n __typename\n }\n __typename\n }\n __typename\n }\n financials {\n currentCombined {\n id\n ...AccountCurrentFinancials\n __typename\n }\n __typename\n }\n __typename\n}\n\nfragment CustodianAccountCurrentFinancialValues on CustodianAccountCurrentFinancialValues {\n deposits {\n ...Money\n __typename\n }\n earnings {\n ...Money\n __typename\n }\n netDeposits {\n ...Money\n __typename\n }\n netLiquidationValue {\n ...Money\n __typename\n }\n withdrawals {\n ...Money\n __typename\n }\n __typename\n}\n\nfragment Money on Money {\n amount\n cents\n currency\n __typename\n}\n\nfragment AccountCurrentFinancials on AccountCurrentFinancials {\n id\n netLiquidationValue {\n ...Money\n __typename\n }\n netDeposits {\n ...Money\n __typename\n }\n simpleReturns(referenceDate: $startDate) {\n ...SimpleReturns\n __typename\n }\n totalDeposits {\n ...Money\n __typename\n }\n totalWithdrawals {\n ...Money\n __typename\n }\n __typename\n}\n\nfragment SimpleReturns on SimpleReturns {\n amount {\n ...Money\n __typename\n }\n asOf\n rate\n referenceDate\n __typename\n}", 28 | 'FetchActivityFeedItems': "query FetchActivityFeedItems($first: Int, $cursor: Cursor, $condition: ActivityCondition, $orderBy: [ActivitiesOrderBy!] = OCCURRED_AT_DESC) {\n activityFeedItems(\n first: $first\n after: $cursor\n condition: $condition\n orderBy: $orderBy\n ) {\n edges {\n node {\n ...Activity\n __typename\n }\n __typename\n }\n pageInfo {\n hasNextPage\n endCursor\n __typename\n }\n __typename\n }\n}\n\nfragment Activity on ActivityFeedItem {\n accountId\n aftOriginatorName\n aftTransactionCategory\n aftTransactionType\n amount\n amountSign\n assetQuantity\n assetSymbol\n canonicalId\n currency\n eTransferEmail\n eTransferName\n externalCanonicalId\n identityId\n institutionName\n occurredAt\n p2pHandle\n p2pMessage\n spendMerchant\n securityId\n billPayCompanyName\n billPayPayeeNickname\n redactedExternalAccountNumber\n opposingAccountId\n status\n subType\n type\n strikePrice\n contractType\n expiryDate\n chequeNumber\n provisionalCreditAmount\n primaryBlocker\n interestRate\n frequency\n counterAssetSymbol\n rewardProgram\n counterPartyCurrency\n counterPartyCurrencyAmount\n counterPartyName\n fxRate\n fees\n reference\n __typename\n}", 29 | 'FetchSecuritySearchResult': "query FetchSecuritySearchResult($query: String!) {\n securitySearch(input: {query: $query}) {\n results {\n ...SecuritySearchResult\n __typename\n }\n __typename\n }\n}\n\nfragment SecuritySearchResult on Security {\n id\n buyable\n status\n stock {\n symbol\n name\n primaryExchange\n __typename\n }\n securityGroups {\n id\n name\n __typename\n }\n quoteV2 {\n ... on EquityQuote {\n marketStatus\n __typename\n }\n __typename\n }\n __typename\n}", 30 | 'FetchSecurityHistoricalQuotes': "query FetchSecurityHistoricalQuotes($id: ID!, $timerange: String! = \"1d\") {\n security(id: $id) {\n id\n historicalQuotes(timeRange: $timerange) {\n ...HistoricalQuote\n __typename\n }\n __typename\n }\n}\n\nfragment HistoricalQuote on HistoricalQuote {\n adjustedPrice\n currency\n date\n securityId\n time\n __typename\n}", 31 | 'FetchAccountsWithBalance': "query FetchAccountsWithBalance($ids: [String!]!, $type: BalanceType!) {\n accounts(ids: $ids) {\n ...AccountWithBalance\n __typename\n }\n}\n\nfragment AccountWithBalance on Account {\n id\n custodianAccounts {\n id\n financials {\n ... on CustodianAccountFinancialsSo {\n balance(type: $type) {\n ...Balance\n __typename\n }\n __typename\n }\n __typename\n }\n __typename\n }\n __typename\n}\n\nfragment Balance on Balance {\n quantity\n securityId\n __typename\n}", 32 | 'FetchSecurityMarketData': "query FetchSecurityMarketData($id: ID!) {\n security(id: $id) {\n id\n ...SecurityMarketData\n __typename\n }\n}\n\nfragment SecurityMarketData on Security {\n id\n allowedOrderSubtypes\n marginRates {\n ...MarginRates\n __typename\n }\n fundamentals {\n avgVolume\n high52Week\n low52Week\n yield\n peRatio\n marketCap\n currency\n description\n __typename\n }\n quote {\n bid\n ask\n open\n high\n low\n volume\n askSize\n bidSize\n last\n lastSize\n quotedAsOf\n quoteDate\n amount\n previousClose\n __typename\n }\n stock {\n primaryExchange\n primaryMic\n name\n symbol\n __typename\n }\n __typename\n}\n\nfragment MarginRates on MarginRates {\n clientMarginRate\n __typename\n}", 33 | 'FetchFundsTransfer': "query FetchFundsTransfer($id: ID!) {\n fundsTransfer: funds_transfer(id: $id, include_cancelled: true) {\n ...FundsTransfer\n __typename\n }\n}\n\nfragment FundsTransfer on FundsTransfer {\n id\n status\n cancellable\n rejectReason: reject_reason\n schedule {\n id\n __typename\n }\n source {\n ...BankAccountOwner\n __typename\n }\n destination {\n ...BankAccountOwner\n __typename\n }\n __typename\n}\n\nfragment BankAccountOwner on BankAccountOwner {\n bankAccount: bank_account {\n ...BankAccount\n __typename\n }\n __typename\n}\n\nfragment BankAccount on BankAccount {\n id\n accountName: account_name\n corporate\n createdAt: created_at\n currency\n institutionName: institution_name\n jurisdiction\n nickname\n type\n updatedAt: updated_at\n verificationDocuments: verification_documents {\n ...BankVerificationDocument\n __typename\n }\n verifications {\n ...BankAccountVerification\n __typename\n }\n ...CaBankAccount\n ...UsBankAccount\n __typename\n}\n\nfragment CaBankAccount on CaBankAccount {\n accountName: account_name\n accountNumber: account_number\n __typename\n}\n\nfragment UsBankAccount on UsBankAccount {\n accountName: account_name\n accountNumber: account_number\n __typename\n}\n\nfragment BankVerificationDocument on VerificationDocument {\n id\n acceptable\n updatedAt: updated_at\n createdAt: created_at\n documentId: document_id\n documentType: document_type\n rejectReason: reject_reason\n reviewedAt: reviewed_at\n reviewedBy: reviewed_by\n __typename\n}\n\nfragment BankAccountVerification on BankAccountVerification {\n custodianProcessedAt: custodian_processed_at\n custodianStatus: custodian_status\n document {\n ...BankVerificationDocument\n __typename\n }\n __typename\n}", 34 | 'FetchInstitutionalTransfer': "query FetchInstitutionalTransfer($id: ID!) {\n accountTransfer(id: $id) {\n ...InstitutionalTransfer\n __typename\n }\n}\n\nfragment InstitutionalTransfer on InstitutionalTransfer {\n id\n accountId: account_id\n state\n documentId: document_id\n documentType: document_type\n expectedCompletionDate: expected_completion_date\n timelineExpectation: timeline_expectation {\n lowerBound: lower_bound\n upperBound: upper_bound\n __typename\n }\n estimatedCompletionMaximum: estimated_completion_maximum\n estimatedCompletionMinimum: estimated_completion_minimum\n institutionName: institution_name\n transferStatus: external_state\n redactedInstitutionAccountNumber: redacted_institution_account_number\n expectedValue: expected_value\n transferType: transfer_type\n cancellable\n pdfUrl: pdf_url\n clientVisibleState: client_visible_state\n shortStatusDescription: short_status_description\n longStatusDescription: long_status_description\n progressPercentage: progress_percentage\n type\n rolloverType: rollover_type\n autoSignatureEligible: auto_signature_eligible\n parentInstitution: parent_institution {\n id\n name\n __typename\n }\n stateHistories: state_histories {\n id\n state\n notes\n transitionSubmittedBy: transition_submitted_by\n transitionedAt: transitioned_at\n transitionCode: transition_code\n __typename\n }\n transferFeeReimbursement: transfer_fee_reimbursement {\n id\n feeAmount: fee_amount\n __typename\n }\n docusignSentViaEmail: docusign_sent_via_email\n clientAccountType: client_account_type\n primaryClientIdentityId: primary_client_identity_id\n primaryOwnerSigned: primary_owner_signed\n secondaryOwnerSigned: secondary_owner_signed\n __typename\n}", 35 | 'FetchAccountHistoricalFinancials': "query FetchAccountHistoricalFinancials($id: ID!, $currency: Currency!, $startDate: Date, $resolution: DateResolution!, $endDate: Date, $first: Int, $cursor: String) {\n account(id: $id) {\n id\n financials {\n historicalDaily(\n currency: $currency\n startDate: $startDate\n resolution: $resolution\n endDate: $endDate\n first: $first\n after: $cursor\n ) {\n edges {\n node {\n ...AccountHistoricalFinancials\n __typename\n }\n __typename\n }\n pageInfo {\n hasNextPage\n endCursor\n __typename\n }\n __typename\n }\n __typename\n }\n __typename\n }\n }\n\n fragment AccountHistoricalFinancials on AccountHistoricalDailyFinancials {\n date\n netLiquidationValueV2 {\n ...Money\n __typename\n }\n netDepositsV2 {\n ...Money\n __typename\n }\n __typename\n }\n\n fragment Money on Money {\n amount\n cents\n currency\n __typename\n }", 36 | 'FetchIdentityHistoricalFinancials': "query FetchIdentityHistoricalFinancials($identityId: ID!, $currency: Currency!, $startDate: Date, $endDate: Date, $first: Int, $cursor: String, $accountIds: [ID!]) {\n identity(id: $identityId) {\n id\n financials(filter: {accounts: $accountIds}) {\n historicalDaily(\n currency: $currency\n startDate: $startDate\n endDate: $endDate\n first: $first\n after: $cursor\n ) {\n edges {\n node {\n ...IdentityHistoricalFinancials\n __typename\n }\n __typename\n }\n pageInfo {\n hasNextPage\n endCursor\n __typename\n }\n __typename\n }\n __typename\n }\n __typename\n }\n }\n\n fragment IdentityHistoricalFinancials on IdentityHistoricalDailyFinancials {\n date\n netLiquidationValueV2 {\n amount\n currency\n __typename\n }\n netDepositsV2 {\n amount\n currency\n __typename\n }\n __typename\n }", 37 | 'FetchCorporateActionChildActivities': "query FetchCorporateActionChildActivities($activityCanonicalId: String!) {\n corporateActionChildActivities(\n condition: {activityCanonicalId: $activityCanonicalId}\n ) {\n nodes {\n ...CorporateActionChildActivity\n __typename\n }\n __typename\n }\n}\n\nfragment CorporateActionChildActivity on CorporateActionChildActivity {\n canonicalId\n activityCanonicalId\n assetName\n assetSymbol\n assetType\n entitlementType\n quantity\n currency\n price\n recordDate\n __typename\n}", 38 | 'FetchBrokerageMonthlyStatementTransactions': "query FetchBrokerageMonthlyStatementTransactions($period: String!, $accountId: String!) {\n brokerageMonthlyStatements(period: $period, accountId: $accountId) {\n id\n statementType\n createdAt\n data {\n ... on BrokerageMonthlyStatementObject {\n ...BrokerageMonthlyStatementObject\n __typename\n }\n __typename\n }\n __typename\n }\n}\n\nfragment BrokerageMonthlyStatementObject on BrokerageMonthlyStatementObject {\n custodianAccountId\n activitiesPerCurrency {\n currency\n currentTransactions {\n ...BrokerageMonthlyStatementTransactions\n __typename\n }\n __typename\n }\n currentTransactions {\n ...BrokerageMonthlyStatementTransactions\n __typename\n }\n isMultiCurrency\n __typename\n}\n\nfragment BrokerageMonthlyStatementTransactions on BrokerageMonthlyStatementTransactions {\n balance\n cashMovement\n unit\n description\n transactionDate\n transactionType\n __typename\n}", 39 | 'FetchIdentityPositions': "query FetchIdentityPositions($identityId: ID!, $currency: Currency!, $first: Int, $cursor: String, $accountIds: [ID!], $aggregated: Boolean, $currencyOverride: CurrencyOverride, $sort: PositionSort, $sortDirection: PositionSortDirection, $filter: PositionFilter, $since: PointInTime, $includeSecurity: Boolean = false, $includeAccountData: Boolean = false, $includeOneDayReturnsBaseline: Boolean = false) {\n identity(id: $identityId) {\n id\n financials(filter: {accounts: $accountIds}) {\n current(currency: $currency) {\n id\n positions(\n first: $first\n after: $cursor\n aggregated: $aggregated\n filter: $filter\n sort: $sort\n sortDirection: $sortDirection\n ) {\n edges {\n node {\n ...PositionV2\n __typename\n }\n __typename\n }\n pageInfo {\n hasNextPage\n endCursor\n __typename\n }\n totalCount\n status\n hasOptionsPosition\n hasCryptoPositionsOnly\n securityTypes\n securityCurrencies\n __typename\n }\n __typename\n }\n __typename\n }\n __typename\n }\n}\n\nfragment SecuritySummary on Security {\n ...SecuritySummaryDetails\n stock {\n ...StockSummary\n __typename\n }\n quoteV2(currency: null) {\n ...SecurityQuoteV2\n __typename\n }\n optionDetails {\n ...OptionSummary\n __typename\n }\n __typename\n}\n\nfragment SecuritySummaryDetails on Security {\n id\n currency\n inactiveDate\n status\n wsTradeEligible\n equityTradingSessionType\n securityType\n active\n securityGroups {\n id\n name\n __typename\n }\n features\n logoUrl\n __typename\n}\n\nfragment StockSummary on Stock {\n name\n symbol\n primaryMic\n primaryExchange\n __typename\n}\n\nfragment StreamedSecurityQuoteV2 on UnifiedQuote {\n __typename\n securityId\n ask\n bid\n currency\n price\n sessionPrice\n quotedAsOf\n ... on EquityQuote {\n marketStatus\n askSize\n bidSize\n close\n high\n last\n lastSize\n low\n open\n mid\n volume: vol\n referenceClose\n __typename\n }\n ... on OptionQuote {\n marketStatus\n askSize\n bidSize\n close\n high\n last\n lastSize\n low\n open\n mid\n volume: vol\n breakEven\n inTheMoney\n liquidityStatus\n openInterest\n underlyingSpot\n __typename\n }\n}\n\nfragment SecurityQuoteV2 on UnifiedQuote {\n ...StreamedSecurityQuoteV2\n previousBaseline\n __typename\n}\n\nfragment OptionSummary on Option {\n underlyingSecurity {\n ...UnderlyingSecuritySummary\n __typename\n }\n maturity\n osiSymbol\n expiryDate\n multiplier\n optionType\n strikePrice\n __typename\n}\n\nfragment UnderlyingSecuritySummary on Security {\n id\n stock {\n name\n primaryExchange\n primaryMic\n symbol\n __typename\n }\n __typename\n}\n\nfragment PositionLeg on PositionLeg {\n security {\n id\n ...SecuritySummary @include(if: $includeSecurity)\n __typename\n }\n quantity\n positionDirection\n bookValue {\n amount\n currency\n __typename\n }\n totalValue(currencyOverride: $currencyOverride) {\n amount\n currency\n __typename\n }\n averagePrice {\n amount\n currency\n __typename\n }\n percentageOfAccount\n unrealizedReturns(since: $since) {\n amount\n currency\n __typename\n }\n marketAveragePrice: averagePrice(currencyOverride: $currencyOverride) {\n amount\n currency\n __typename\n }\n marketBookValue: bookValue(currencyOverride: $currencyOverride) {\n amount\n currency\n __typename\n }\n marketUnrealizedReturns: unrealizedReturns(currencyOverride: $currencyOverride) {\n amount\n currency\n __typename\n }\n oneDayReturnsBaselineV2(currencyOverride: $currencyOverride) @include(if: $includeOneDayReturnsBaseline) {\n baseline {\n currency\n amount\n __typename\n }\n useDailyPriceChange\n __typename\n }\n __typename\n}\n\nfragment PositionV2 on PositionV2 {\n id\n quantity\n accounts @include(if: $includeAccountData) {\n id\n __typename\n }\n percentageOfAccount\n positionDirection\n bookValue {\n amount\n currency\n __typename\n }\n averagePrice {\n amount\n currency\n __typename\n }\n marketAveragePrice: averagePrice(currencyOverride: $currencyOverride) {\n amount\n currency\n __typename\n }\n marketBookValue: bookValue(currencyOverride: $currencyOverride) {\n amount\n currency\n __typename\n }\n totalValue(currencyOverride: $currencyOverride) {\n amount\n currency\n __typename\n }\n unrealizedReturns(since: $since) {\n amount\n currency\n __typename\n }\n marketUnrealizedReturns: unrealizedReturns(currencyOverride: $currencyOverride) {\n amount\n currency\n __typename\n }\n security {\n id\n ...SecuritySummary @include(if: $includeSecurity)\n __typename\n }\n oneDayReturnsBaselineV2(currencyOverride: $currencyOverride) @include(if: $includeOneDayReturnsBaseline) {\n baseline {\n currency\n amount\n __typename\n }\n useDailyPriceChange\n __typename\n }\n strategyType\n legs {\n ...PositionLeg\n __typename\n }\n __typename\n}", 40 | } 41 | 42 | def __init__(self, sess: WSAPISession | None = None): 43 | self.security_market_data_cache_getter = None 44 | self.security_market_data_cache_setter = None 45 | self.session = WSAPISession() 46 | self.start_session(sess) 47 | 48 | user_agent: str | None = None 49 | 50 | @staticmethod 51 | def set_user_agent(user_agent: str) -> None: 52 | WealthsimpleAPI.user_agent = user_agent 53 | 54 | @staticmethod 55 | def uuidv4() -> str: 56 | return str(uuid.uuid4()) 57 | 58 | def send_http_request( 59 | self, url: str, method: str = 'POST', data: dict | None = None, headers: dict | None = None, return_headers: bool = False 60 | ) -> Any: 61 | headers = headers or {} 62 | if method == 'POST': 63 | headers['Content-Type'] = 'application/json' 64 | 65 | if self.session.session_id: 66 | headers['x-ws-session-id'] = self.session.session_id 67 | 68 | if self.session.access_token and (not data or data.get('grant_type') != 'refresh_token'): 69 | headers['Authorization'] = f"Bearer {self.session.access_token}" 70 | 71 | if self.session.wssdi: 72 | headers['x-ws-device-id'] = self.session.wssdi 73 | 74 | if WealthsimpleAPI.user_agent: 75 | headers['User-Agent'] = WealthsimpleAPI.user_agent 76 | 77 | try: 78 | response = requests.request(method, url, json=data, headers=headers) 79 | 80 | if return_headers: 81 | # Combine headers and body as a single string 82 | response_headers = '\r\n'.join(f"{k}: {v}" for k, v in response.headers.items()) 83 | return f"{response_headers}\r\n\r\n{response.text}" 84 | 85 | return response.json() 86 | except requests.exceptions.RequestException as e: 87 | raise CurlException(f"HTTP request failed: {e}") 88 | 89 | def send_get(self, url: str, headers: dict | None = None, return_headers: bool = False) -> Any: 90 | return self.send_http_request(url, 'GET', headers=headers, return_headers=return_headers) 91 | 92 | def send_post(self, url: str, data: dict, headers: dict | None = None, return_headers: bool = False) -> Any: 93 | return self.send_http_request(url, 'POST', data=data, headers=headers, return_headers=return_headers) 94 | 95 | def start_session(self, sess: WSAPISession | None = None): 96 | if sess: 97 | self.session.access_token = sess.access_token 98 | self.session.wssdi = sess.wssdi 99 | self.session.session_id = sess.session_id 100 | self.session.client_id = sess.client_id 101 | self.session.refresh_token = sess.refresh_token 102 | return 103 | 104 | app_js_url = None 105 | 106 | if not self.session.wssdi or not self.session.client_id: 107 | # Fetch login page 108 | response = self.send_get('https://my.wealthsimple.com/app/login', return_headers=True) 109 | 110 | for line in response.splitlines(): 111 | # Look for wssdi in set-cookie headers 112 | if not self.session.wssdi and "set-cookie:" in line.lower(): 113 | match = re.search(r"wssdi=([a-f0-9]+);", line, re.IGNORECASE) 114 | if match: 115 | self.session.wssdi = match.group(1) 116 | 117 | if not app_js_url and " WSAPISession: 197 | data = { 198 | 'grant_type': 'password', 199 | 'username': username, 200 | 'password': password, 201 | 'skip_provision': 'true', 202 | 'scope': scope, 203 | 'client_id': self.session.client_id, 204 | 'otp_claim': None, 205 | } 206 | 207 | headers = { 208 | 'x-wealthsimple-client': '@wealthsimple/wealthsimple', 209 | 'x-ws-profile': 'undefined' 210 | } 211 | 212 | if otp_answer: 213 | headers['x-wealthsimple-otp'] = f"{otp_answer};remember=true" 214 | 215 | # Send the POST request for token 216 | response_data = self.send_post( 217 | url=f"{self.OAUTH_BASE_URL}/token", 218 | data=data, 219 | headers=headers 220 | ) 221 | 222 | if 'error' in response_data and response_data['error'] == "invalid_grant" and otp_answer is None: 223 | raise OTPRequiredException("2FA code required") 224 | 225 | if 'error' in response_data: 226 | raise LoginFailedException("Login failed", response_data) 227 | 228 | # Update the session with the tokens 229 | self.session.access_token = response_data['access_token'] 230 | self.session.refresh_token = response_data['refresh_token'] 231 | 232 | # Persist the session if a persist function is provided 233 | if persist_session_fct: 234 | if len(signature(persist_session_fct).parameters) == 2: 235 | persist_session_fct(self.session.to_json(), username) 236 | else: 237 | persist_session_fct(self.session.to_json()) 238 | 239 | return self.session 240 | 241 | def do_graphql_query(self, query_name: str, variables: dict, data_response_path: str, expect_type: str, 242 | filter_fn: Callable[[Any], bool] | None = None, *, load_all_pages: bool = False): 243 | query = { 244 | 'operationName': query_name, 245 | 'query': self.GRAPHQL_QUERIES[query_name], 246 | 'variables': variables, 247 | } 248 | 249 | headers = { 250 | "x-ws-profile": "trade", 251 | "x-ws-api-version": self.GRAPHQL_VERSION, 252 | "x-ws-locale": "en-CA", 253 | "x-platform-os": "web", 254 | } 255 | 256 | response_data = self.send_post( 257 | url=self.GRAPHQL_URL, 258 | data=query, 259 | headers=headers 260 | ) 261 | 262 | if 'data' not in response_data: 263 | raise WSApiException(f"GraphQL query failed: {query_name}", response_data) 264 | 265 | data = response_data['data'] 266 | 267 | end_cursor = None 268 | 269 | # Access the nested data using the data_response_path 270 | for key in data_response_path.split('.'): 271 | if key not in data: 272 | raise WSApiException(f"GraphQL query failed: {query_name}", response_data) 273 | data = data[key] 274 | if ( 275 | isinstance(data, dict) 276 | and 'pageInfo' in data 277 | and isinstance(data['pageInfo'], dict) 278 | and data['pageInfo'].get('hasNextPage') 279 | and 'endCursor' in data['pageInfo'] 280 | ): 281 | end_cursor = data['pageInfo'].get('endCursor') 282 | 283 | # Ensure the data type matches the expected one (either array or object) 284 | if (expect_type == 'array' and not isinstance(data, list)) or ( 285 | expect_type == 'object' and not isinstance(data, dict)): 286 | raise WSApiException(f"GraphQL query failed: {query_name}", response_data) 287 | 288 | # noinspection PyUnboundLocalVariable 289 | if key == 'edges': 290 | data = [edge['node'] for edge in data] 291 | 292 | if filter_fn: 293 | data = list(filter(filter_fn, data)) 294 | 295 | if load_all_pages: 296 | if expect_type != 'array': 297 | raise UnexpectedException("Can't load all pages for GraphQL queries that do not return arrays") 298 | if end_cursor: 299 | variables['cursor'] = end_cursor 300 | more_data = self.do_graphql_query(query_name, variables, data_response_path, expect_type, filter_fn, load_all_pages=True) 301 | if isinstance(data, list) and isinstance(more_data, list): 302 | data += more_data 303 | 304 | return data 305 | 306 | def get_token_info(self): 307 | if not self.session.token_info: 308 | headers = { 309 | 'x-wealthsimple-client': '@wealthsimple/wealthsimple' 310 | } 311 | response = self.send_get(self.OAUTH_BASE_URL + '/token/info', headers=headers) 312 | self.session.token_info = response 313 | return self.session.token_info 314 | 315 | @staticmethod 316 | def login( 317 | username: str, 318 | password: str, 319 | otp_answer: str | None = None, 320 | persist_session_fct: Callable | None = None, 321 | scope: str = SCOPE_READ_ONLY 322 | ) -> WSAPISession: 323 | """Login to Wealthsimple API and return a session object. 324 | 325 | Args: 326 | username (str): The username of the Wealthsimple account. 327 | password (str): The password of the Wealthsimple account. 328 | otp_answer (str, optional): The answer to the 2FA code. Defaults to None. 329 | persist_session_fct (callable, optional): A function to call to persist the session. Defaults to None. 330 | scope (str, optional): The OAuth scope for the session. Defaults to SCOPE_READ_ONLY. 331 | 332 | Returns: 333 | WSAPISession: The session object. 334 | 335 | Raises: 336 | LoginFailedException: If the login fails. 337 | OTPRequiredException: If 2FA code is required. 338 | """ 339 | ws = WealthsimpleAPI() 340 | return ws.login_internal(username, password, otp_answer, persist_session_fct, scope) 341 | 342 | @staticmethod 343 | def from_token(sess: WSAPISession, persist_session_fct: Callable | None = None, username: str | None = None): 344 | ws = WealthsimpleAPI(sess) 345 | ws.check_oauth_token(persist_session_fct, username) 346 | return ws 347 | 348 | class WealthsimpleAPI(WealthsimpleAPIBase): 349 | def __init__(self, sess: WSAPISession | None = None) -> None: 350 | super().__init__(sess) 351 | self.account_cache = {} 352 | 353 | def get_accounts(self, open_only=True, use_cache=True): 354 | cache_key = 'open' if open_only else 'all' 355 | if not use_cache or cache_key not in self.account_cache: 356 | filter_fn = (lambda acc: acc.get('status') == 'open') if open_only else None 357 | 358 | accounts = self.do_graphql_query( 359 | 'FetchAllAccountFinancials', 360 | { 361 | 'pageSize': 25, 362 | 'identityId': self.get_token_info().get('identity_canonical_id'), 363 | }, 364 | 'identity.accounts.edges', 365 | 'array', 366 | filter_fn=filter_fn, 367 | load_all_pages=True, 368 | ) 369 | for account in accounts: 370 | self._account_add_description(account) 371 | self.account_cache[cache_key] = accounts 372 | return self.account_cache[cache_key] 373 | 374 | @staticmethod 375 | def _account_add_description(account): 376 | account['number'] = account['id'] 377 | # This is the account number visible in the WS app: 378 | for ca in account['custodianAccounts']: 379 | if (ca['branch'] in ['WS', 'TR']) and ca['status'] == 'open': 380 | account['number'] = ca['id'] 381 | 382 | # Default 383 | account['description'] = account['unifiedAccountType'] 384 | 385 | if account.get('nickname'): 386 | account['description'] = account['nickname'] 387 | elif account['unifiedAccountType'] == 'CASH': 388 | account['description'] = "Cash: joint" if account['accountOwnerConfiguration'] == 'MULTI_OWNER' else "Cash" 389 | elif account['unifiedAccountType'] == 'SELF_DIRECTED_RRSP': 390 | account['description'] = f"RRSP: self-directed - {account['currency']}" 391 | elif account['unifiedAccountType'] == 'MANAGED_RRSP': 392 | account['description'] = f"RRSP: managed - {account['currency']}" 393 | elif account['unifiedAccountType'] == 'SELF_DIRECTED_SPOUSAL_RRSP': 394 | account['description'] = f"RRSP: self-directed spousal - {account['currency']}" 395 | elif account['unifiedAccountType'] == 'SELF_DIRECTED_TFSA': 396 | account['description'] = f"TFSA: self-directed - {account['currency']}" 397 | elif account['unifiedAccountType'] == 'MANAGED_TFSA': 398 | account['description'] = f"TFSA: managed - {account['currency']}" 399 | elif account['unifiedAccountType'] == 'SELF_DIRECTED_NON_REGISTERED': 400 | account['description'] = "Non-registered: self-directed" 401 | elif account['unifiedAccountType'] == 'SELF_DIRECTED_JOINT_NON_REGISTERED': 402 | account['description'] = "Non-registered: self-directed - joint" 403 | elif account['unifiedAccountType'] == 'SELF_DIRECTED_NON_REGISTERED_MARGIN': 404 | account['description'] = "Non-registered: self-directed margin" 405 | elif account['unifiedAccountType'] == 'MANAGED_JOINT': 406 | account['description'] = "Non-registered: managed - joint" 407 | elif account['unifiedAccountType'] == 'SELF_DIRECTED_CRYPTO': 408 | account['description'] = "Crypto" 409 | elif account['unifiedAccountType'] == 'SELF_DIRECTED_RRIF': 410 | account['description'] = f"RRIF: self-directed - {account['currency']}" 411 | elif account['unifiedAccountType'] == 'CREDIT_CARD': 412 | account['description'] = "Credit card" 413 | # TODO: Add other types as needed 414 | 415 | def get_account_balances(self, account_id): 416 | accounts = self.do_graphql_query( 417 | 'FetchAccountsWithBalance', 418 | { 419 | 'type': 'TRADING', 420 | 'ids': [account_id], 421 | }, 422 | 'accounts', 423 | 'array', 424 | ) 425 | 426 | # Extracting balances and returning them in a dictionary 427 | balances = {} 428 | for account in accounts[0]['custodianAccounts']: 429 | for balance in account['financials']['balance']: 430 | security = balance['securityId'] 431 | if security not in {'sec-c-cad', 'sec-c-usd'}: 432 | security = self.security_id_to_symbol(security) 433 | balances[security] = balance['quantity'] 434 | 435 | return balances 436 | 437 | def get_account_historical_financials(self, account_id: str, currency: str = 'CAD', start_date = None, end_date = None, resolution = 'WEEKLY', first = None, cursor = None): 438 | return self.do_graphql_query( 439 | 'FetchAccountHistoricalFinancials', 440 | { 441 | 'id': account_id, 442 | 'currency': currency, 443 | 'startDate': start_date.strftime('%Y-%m-%dT%H:%M:%S.%fZ') if start_date else None, 444 | 'endDate': end_date.strftime('%Y-%m-%dT%H:%M:%S.%fZ') if end_date else None, 445 | 'resolution': resolution, 446 | 'first': first, 447 | 'cursor': cursor 448 | }, 449 | 'account.financials.historicalDaily.edges', 450 | 'array', 451 | ) 452 | 453 | def get_identity_historical_financials(self, account_ids = None, currency: str = 'CAD', start_date = None, end_date = None, first = None, cursor = None): 454 | return self.do_graphql_query( 455 | 'FetchIdentityHistoricalFinancials', 456 | { 457 | 'identityId': self.get_token_info().get('identity_canonical_id'), 458 | 'currency': currency, 459 | 'startDate': start_date.strftime('%Y-%m-%dT%H:%M:%S.%fZ') if start_date else None, 460 | 'endDate': end_date.strftime('%Y-%m-%dT%H:%M:%S.%fZ') if end_date else None, 461 | 'first': first, 462 | 'cursor': cursor, 463 | 'accountIds': account_ids or [], 464 | }, 465 | 'identity.financials.historicalDaily.edges', 466 | 'array', 467 | ) 468 | 469 | def get_activities( 470 | self, 471 | account_id: str | list[str], 472 | how_many: int = 50, 473 | order_by: str = 'OCCURRED_AT_DESC', 474 | ignore_rejected: bool = True, 475 | start_date: datetime | None = None, 476 | end_date: datetime | None = None, 477 | load_all: bool = False 478 | ) -> list[Any]: 479 | """Retrieve activities for a specific account or list of accounts. 480 | 481 | Args: 482 | account_id (str | list[str]): The account ID or list of account IDs to retrieve activities for. 483 | how_many (int): The maximum number of activities to retrieve. 484 | order_by (str): The order in which to sort the activities. 485 | ignore_rejected (bool): Whether to ignore rejected or cancelled activities. 486 | start_date (datetime, optional): The start date for filtering activities. 487 | end_date (datetime, optional): The end date for filtering activities. 488 | load_all (bool): Whether to load all pages of activities. 489 | 490 | Returns: 491 | list[Any]: A list of activity objects. 492 | 493 | Raises: 494 | WSApiException: If the response format is unexpected. 495 | """ 496 | if isinstance(account_id, str): 497 | account_id = [account_id] 498 | # Calculate the end date for the condition 499 | end_date = (end_date if end_date else datetime.now() + timedelta(hours=23, minutes=59, seconds=59, milliseconds=999)) 500 | 501 | # Filter function to ignore rejected/cancelled/expired activities 502 | def filter_fn(activity): 503 | act_type = (activity.get('type', '') or '').upper() 504 | status = (activity.get('status', '') or '').lower() 505 | excluded_statuses = {'rejected', 'cancelled', 'expired'} 506 | is_excluded = any(s in status for s in excluded_statuses) 507 | return act_type != 'LEGACY_TRANSFER' and (not ignore_rejected or status == '' or not is_excluded) 508 | 509 | activities = self.do_graphql_query( 510 | 'FetchActivityFeedItems', 511 | { 512 | 'orderBy': order_by, 513 | 'first': how_many, 514 | 'condition': { 515 | 'startDate': start_date.strftime('%Y-%m-%dT%H:%M:%S.%fZ') if start_date else None, 516 | 'endDate': end_date.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), 517 | 'accountIds': account_id, 518 | }, 519 | }, 520 | 'activityFeedItems.edges', 521 | 'array', 522 | filter_fn=filter_fn, 523 | load_all_pages=load_all, 524 | ) 525 | 526 | if not isinstance(activities, list): 527 | raise WSApiException(f"Unexpected response format: {self.get_activities.__name__}", activities) 528 | for act in activities: 529 | self._activity_add_description(act) 530 | 531 | return activities 532 | 533 | def _activity_add_description(self, act): 534 | act['description'] = f"{act['type']}: {act['subType']}" 535 | 536 | if act['type'] == 'INTERNAL_TRANSFER': 537 | accounts = self.get_accounts(False) 538 | matching = [acc for acc in accounts if acc['id'] == act['opposingAccountId']] 539 | target_account = matching.pop() if matching else None 540 | account_description = ( 541 | f"{target_account['description']} ({target_account['number']})" 542 | if target_account else 543 | act['opposingAccountId'] 544 | ) 545 | if act['subType'] == 'SOURCE': 546 | act['description'] = f"Transfer out: Transfer to Wealthsimple {account_description}" 547 | else: 548 | act['description'] = f"Transfer in: Transfer from Wealthsimple {account_description}" 549 | 550 | elif act['type'] in ['DIY_BUY', 'DIY_SELL']: 551 | verb = act['subType'].replace('_', ' ').capitalize() 552 | action = 'buy' if act['type'] == 'DIY_BUY' else 'sell' 553 | security = self.security_id_to_symbol(act['securityId']) 554 | if act['assetQuantity'] is None: 555 | act['description'] = ( 556 | f"{verb}: {action} TBD" 557 | ) 558 | else: 559 | act['description'] = ( 560 | f"{verb}: {action} {float(act['assetQuantity'])} x " 561 | f"{security} @ {float(act['amount']) / float(act['assetQuantity'])}" 562 | ) 563 | 564 | elif act['type'] == 'CORPORATE_ACTION' and act['subType'] == 'SUBDIVISION': 565 | child_activities = self.get_corporate_action_child_activities(act['canonicalId']) 566 | held_activity = next((activity for activity in child_activities if activity['entitlementType'] == 'HOLD'), None) 567 | receive_activity = next((activity for activity in child_activities if activity['entitlementType'] == 'RECEIVE'), None) 568 | if held_activity and receive_activity: 569 | held_shares: float = float(held_activity['quantity']) 570 | received_shares: float = float(receive_activity['quantity']) 571 | total_shares: float = held_shares + received_shares 572 | act['description'] = ( 573 | f"Subdivision: {held_shares} -> {total_shares} shares of {act['assetSymbol']}" 574 | ) 575 | else: 576 | received_shares: float = float(act['amount']) 577 | act['description'] = f"Subdivision: Received {received_shares} new shares of {act['assetSymbol']}" 578 | 579 | if act["currency"] is None: 580 | security = self.get_security_market_data(act["securityId"]) 581 | if security and isinstance(security, dict): 582 | fundamentals = security.get("fundamentals") 583 | if fundamentals and isinstance(fundamentals, dict): 584 | act["currency"] = fundamentals.get("currency") 585 | 586 | elif act['type'] in ['DEPOSIT', 'WITHDRAWAL'] and act['subType'] in ['E_TRANSFER', 'E_TRANSFER_FUNDING']: 587 | direction = 'from' if act['type'] == 'DEPOSIT' else 'to' 588 | act['description'] = ( 589 | f"Deposit: Interac e-transfer {direction} {act['eTransferName']} {act['eTransferEmail']}" 590 | ) 591 | 592 | elif act['type'] == 'DEPOSIT' and act['subType'] == 'PAYMENT_CARD_TRANSACTION': 593 | type_ = act['type'].lower().capitalize() 594 | act['description'] = f"{type_}: Debit card funding" 595 | 596 | elif act['subType'] == 'EFT': 597 | details = self.get_etf_details(act['externalCanonicalId']) 598 | type_ = act['type'].lower().capitalize() 599 | direction = 'from' if act['type'] == 'DEPOSIT' else 'to' 600 | prop = 'source' if act['type'] == 'DEPOSIT' else 'destination' 601 | if isinstance(details, dict): 602 | bank_account_info = details.get(prop, {}) 603 | if isinstance(bank_account_info, dict): 604 | bank_account = bank_account_info.get('bankAccount', {}) 605 | nickname = bank_account.get('nickname') 606 | account_number = bank_account.get('accountNumber') 607 | if not nickname: 608 | nickname = bank_account.get('accountName') 609 | act['description'] = f"{type_}: EFT {direction} {nickname} {account_number}" 610 | 611 | elif act['type'] == 'REFUND' and act['subType'] == 'TRANSFER_FEE_REFUND': 612 | act['description'] = "Reimbursement: account transfer fee" 613 | 614 | elif act['type'] == 'INSTITUTIONAL_TRANSFER_INTENT' and act['subType'] == 'TRANSFER_IN': 615 | details = self.get_transfer_details(act['externalCanonicalId']) 616 | if isinstance(details, dict): 617 | verb = details['transferType'].replace('_', '-').capitalize() 618 | client_account_type = details['clientAccountType'].upper() 619 | institution_name = details['institutionName'] 620 | redacted_account_number = details['redactedInstitutionAccountNumber'] 621 | act['description'] = ( 622 | f"Institutional transfer: {verb} {client_account_type} " 623 | f"account transfer from {institution_name} " 624 | f"****{redacted_account_number}" 625 | ) 626 | elif act['type'] == 'INSTITUTIONAL_TRANSFER_INTENT' and act['subType'] == 'TRANSFER_OUT': 627 | act['description'] = ( 628 | f"Institutional transfer: transfer to {act['institutionName']}" 629 | ) 630 | elif act['type'] == 'INTEREST': 631 | if act['subType'] == 'FPL_INTEREST': 632 | act['description'] = "Stock Lending Earnings" 633 | else: 634 | act['description'] = "Interest" 635 | 636 | elif act['type'] == 'DIVIDEND': 637 | security = self.security_id_to_symbol(act['securityId']) 638 | act['description'] = f"Dividend: {security}" 639 | 640 | elif act['type'] == 'FUNDS_CONVERSION': 641 | act['description'] = f"Funds converted: {act['currency']} from {'USD' if act['currency'] == 'CAD' else 'CAD'}" 642 | 643 | elif act['type'] == 'NON_RESIDENT_TAX': 644 | act['description'] = "Non-resident tax" 645 | 646 | # Refs: 647 | # https://www.payments.ca/payment-resources/iso-20022/automatic-funds-transfer 648 | # https://www.payments.ca/compelling-new-evidence-strong-link-between-aft-and-canadas-cheque-decline 649 | # 2nd ref states: "AFTs are electronic direct credit or direct debit transactions, commonly known in Canada as direct deposits or pre-authorized debits (PADs)." 650 | elif act['type'] in ('DEPOSIT', 'WITHDRAWAL') and act['subType'] == 'AFT': 651 | type_ = 'Direct deposit' if act['type'] == 'DEPOSIT' else 'Pre-authorized debit' 652 | direction = 'from' if type_ == 'Direct deposit' else 'to' 653 | institution = act['aftOriginatorName'] if act['aftOriginatorName'] else act['externalCanonicalId'] 654 | act['description'] = f"{type_}: {direction} {institution}" 655 | 656 | elif act['type'] == 'WITHDRAWAL' and act['subType'] == 'BILL_PAY': 657 | type_ = act['type'].capitalize() 658 | name = act['billPayPayeeNickname'] 659 | if not name: 660 | name = act['billPayCompanyName'] 661 | number = act['redactedExternalAccountNumber'] 662 | act['description'] = f"{type_}: Bill pay {name} {number}" 663 | 664 | elif act['type'] == 'P2P_PAYMENT' and act['subType'] in ('SEND', 'SEND_RECEIVED'): 665 | direction = 'sent to' if act['subType'] == 'SEND' else 'received from' 666 | p2p_handle = act['p2pHandle'] 667 | act['description'] = f"Cash {direction} {p2p_handle}" 668 | 669 | elif act['type'] == 'PROMOTION' and act['subType'] == 'INCENTIVE_BONUS': 670 | type_ = act['type'].capitalize() 671 | subtype = act['subType'].replace('_', ' ').capitalize() 672 | act['description'] = f"{type_}: {subtype}" 673 | 674 | elif act['type'] == 'REFERRAL' and act['subType'] is None: 675 | type_ = act['type'].capitalize() 676 | act['description'] = f"{type_}" 677 | 678 | elif act['type'] == 'CREDIT_CARD' and act['subType'] == 'PURCHASE': 679 | merchant = act['spendMerchant'] 680 | status = '(Pending) ' if act['status'] == 'authorized' else '' # Posted purchase transactions have status = settled 681 | act['description'] = f"{status}Credit card purchase: {merchant}" 682 | 683 | elif act['type'] == 'CREDIT_CARD' and act['subType'] == 'HOLD': 684 | merchant = act['spendMerchant'] 685 | status = '(Pending) ' if act['status'] == 'authorized' else '' # Posted return transactions have subType = REFUND and status = settled 686 | act['description'] = f"{status}Credit card refund: {merchant}" 687 | 688 | elif act['type'] == 'CREDIT_CARD' and act['subType'] == 'REFUND': 689 | merchant = act['spendMerchant'] 690 | act['description'] = f"Credit card refund: {merchant}" 691 | 692 | elif (act['type'] == 'CREDIT_CARD' and act['subType'] == 'PAYMENT') or act['type'] == 'CREDIT_CARD_PAYMENT': 693 | act['description'] = "Credit card payment" 694 | 695 | elif act['type'] == 'REIMBURSEMENT' and act['subType'] == 'CASHBACK': 696 | program = "- Visa Infinite" if act['rewardProgram'] == 'CREDIT_CARD_VISA_INFINITE_REWARDS' else '' 697 | act['description'] = f"Cash back {program}".rstrip() 698 | 699 | elif act['type'] == 'SPEND' and act['subType'] == 'PREPAID': 700 | merchant = act['spendMerchant'] 701 | act['description'] = f"Purchase: {merchant}" 702 | 703 | # TODO: Add other types as needed 704 | 705 | def security_id_to_symbol(self, security_id: str) -> str: 706 | security_symbol = f"[{security_id}]" 707 | if self.security_market_data_cache_getter: 708 | market_data = self.get_security_market_data(security_id) 709 | if isinstance(market_data, dict) and market_data['stock']: 710 | stock = market_data['stock'] 711 | security_symbol = f"{stock['primaryExchange']}:{stock['symbol']}" 712 | return security_symbol 713 | 714 | def get_etf_details(self, funding_id): 715 | return self.do_graphql_query( 716 | 'FetchFundsTransfer', 717 | {'id': funding_id}, 718 | 'fundsTransfer', 719 | 'object', 720 | ) 721 | 722 | def get_transfer_details(self, transfer_id): 723 | return self.do_graphql_query( 724 | 'FetchInstitutionalTransfer', 725 | {'id': transfer_id}, 726 | 'accountTransfer', 727 | 'object', 728 | ) 729 | 730 | def set_security_market_data_cache(self, security_market_data_cache_getter: Callable, security_market_data_cache_setter: Callable) -> None: 731 | self.security_market_data_cache_getter = security_market_data_cache_getter 732 | self.security_market_data_cache_setter = security_market_data_cache_setter 733 | 734 | def get_security_market_data(self, security_id: str, use_cache: bool = True): 735 | if not self.security_market_data_cache_getter or not self.security_market_data_cache_setter: 736 | use_cache = False 737 | 738 | if use_cache: 739 | cached_value = self.security_market_data_cache_getter(security_id) 740 | if cached_value: 741 | return cached_value 742 | 743 | value = self.do_graphql_query( 744 | 'FetchSecurityMarketData', 745 | {'id': security_id}, 746 | 'security', 747 | 'object', 748 | ) 749 | 750 | if use_cache: 751 | value = self.security_market_data_cache_setter(security_id, value) 752 | 753 | return value 754 | 755 | 756 | 757 | def get_security_historical_quotes(self, security_id, time_range='1m'): 758 | # Fetch historical quotes for a security using GraphQL query 759 | return self.do_graphql_query( 760 | 'FetchSecurityHistoricalQuotes', 761 | { 762 | 'id': security_id, 763 | 'timerange': time_range, 764 | }, 765 | 'security.historicalQuotes', 766 | 'array', 767 | ) 768 | 769 | def get_corporate_action_child_activities(self, activity_canonical_id): 770 | # Fetch details about a corporate action (eg. a split) using GraphQL query 771 | return self.do_graphql_query( 772 | 'FetchCorporateActionChildActivities', 773 | { 774 | 'activityCanonicalId': activity_canonical_id, 775 | }, 776 | 'corporateActionChildActivities.nodes', 777 | 'array', 778 | ) 779 | 780 | def get_statement_transactions(self, account_id: str, period: str) -> list[Any]: 781 | """Retrieve transactions from account monthly statement. 782 | 783 | Args: 784 | account_id (str): The account ID to retrieve transactions for. 785 | period (str): The statement start date in 'YYYY-MM-DD' format. 786 | For example, '2025-10-01' for October 2025 statement. 787 | 788 | Returns: 789 | list[Any]: A list of transactions. 790 | 791 | Raises: 792 | WSApiException: If the response format is unexpected. 793 | """ 794 | statements = self.do_graphql_query( 795 | 'FetchBrokerageMonthlyStatementTransactions', 796 | { 797 | 'accountId': account_id, 798 | 'period': period, 799 | }, 800 | 'brokerageMonthlyStatements', 801 | 'array', 802 | ) 803 | 804 | if isinstance(statements, list) and len(statements) > 0: 805 | statement = statements[0] 806 | data = statement.get('data') if 'data' in statement else {} 807 | transactions = data.get('currentTransactions') if 'currentTransactions' in data else [] 808 | 809 | if not transactions: 810 | return [] 811 | if not isinstance(transactions, list): 812 | raise WSApiException(f"Unexpected response format: {self.get_statement_transactions.__name__}", transactions) 813 | 814 | return transactions 815 | 816 | def get_identity_positions(self, security_ids: list[str] | None, currency: str) -> list[Any]: 817 | """Retrieve information on specific positions 818 | 819 | Args: 820 | security_ids: list of Wealthsimple security ids, None will return all owned securities 821 | currency: currency to return the amounts in (CAD or USD) 822 | 823 | Returns: 824 | list[Any]: a list of positions by account 825 | 826 | Raises: 827 | WSApiException: If the response format is unexpected. 828 | """ 829 | positions = self.do_graphql_query( 830 | "FetchIdentityPositions", 831 | { 832 | "identityId": self.get_token_info().get("identity_canonical_id"), 833 | "currency": currency, 834 | "filter": {"securityIds": security_ids}, 835 | "includeAccountData": True, 836 | }, 837 | "identity.financials.current.positions.edges", 838 | "array", 839 | ) 840 | 841 | if not isinstance(positions, list): 842 | raise WSApiException(f"Unexpected response format: {self.get_identity_positions.__name__}", positions) 843 | 844 | return positions 845 | --------------------------------------------------------------------------------