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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ws_api-0.33.1.tar.gz
  • Upload date:
  • Size: 51.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.33.1.tar.gz
Algorithm Hash digest
SHA256 d0ec0191d12610a54995dec4d1858cbac82129ae40dc61a8a8196aab58b2a090
MD5 25ff2b96c3948a7f67bd50de49f3c3f7
BLAKE2b-256 4f2bc43f39d73a3854a3487ca4bf51cd1503931285e176140d370b2e77e54089

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ws_api-0.33.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 29b9f510dd181cf601d3805083f306796fc8fa1da0ab393d51128aaa44b14fe9
MD5 721a3e884d137c644648195f304677ca
BLAKE2b-256 bba41228713a350061a2950fc981fd7c22f8795bb08f6ee8ac361ca8002c2260

See more details on using hashes here.

Provenance

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