Skip to content

SchwabPy 2.0.2 - API Compliance Fix

Latest

Choose a tag to compare

@jaycollett jaycollett released this 05 Dec 21:13
· 1 commit to main since this release

Release Notes

What's Fixed

  • BREAKING CHANGE: Made types parameter REQUIRED for get_transactions() method to align with official Schwab API documentation
  • Added validation to ensure types parameter is provided
  • Updated documentation to reflect ISO 8601 date format requirement (yyyy-MM-dd'T'HH:mm:ss.SSSZ)
  • Added comprehensive list of valid transaction types in docstring
  • Fixed transaction sync failures caused by missing required parameter

Breaking Changes

  • get_transactions() now requires the types parameter (previously optional)
  • Applications must update their calls to include transaction types:
    # Before (will now fail):
    transactions = client.accounts.get_transactions(account_hash, start_date, end_date)
    
    # After (required):
    transactions = client.accounts.get_transactions(
        account_hash,
        start_date="2024-01-01T00:00:00.000Z",
        end_date="2024-01-31T23:59:59.999Z",
        types="TRADE,DIVIDEND_OR_INTEREST"
    )

Migration Guide

Update all get_transactions() calls to include the types parameter with comma-separated transaction types:

  • Valid types: TRADE, RECEIVE_AND_DELIVER, DIVIDEND_OR_INTEREST, ACH_RECEIPT, ACH_DISBURSEMENT, CASH_RECEIPT, CASH_DISBURSEMENT, ELECTRONIC_FUND, WIRE_OUT, WIRE_IN, JOURNAL, MEMORANDUM, MARGIN_CALL, MONEY_MARKET, SMA_ADJUSTMENT

Changelog

Commits:

  • 96f8ee3 - Make types parameter required for get_transactions

Installation

pip install schwab-client==2.0.2