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.33.2.tar.gz (51.5 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.33.2-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ws_api-0.33.2.tar.gz
  • Upload date:
  • Size: 51.5 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.33.2.tar.gz
Algorithm Hash digest
SHA256 9cf1a123f14b0cd87807227eef38c976d221006ca71b497dd8e7932257e980e9
MD5 7eccf182bde93e471651531aeaf496db
BLAKE2b-256 db345e26a76f5c63a3a6e2bd0f3fd3244d925a9e04f78478424f91fe32c2f961

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ws_api-0.33.2-py3-none-any.whl
  • Upload date:
  • Size: 43.9 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.33.2-py3-none-any.whl
Algorithm Hash digest
SHA256 40964f1eae5953ed891c810e86e641bcc3f6c4488b0ad5c53c18e976726544ba
MD5 4ed727625133e728f611cbc4232839eb
BLAKE2b-256 c134b1a34e34651b5944977a0ebae6cd63f8ab585d41a758160b1d2595e936fd

See more details on using hashes here.

Provenance

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