Bot Reports

{ "name" "get reports", "method" "get", "url" "https //api whispertrades com/v1/bots/reports", "description" "get a single bot report or a list of all reports\n\nauth required read reports", "tab" "examples", "examples" { "languages" \[ { "id" "1kiqbu w4ifnoux c3zqr", "language" "curl", "code" "curl location g request get 'https //api whispertrades com/v1/bots/reports/{number}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'authorization bearer \<api token>'", "customlabel" "" }, { "id" "1kznloh4xoqdnpjrqs8yj", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api whispertrades com/v1/bots/reports/{number}',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'authorization' 'bearer \<api token>'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "k60dx5qc3w6wiajzfmeck", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"authorization\\", \\"bearer \<api token>\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api whispertrades com/v1/bots/reports/{number}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "p0e iz5ilxvph2gswsjzy", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api whispertrades com/v1/bots/reports/{number}\\"\n\nquery = {\n 'number' 'string'\n}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'authorization' 'bearer \<api token>'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, params=query)\n\nprint(response text)\n", "customlabel" "" } ], "selectedlanguageid" "1kiqbu w4ifnoux c3zqr" }, "results" { "languages" \[ { "id" "shee34nzxsu8ze vdajd9", "language" "200", "customlabel" "", "code" "{\n \\"success\\" true,\n \\"message\\" \\"\\",\n \\"data\\" {\n \\"number\\" \\"yon0kajssm\\",\n \\"name\\" \\"all bots mtd\\",\n \\"status\\" \\"complete\\",\n \\"completed at\\" \\"2023 10 04t20 59 41 000000z\\",\n \\"start date\\" \\"2023 10 01\\",\n \\"end date\\" \\"2023 10 04\\",\n \\"run until latest date\\" true,\n \\"is public\\" false,\n \\"symbol\\" \\"spxw\\",\n \\"nlv source\\" \\"actual nlv\\",\n \\"nlv amount\\" null,\n \\"bot statuses\\" \[],\n \\"brokers\\" \[\n {\n \\"number\\" \\"1z4xybhx34\\",\n \\"account number\\" \\"194029194\\",\n \\"name\\" \\"personal\\"\n },\n {\n \\"number\\" \\"hdjakwifqz\\",\n \\"account number\\" \\"940195901\\",\n \\"name\\" \\"roth ira\\"\n }\n ],\n \\"bots\\" \[],\n \\"bot tags\\" \[],\n \\"bot position tags\\" \[],\n \\"results\\" {\n \\"total trades\\" 18,\n \\"winning trades\\" 14,\n \\"losing trades\\" 4,\n \\"win percent\\" \\"77 78\\",\n \\"starting net liquidation value\\" \\"578123 25\\",\n \\"ending net liquidation value\\" \\"581281 25\\",\n \\"average gain\\" 485,\n \\"average win\\" 848,\n \\"average loss\\" 750,\n \\"broker fees\\" \\"48 79\\",\n \\"premium collected\\" \\"19416 22\\",\n \\"premium retained\\" \\"2974 53\\",\n \\"premium retained percent\\" \\"15 32\\",\n \\"total return dollars\\" \\"2974 53\\",\n \\"total return percent\\" \\"0 51\\",\n \\"max drawdown dollars\\" \\" 1736 06\\",\n \\"max drawdown percent\\" \\" 2 99\\",\n \\"max drawdown days\\" 1,\n \\"cagr\\" \\"61 60\\",\n \\"sharpe\\" \\"2 00\\",\n \\"sortino\\" \\"1 41\\",\n \\"mar\\" \\"20 6\\",\n \\"annualized volatility\\" \\"23 4\\",\n \\"correlation\\" \\"0 26\\",\n \\"beta\\" \\"0 31\\",\n \\"underlying total return percent\\" \\"0 31\\",\n \\"underlying max drawdown percent\\" \\" 1 43\\",\n \\"underlying max drawdown days\\" 2,\n \\"underlying cagr\\" \\"58 3\\",\n \\"underlying sharpe\\" \\"1 58\\",\n \\"underlying sortino\\" \\"1 72\\",\n \\"underlying mar\\" \\"40 7\\",\n \\"underlying annualized volatility\\" \\"19 5\\",\n \\"bots\\" \[\n {\n \\"name\\" \\"monday 0 dte pcs 9 31am traditional\\",\n \\"number\\" \\"5ccoulkam\\",\n \\"total trades\\" 4,\n \\"winning trades\\" 4,\n \\"losing trades\\" 0,\n \\"win percent\\" \\"100 00\\",\n \\"average entry price\\" \\"2 89\\",\n \\"average exit price\\" \\"0 05\\",\n \\"average profit price\\" \\"2 84\\",\n \\"average gain\\" \\"1126 96\\",\n \\"average win\\" \\"1126 96\\",\n \\"average loss\\" \\"0 00\\",\n \\"premium collected\\" \\"4620 00\\",\n \\"premium retained\\" \\"4507 84\\",\n \\"premium retained percent\\" \\"97 57\\",\n \\"total profit\\" \\"4507 84\\"\n },\n {\n \\"name\\" \\"xsp 30 quantity test ccs\\",\n \\"number\\" \\"0wsqifnjop\\",\n \\"total trades\\" 7,\n \\"winning trades\\" 6,\n \\"losing trades\\" 1,\n \\"win percent\\" \\"85 71\\",\n \\"average entry price\\" \\"0 25\\",\n \\"average exit price\\" \\"0 14\\",\n \\"average profit price\\" \\"0 11\\",\n \\"average gain\\" \\"399 95\\",\n \\"average win\\" \\"962 02\\",\n \\"average loss\\" \\" 2972 48\\",\n \\"premium collected\\" \\"7770 00\\",\n \\"premium retained\\" \\"2799 66\\",\n \\"premium retained percent\\" \\"36 03\\",\n \\"total profit\\" \\"2799 66\\"\n },\n {\n \\"name\\" \\"xsp 30 quantity test pcs\\",\n \\"number\\" \\"adalfvnizo\\",\n \\"total trades\\" 7,\n \\"winning trades\\" 4,\n \\"losing trades\\" 3,\n \\"win percent\\" \\"57 14\\",\n \\"average entry price\\" \\"0 23\\",\n \\"average exit price\\" \\"0 34\\",\n \\"average profit price\\" \\" 0 11\\",\n \\"average gain\\" \\" 619 00\\",\n \\"average win\\" \\"954 46\\",\n \\"average loss\\" \\" 2716 94\\",\n \\"premium collected\\" \\"7026 22\\",\n \\"premium retained\\" \\" 4332 97\\",\n \\"premium retained percent\\" \\" 61 67\\",\n \\"total profit\\" \\" 4332 97\\"\n },\n ],\n \\"years\\" {\n \\"2023\\" {\n \\"months\\" {\n \\"october\\" {\n \\"date\\" \\"2023 10 01\\",\n \\"starting net liquidation value\\" \\"578123 25\\",\n \\"ending net liquidation value\\" \\"581281 25\\",\n \\"total trades\\" 18,\n \\"winning trades\\" 14,\n \\"losing trades\\" 4,\n \\"win percent\\" \\"77 78\\",\n \\"broker fees\\" \\"48 79\\",\n \\"total return dollars\\" \\"2974 53\\",\n \\"total return percent\\" \\"0 51\\",\n \\"max drawdown dollars\\" \\" 1736 06\\",\n \\"max drawdown percent\\" \\" 2 99\\",\n \\"underlying total return percent\\" \\"0 31\\",\n \\"underlying max drawdown percent\\" \\" 1 43\\"\n }\n },\n \\"date\\" \\"2023 10 04\\",\n \\"starting net liquidation value\\" \\"578123 25\\",\n \\"ending net liquidation value\\" \\"581281 25\\",\n \\"total trades\\" 18,\n \\"winning trades\\" 14,\n \\"losing trades\\" 4,\n \\"win percent\\" \\"77 78\\",\n \\"broker fees\\" \\"48 79\\",\n \\"total return dollars\\" \\"2974 53\\",\n \\"total return percent\\" \\"0 51\\",\n \\"max drawdown dollars\\" \\" 1736 06\\",\n \\"max drawdown percent\\" \\" 2 99\\",\n \\"underlying total return percent\\" \\"0 31\\",\n \\"underlying max drawdown percent\\" \\" 1 43\\"\n }\n },\n \\"days\\" \[\n {\n \\"date\\" \\"2023 10 04\\",\n \\"profit\\" \\"1051 36\\",\n \\"day return percent\\" \\"1 1035\\",\n \\"total return percent\\" \\"0 51\\",\n \\"current drawdown dollars\\" \\"0 00\\",\n \\"current drawdown percent\\" \\"0 00\\",\n \\"underlying day return percent\\" \\"0 8100\\",\n \\"underlying total return percent\\" \\"0 31\\",\n \\"underlying current drawdown days\\" 1,\n \\"underlying current drawdown percent\\" \\" 1 43\\"\n }\n ]\n }\n }\n}" } ], "selectedlanguageid" "shee34nzxsu8ze vdajd9" }, "request" { "pathparameters" \[ { "name" "number", "kind" "optional", "type" "string", "description" "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 ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "api token", "kind" "required", "type" "string", "description" "token from your whispertrades account", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "name" "update report", "method" "put", "url" "https //api whispertrades com/v1/bots/reports", "description" "change a bot report name or date range\n\nauth required write reports", "tab" "examples", "examples" { "languages" \[ { "id" "zx3kouwuq6lr zwnzluxr", "language" "curl", "code" "curl location g request put 'https //api whispertrades com/v1/bots/reports/{number}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'authorization bearer \<api token>' \\\\\n data raw '{\\"name\\" \\"string\\",\\"start date\\" \\"string\\",\\"end date\\" \\"string\\",\\"run until latest date\\" \\"boolean\\"}'", "customlabel" "" }, { "id" "2wrc6vul3pxwqttfytwfg", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'put',\n 'url' 'https //api whispertrades com/v1/bots/reports/{number}',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'authorization' 'bearer \<api token>'\n },\n body json stringify({\n \\"name\\" \\"string\\",\n \\"start date\\" \\"string\\",\n \\"end date\\" \\"string\\",\n \\"run until latest date\\" \\"boolean\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "f96r1qdgpekah7enulp2x", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"authorization\\", \\"bearer \<api token>\\");\n\nvar raw = json stringify({\n \\"name\\" \\"string\\",\n \\"start date\\" \\"string\\",\n \\"end date\\" \\"string\\",\n \\"run until latest date\\" \\"boolean\\"\n});\n\nvar requestoptions = {\n method 'put',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api whispertrades com/v1/bots/reports/{number}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "8zcacranhqlxs30r3t032", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api whispertrades com/v1/bots/reports/{number}\\"\n\npayload = json dumps({\n \\"name\\" \\"string\\",\n \\"start date\\" \\"string\\",\n \\"end date\\" \\"string\\",\n \\"run until latest date\\" \\"boolean\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'authorization' 'bearer \<api token>'\n}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" } ], "selectedlanguageid" "zx3kouwuq6lr zwnzluxr" }, "results" { "languages" \[ { "id" "rfbqevwo1yfg8gcseaox4", "language" "200", "customlabel" "", "code" "{\n \\"success\\" true,\n \\"message\\" \\"updated report\\",\n \\"data\\" {\n \\"number\\" \\"qv4jl2n2i4\\",\n \\"name\\" \\"wtd ira\\",\n \\"status\\" \\"draft\\",\n \\"completed at\\" null,\n \\"start date\\" \\"2023 10 03\\",\n \\"end date\\" \\"2022 10 06\\",\n \\"run until latest date\\" true,\n \\"is public\\" false,\n \\"symbol\\" \\"spxw\\",\n \\"nlv source\\" \\"actual nlv\\",\n \\"nlv amount\\" null,\n \\"bot statuses\\" \[\n \\"enabled\\",\n ],\n \\"brokers\\" \[\n {\n \\"number\\" \\"nlikalwomn\\",\n \\"account number\\" \\"40501918\\",\n \\"name\\" \\"ira\\"\n },\n ],\n \\"bots\\" \[\n {\n \\"number\\" \\"fwodfnkak2\\",\n \\"name\\" \\"tsla 5 delta naked put\\"\n },\n {\n \\"number\\" \\"aoqy5omdei\\",\n \\"name\\" \\"0 dte put spread\\"\n }\n ],\n \\"bot tags\\" \[\n \\"report demo\\"\n ],\n \\"bot position tags\\" \[],\n \\"results\\" {\n \\"bots\\" \[],\n \\"years\\" \[],\n \\"days\\" \[]\n }\n }\n}" } ], "selectedlanguageid" "rfbqevwo1yfg8gcseaox4" }, "request" { "pathparameters" \[ { "name" "number", "kind" "required", "type" "string", "description" "report number to update", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "api token", "kind" "required", "type" "string", "description" "token from your whispertrades account", "children" \[] } ], "bodydataparameters" \[ { "name" "name", "kind" "optional", "type" "string", "description" "new name for the report", "children" \[] }, { "name" "start date", "kind" "optional", "type" "string", "description" "new start date for the report expected format is yyyy mm dd", "children" \[] }, { "name" "end date", "kind" "optional", "type" "string", "description" "new end date for the report expected format is yyyy mm dd", "children" \[] }, { "name" "run until latest date", "kind" "optional", "type" "boolean", "description" "new flag to indicate whether or not the report should run to the current date when refreshing expected values are \\"true\\" or \\"false\\"", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "name" "run report", "method" "put", "url" "https //api whispertrades com/v1/bots/reports/{number}/run", "description" "run/refresh a report using its current configuration the api will only accept a run request once every 10 minutes per bot report \n\nauth required write reports", "tab" "examples", "examples" { "languages" \[ { "id" "hbdvzivajv1vkvf4htgf2", "language" "curl", "code" "curl location g request put 'https //api whispertrades com/v1/bots/reports/{number}/run' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n header 'authorization bearer \<api token>'", "customlabel" "" }, { "id" "bz8u7pj1o7cqzcckfbs76", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'put',\n 'url' 'https //api whispertrades com/v1/bots/reports/{number}/run',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'authorization' 'bearer \<api token>'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "j7tleq3p5olwydfm 8i72", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\nmyheaders append(\\"authorization\\", \\"bearer \<api token>\\");\n\nvar requestoptions = {\n method 'put',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api whispertrades com/v1/bots/reports/{number}/run\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "gc7argst9z4xkudu6zofa", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api whispertrades com/v1/bots/reports/{number}/run\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json',\n 'authorization' 'bearer \<api token>'\n}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" } ], "selectedlanguageid" "hbdvzivajv1vkvf4htgf2" }, "results" { "languages" \[ { "id" "yu5rlyush25upne6dbf0o", "language" "200", "customlabel" "", "code" "{\n \\"success\\" true,\n \\"message\\" \\"running report\\"\n}" } ], "selectedlanguageid" "yu5rlyush25upne6dbf0o" }, "request" { "pathparameters" \[ { "name" "number", "kind" "required", "type" "string", "description" "report number to run", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "authorization token", "kind" "required", "type" "string", "description" "token from your whispertrades account", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }