API
Bot Reports
Get a single bot report or a list of all reports
Auth Required: Read Reports
GET
Request
Path Params
number
String
optional
Unique identifier for a specific report to retrieve. If omitted, all reports will be returned. If you do request a single report, you will receive more detailed results info for that report.
Header Parameters
API Token
String
required
Token from your Whispertrades account
Curl
Node.js
JS
Python
1curl --location -g --request GET 'https://api.whispertrades.com/v1/bots/reports/{number}' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json' \
4--header 'Authorization: Bearer <API Token>'
Responses
200
1{
2 "success": true,
3 "message": "",
4 "data": {
5 "number": "YON0KAJSSM",
6 "name": "All Bots MTD",
7 "status": "Complete",
8 "completed_at": "2023-10-04T20:59:41.000000Z",
9 "start_date": "2023-10-01",
10 "end_date": "2023-10-04",
11 "run_until_latest_date": true,
12 "is_public": false,
13 "symbol": "SPXW",
14 "nlv_source": "Actual NLV",
15 "nlv_amount": null,
16 "bot_statuses": [],
17 "brokers": [
18 {
19 "number": "1Z4XYBHX34",
20 "account_number": "194029194",
21 "name": "Personal"
22 },
23 {
24 "number": "HDJAKWIFQZ",
25 "account_number": "940195901",
26 "name": "Roth IRA"
27 }
28 ],
29 "bots": [],
30 "bot_tags": [],
31 "bot_position_tags": [],
32 "results": {
33 "total_trades": 18,
34 "winning_trades": 14,
35 "losing_trades": 4,
36 "win_percent": "77.78",
37 "starting_net_liquidation_value": "578123.25",
38 "ending_net_liquidation_value": "581281.25",
39 "average_gain": 485,
40 "average_win": 848,
41 "average_loss": -750,
42 "broker_fees": "48.79",
43 "premium_collected": "19416.22",
44 "premium_retained": "2974.53",
45 "premium_retained_percent": "15.32",
46 "total_return_dollars": "2974.53",
47 "total_return_percent": "0.51",
48 "max_drawdown_dollars": "-1736.06",
49 "max_drawdown_percent": "-2.99",
50 "max_drawdown_days": 1,
51 "cagr": "61.60",
52 "sharpe": "2.00",
53 "sortino": "1.41",
54 "mar": "20.6",
55 "annualized_volatility": "23.4",
56 "correlation": "0.26",
57 "beta": "0.31",
58 "underlying_total_return_percent": "0.31",
59 "underlying_max_drawdown_percent": "-1.43",
60 "underlying_max_drawdown_days": 2,
61 "underlying_cagr": "58.3",
62 "underlying_sharpe": "1.58",
63 "underlying_sortino": "1.72",
64 "underlying_mar": "40.7",
65 "underlying_annualized_volatility": "19.5",
66 "bots": [
67 {
68 "name": "Monday 0 DTE PCS 9:31am Traditional",
69 "number": "5CCOULKAM",
70 "total_trades": 4,
71 "winning_trades": 4,
72 "losing_trades": 0,
73 "win_percent": "100.00",
74 "average_entry_price": "2.89",
75 "average_exit_price": "0.05",
76 "average_profit_price": "2.84",
77 "average_gain": "1126.96",
78 "average_win": "1126.96",
79 "average_loss": "0.00",
80 "premium_collected": "4620.00",
81 "premium_retained": "4507.84",
82 "premium_retained_percent": "97.57",
83 "total_profit": "4507.84"
84 },
85 {
86 "name": "XSP 30 Quantity Test CCS",
87 "number": "0WSQIFNJOP",
88 "total_trades": 7,
89 "winning_trades": 6,
90 "losing_trades": 1,
91 "win_percent": "85.71",
92 "average_entry_price": "0.25",
93 "average_exit_price": "0.14",
94 "average_profit_price": "0.11",
95 "average_gain": "399.95",
96 "average_win": "962.02",
97 "average_loss": "-2972.48",
98 "premium_collected": "7770.00",
99 "premium_retained": "2799.66",
100 "premium_retained_percent": "36.03",
101 "total_profit": "2799.66"
102 },
103 {
104 "name": "XSP 30 Quantity Test PCS",
105 "number": "ADALFVNIZO",
106 "total_trades": 7,
107 "winning_trades": 4,
108 "losing_trades": 3,
109 "win_percent": "57.14",
110 "average_entry_price": "0.23",
111 "average_exit_price": "0.34",
112 "average_profit_price": "-0.11",
113 "average_gain": "-619.00",
114 "average_win": "954.46",
115 "average_loss": "-2716.94",
116 "premium_collected": "7026.22",
117 "premium_retained": "-4332.97",
118 "premium_retained_percent": "-61.67",
119 "total_profit": "-4332.97"
120 },
121 ],
122 "years": {
123 "2023": {
124 "months": {
125 "October": {
126 "date": "2023-10-01",
127 "starting_net_liquidation_value": "578123.25",
128 "ending_net_liquidation_value": "581281.25",
129 "total_trades": 18,
130 "winning_trades": 14,
131 "losing_trades": 4,
132 "win_percent": "77.78",
133 "broker_fees": "48.79",
134 "total_return_dollars": "2974.53",
135 "total_return_percent": "0.51",
136 "max_drawdown_dollars": "-1736.06",
137 "max_drawdown_percent": "-2.99",
138 "underlying_total_return_percent": "0.31",
139 "underlying_max_drawdown_percent": "-1.43"
140 }
141 },
142 "date": "2023-10-04",
143 "starting_net_liquidation_value": "578123.25",
144 "ending_net_liquidation_value": "581281.25",
145 "total_trades": 18,
146 "winning_trades": 14,
147 "losing_trades": 4,
148 "win_percent": "77.78",
149 "broker_fees": "48.79",
150 "total_return_dollars": "2974.53",
151 "total_return_percent": "0.51",
152 "max_drawdown_dollars": "-1736.06",
153 "max_drawdown_percent": "-2.99",
154 "underlying_total_return_percent": "0.31",
155 "underlying_max_drawdown_percent": "-1.43"
156 }
157 },
158 "days": [
159 {
160 "date": "2023-10-04",
161 "profit": "1051.36",
162 "day_return_percent": "1.1035",
163 "total_return_percent": "0.51",
164 "current_drawdown_dollars": "0.00",
165 "current_drawdown_percent": "0.00",
166 "underlying_day_return_percent": "0.8100",
167 "underlying_total_return_percent": "0.31",
168 "underlying_current_drawdown_days": 1,
169 "underlying_current_drawdown_percent": "-1.43"
170 }
171 ]
172 }
173 }
174}
Change a bot report name or date range
Auth Required: Write Reports
PUT
Request
Path Params
number
String
required
Report number to update
Header Parameters
API Token
String
required
Token from your Whispertrades account
Body Parameters
name
String
optional
New name for the report
start_date
String
optional
New start date for the report. Expected format is YYYY-MM-DD
end_date
String
optional
New end date for the report. Expected format is YYYY-MM-DD
run_until_latest_date
Boolean
optional
New flag to indicate whether or not the report should run to the current date when refreshing. Expected values are "true" or "false"
Curl
Node.js
JS
Python
1curl --location -g --request PUT 'https://api.whispertrades.com/v1/bots/reports/{number}' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json' \
4--header 'Authorization: Bearer <API Token>' \
5--data-raw '{"name":"string","start_date":"string","end_date":"string","run_until_latest_date":"Boolean"}'
Responses
200
1{
2 "success": true,
3 "message": "Updated report",
4 "data": {
5 "number": "QV4JL2N2I4",
6 "name": "WTD IRA",
7 "status": "Draft",
8 "completed_at": null,
9 "start_date": "2023-10-03",
10 "end_date": "2022-10-06",
11 "run_until_latest_date": true,
12 "is_public": false,
13 "symbol": "SPXW",
14 "nlv_source": "Actual NLV",
15 "nlv_amount": null,
16 "bot_statuses": [
17 "Enabled",
18 ],
19 "brokers": [
20 {
21 "number": "NLIKALWOMN",
22 "account_number": "40501918",
23 "name": "IRA"
24 },
25 ],
26 "bots": [
27 {
28 "number": "FWODFNKAK2",
29 "name": "TSLA 5 Delta Naked Put"
30 },
31 {
32 "number": "AOQY5OMDEI",
33 "name": "0 DTE Put Spread"
34 }
35 ],
36 "bot_tags": [
37 "Report demo"
38 ],
39 "bot_position_tags": [],
40 "results": {
41 "bots": [],
42 "years": [],
43 "days": []
44 }
45 }
46}
Run/refresh a report using its current configuration. The API will only accept a run request once every 10 minutes per bot report.
Auth Required: Write Reports
PUT
Request
Path Params
number
String
required
Report number to run
Header Parameters
Authorization Token
String
required
Token from your Whispertrades account
Curl
Node.js
JS
Python
1curl --location -g --request PUT 'https://api.whispertrades.com/v1/bots/reports/{number}/run' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json' \
4--header 'Authorization: Bearer <API Token>'
Responses
200
1{
2 "success": true,
3 "message": "Running report"
4}
Updated 25 Jun 2024
Did this page help you?