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.1.tar.gz (53.4 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.1-py3-none-any.whl (44.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ws_api-0.34.1.tar.gz
  • Upload date:
  • Size: 53.4 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.1.tar.gz
Algorithm Hash digest
SHA256 91c0b31115728f8e75aa606949dd0b2319780d78093dc79b2237d07187c0fdf0
MD5 39d512d25268ff91cdaaf583ba11734d
BLAKE2b-256 0dbc1b3c592cb5036785cbd74420ae4d4d216f4c1eaa9aa6d38dacf83cc4dc75

See more details on using hashes here.

Provenance

The following attestation bundles were made for ws_api-0.34.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: ws_api-0.34.1-py3-none-any.whl
  • Upload date:
  • Size: 44.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 631f472bd054ea2c0a74a0c241933f461394a22114c12262fdf8859963d0e14e
MD5 6ccd7afb81f389ef4da4db00d0d336ea
BLAKE2b-256 873ce21797afdff63e2cb23e46ea5f7a848162512868fd8f03e96fcd39caada4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ws_api-0.34.1-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