-
Notifications
You must be signed in to change notification settings - Fork 5
/
tdameritrade.py
148 lines (120 loc) · 4.92 KB
/
tdameritrade.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Implements TD Ameritrade.
TD Ameritrade gain/loss output provides already-reconciled transactions, i.e.,
each buy/sell pair comes in a single record, on a single line.
Does not handle:
* dividends
* short sales
* partial lot sales
"""
from __future__ import annotations
import csv
from datetime import datetime
from decimal import Decimal
import re
from typing import Optional
from broker import Broker
from decorators import override
import utils
FIRST_LINE = ','.join([
'Security', 'Trans type', 'Qty', 'Open date', 'Adj cost',
'Close date', 'Adj proceeds', 'Adj gain($)', 'Adj gain(%)',
'Term\n'])
TRANSACTION_TYPE = 'Trans type'
class TDAmeritrade(Broker):
@classmethod
@override
def name(cls) -> str:
return "TD Ameritrade"
@classmethod
def buyDate(cls, txn: dict[str, str]) -> datetime:
"""Returns date of transaction as datetime object."""
# Our input date format is MM/DD/YYYY.
return datetime.strptime(txn['Open date'], '%m/%d/%Y')
@classmethod
def sellDate(cls, txn: dict[str, str]) -> datetime:
"""Returns date of transaction as datetime object."""
# Our input date format is MM/DD/YYYY.
return datetime.strptime(txn['Close date'], '%m/%d/%Y')
@classmethod
def isShortTerm(cls, txn: dict[str, str]) -> bool:
return txn['Term'] == 'Short-term'
@classmethod
def symbol(cls, txn: dict[str, str]) -> str:
match = re.match(r'^.*\((.*)\)$', txn['Security'])
if match:
return match.group(1)
else:
raise Exception('Security symbol not found in: %s' % txn)
@classmethod
def numShares(cls, txn: dict[str, str]) -> Decimal:
return Decimal(txn['Qty'])
@classmethod
def costBasis(cls, txn: dict[str, str]) -> Decimal:
# Proceeds amount may include commas as thousand separators, which
# Decimal does not handle.
return Decimal(txn['Adj cost'].replace(',', ''))
@classmethod
def saleProceeds(cls, txn: dict[str, str]) -> Decimal:
# Proceeds amount may include commas as thousand separators, which
# Decimal does not handle.
return Decimal(txn['Adj proceeds'].replace(',', ''))
@classmethod
@override
def isFileForBroker(cls, filename: str) -> bool:
with open(filename) as f:
first_line = f.readline()
return first_line == FIRST_LINE
@classmethod
@override
def parseFileToTxnList(cls, filename: str, tax_year: Optional[int]) -> list[utils.Transaction]:
txns = csv.reader(open(filename), delimiter=',', quotechar='"')
line_num = 0
txn_list: list[utils.Transaction] = []
names: list[str] = []
for row in txns:
line_num = line_num + 1
if line_num == 1:
names = row
continue
txn_dict = {}
for i in range(0, len(names)):
txn_dict[names[i]] = row[i]
if txn_dict['Security'] == 'Total:':
# This is the summary line where the string 'Total:' appears in
# the first column, so we're done.
break
curr_txn = utils.Transaction()
curr_txn.desc = '%s shares %s' % (
cls.numShares(txn_dict), cls.symbol(txn_dict))
buyDate = cls.buyDate(txn_dict)
curr_txn.buyDateStr = utils.txfDate(buyDate)
curr_txn.costBasis = cls.costBasis(txn_dict)
sellDate = cls.sellDate(txn_dict)
curr_txn.sellDateStr = utils.txfDate(sellDate)
curr_txn.saleProceeds = cls.saleProceeds(txn_dict)
assert sellDate >= buyDate, f'Sell date ({sellDate}) must be on or after buy date ({buyDate})'
if cls.isShortTerm(txn_dict):
# TODO(mbrukman): assert here that (sellDate - buyDate) <= 1 year
curr_txn.entryCode = 321 # "ST gain/loss - security"
else:
# TODO(mbrukman): assert here that (sellDate - buyDate) > 1 year
curr_txn.entryCode = 323 # "LT gain/loss - security"
if tax_year and sellDate.year != tax_year:
utils.Warning('ignoring txn: "%s" (line %d) as the sale is not from %d\n' %
(curr_txn.desc, line_num, tax_year))
continue
txn_list.append(curr_txn)
return txn_list