Skip to main content

Access your Wealthsimple account using their (GraphQL) API.

Project description

Unofficial Wealthsimple API Library for Python

This library allows you to access your own Wealthsimple account using the Wealthsimple (GraphQL) API.

Python 3.10+ required

Features

  • Retrieve all accounts (RRSP, TFSA, FHSA, cash, margin, crypto, credit card)
  • Get account balances and positions
  • Fetch historical performance (net value, deposits, gains)
  • Access transaction/activity history
  • Search securities and get market data
  • Historical price quotes
  • Handle 2FA (TOTP) authentication
  • Automatic session refresh
  • Optional security data caching

Installation

uv add ws-api
# or
pip install ws-api

Basic Example

from ws_api import WealthsimpleAPI

# Login (will prompt for username/password/TOTP)
session = WealthsimpleAPI.login(username="you@example.com", password="yourpassword")
ws = WealthsimpleAPI.from_token(session)

# Get your accounts
accounts = ws.get_accounts()
for account in accounts:
    print(f"{account['description']}: {account['number']}")

Full Example

Note: You'll need the keyring package to run the code below. Install with: uv add keyring (or pip install keyring)

See tests/test_full_example.py

Projects Using It

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ws_api-0.34.0.tar.gz (51.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ws_api-0.34.0-py3-none-any.whl (44.3 kB view details)

Uploaded Python 3

File details

Details for the file ws_api-0.34.0.tar.gz.

File metadata

  • Download URL: ws_api-0.34.0.tar.gz
  • Upload date:
  • Size: 51.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ws_api-0.34.0.tar.gz
Algorithm Hash digest
SHA256 ec2d6e00557b70d1306c43ebbad4a5cb64628db491a0b0aece661dc56349af4a
MD5 4a3caa4285836be122fd85af4a6efaba
BLAKE2b-256 8f227b8d7240649dbfcca44ff81a4a136e69f26af48ae687d841d476d0cd40e3

See more details on using hashes here.

Provenance

The following attestation bundles were made for ws_api-0.34.0.tar.gz:

Publisher: publish.yml on gboudreau/ws-api-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ws_api-0.34.0-py3-none-any.whl.

File metadata

  • Download URL: ws_api-0.34.0-py3-none-any.whl
  • Upload date:
  • Size: 44.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ws_api-0.34.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7732d64a75df762628db048e842e8e98e9df6c2da446f3aa610d8ba478b40c48
MD5 f862c96be577b896c11412a2b48d9471
BLAKE2b-256 f820313d7c0ba644dd35c20e45c901587b32baddaf0aa2b4d10d2a4381294c60

See more details on using hashes here.

Provenance

The following attestation bundles were made for ws_api-0.34.0-py3-none-any.whl:

Publisher: publish.yml on gboudreau/ws-api-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page