diff --git a/01 Cloud Platform/10 Live Trading/07 Results/10 Trades.php b/01 Cloud Platform/10 Live Trading/07 Results/10 Trades.php new file mode 100644 index 0000000000..d9cbe7b208 --- /dev/null +++ b/01 Cloud Platform/10 Live Trading/07 Results/10 Trades.php @@ -0,0 +1,4 @@ + \ No newline at end of file diff --git a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/00.json b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/00.json index 2a6d466175..9ce3bc9b91 100644 --- a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/00.json +++ b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/00.json @@ -12,6 +12,8 @@ "04" : "", "05" : "", "06" : "", - "07" : "" + "07" : "", + "08" : "", + "09" : "" } } diff --git a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/04 Orders/02 Request.html b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/04 Orders/02 Request.html index 1646898bac..ab8d5866ec 100644 --- a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/04 Orders/02 Request.html +++ b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/04 Orders/02 Request.html @@ -9,7 +9,7 @@
string
example: L-6e9d8a78f5af89d401f630585be90e43 string
example: L-6e9d8a78f5af89d401f630585be90e43 integer
required
example: 0
{
- "algorithmId": "L-6e9d8a78f5af89d401f630585be90e43",
+ "deployId": "L-6e9d8a78f5af89d401f630585be90e43",
"start": 0,
"end": 100,
"projectId": 23456789
diff --git a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/01 Introduction.html b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/01 Introduction.html
new file mode 100644
index 0000000000..027b5b6637
--- /dev/null
+++ b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/01 Introduction.html
@@ -0,0 +1,5 @@
+
+
+
+Download the orders of all the live deployments of a project as a CSV file.
+
diff --git a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/02 Description.html b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/02 Description.html
new file mode 100644
index 0000000000..0396cd8558
--- /dev/null
+++ b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/02 Description.html
@@ -0,0 +1,5 @@
+
+
+
+The CSV file has the same format as the file you get when you click on the live results page. The response contains at most 750 days of orders. If the date range is longer, the response contains the last 750 days of the range. To get older orders, call the endpoint again with an earlier end or call the /live/orders/read endpoint. The response can contain orders outside of the date range. To get an exact range, filter the rows by their Time value.
+
diff --git a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/03 Request.html b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/03 Request.html
new file mode 100644
index 0000000000..398e885560
--- /dev/null
+++ b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/08 Export Orders/03 Request.html
@@ -0,0 +1,32 @@
+
+
+Download the orders of a project for the date range provided. The /live/export/orders API accepts requests in the following format:
+
+ExportLiveOrdersRequest Model - Request to download the orders of the live deployments of a project. |
+|
|---|---|
| projectId | integer Id of the project from which to download the orders. |
+
| start | integer Start of the date range in Unix time (seconds). The default value is one hour before the first deployment of the project. |
+
| end | integer End of the date range in Unix time (seconds). The default value is the current time. |
+
| Example | +
+
+{
+ "projectId": 23456789,
+ "start": 1727222400,
+ "end": 1792022400
+}
+ |
+
+The /live/export/orders API provides a response in the following format:
+
text/csv - Orders of the live deployments of the project, sorted by time. |
+|
|---|---|
| content | string One row per order. The Time column is in UTC. |
+
| Example | +
++Deploy,Time,Symbol,Price,Quantity,Type,Status,Value,Tag +L-6e9d8a78f5af89d401f630585be90e43,2026-10-08T14:20:04.8005773Z,SPY,672.35,10,"Market","Filled",6723.5,""+ |
+
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash. |
+|
|---|---|
| www_authenticate | string Header |
+
+Download the closed trades of all the live deployments of a project as a CSV file. +
diff --git a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/09 Export Trades/02 Description.html b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/09 Export Trades/02 Description.html new file mode 100644 index 0000000000..5c6dab9f94 --- /dev/null +++ b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/09 Export Trades/02 Description.html @@ -0,0 +1,5 @@ + + +
+The CSV file contains the closed trades that the /live/trades/read endpoint returns for the project. The response contains the trades with an entry time at or after start.
+
+Download the closed trades of a project from the start time provided. The /live/export/trades API accepts requests in the following format:
+
ExportLiveTradesRequest Model - Request to download the closed trades of the live deployments of a project. |
+|
|---|---|
| projectId | integer Id of the project from which to download the closed trades. |
+
| start | integer Earliest entry time of the trades in Unix time (seconds). The default value is one hour before the first deployment of the project. |
+
| Example | +
+
+{
+ "projectId": 23456789,
+ "start": 1727222400
+}
+ |
+
+The /live/export/trades API provides a response in the following format:
+
text/csv - Closed trades of the live deployments of the project. |
+|
|---|---|
| content | string One row per closed trade. The Entry Time and Exit Time columns are in UTC. |
+
| Example | +
++Entry Time,Symbols,Exit Time,Direction,Entry Price,Exit Price,Quantity,P&L,Fees,MAE,MFE,Drawdown,IsWin,Order Ids +2026-10-09T14:17:04.8008663Z,"SPY",2026-10-09T18:06:03.8005312Z,Buy,670.08,672.61,10,25.3,2,-8.9,25.3,8.9,1," 276,308"+ |
+
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash. |
+|
|---|---|
| www_authenticate | string Header |
+
end or call the /live/orders/read endpoint. The response can contain orders outside of the date range. To get an exact range, filter the rows by their Time value."
+ requestBody:
+ description: Download the orders of a project for the date range provided.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ExportLiveOrdersRequest'
+ required: true
+ responses:
+ "200":
+ description: Orders of the live deployments of the project, sorted by time.
+ content:
+ text/csv:
+ schema:
+ type: string
+ description: "One row per order. The Time column is in UTC."
+ examples:
+ - "Deploy,Time,Symbol,Price,Quantity,Type,Status,Value,Tag\nL-6e9d8a78f5af89d401f630585be90e43,2026-10-08T14:20:04.8005773Z,SPY,672.35,10,\"Market\",\"Filled\",6723.5,\"\" "
+ "401":
+ $ref: '#/components/responses/UnauthorizedErrorResponse'
+ operationId: exportLiveAlgorithmOrders
+ /live/export/trades:
+ post:
+ tags:
+ - 01 Cloud Platform
+ - 99 API Reference
+ - 07 Live Management
+ - 02 Read Live Algorithm
+ - 09 Export Trades
+ summary: Download the closed trades of all the live deployments of a project as a CSV file.
+ description: "The CSV file contains the closed trades that the /live/trades/read endpoint returns for the project. The response contains the trades with an entry time at or after start."
+ requestBody:
+ description: Download the closed trades of a project from the start time provided.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ExportLiveTradesRequest'
+ required: true
+ responses:
+ "200":
+ description: Closed trades of the live deployments of the project.
+ content:
+ text/csv:
+ schema:
+ type: string
+ description: "One row per closed trade. The Entry Time and Exit Time columns are in UTC."
+ examples:
+ - "Entry Time,Symbols,Exit Time,Direction,Entry Price,Exit Price,Quantity,P&L,Fees,MAE,MFE,Drawdown,IsWin,Order Ids\n2026-10-09T14:17:04.8008663Z,\"SPY\",2026-10-09T18:06:03.8005312Z,Buy,670.08,672.61,10,25.3,2,-8.9,25.3,8.9,1,\"\t276,308\" "
+ "401":
+ $ref: '#/components/responses/UnauthorizedErrorResponse'
+ operationId: exportLiveAlgorithmTrades
/live/insights/read:
post:
tags:
@@ -6981,11 +7041,14 @@ components:
- projectId
type: object
properties:
- algorithmId:
+ deployId:
type: string
- description: Deploy Id (Algorithm Id) of the live running algorithm.
examples:
- L-6e9d8a78f5af89d401f630585be90e43
+ description: >-
+ Deploy Id of the live algorithm. When you provide it, the response contains the orders
+ of that deployment. When you omit it, the response contains the orders of every
+ deployment of the project.
start:
type: integer
examples:
@@ -7002,6 +7065,43 @@ components:
- 23456789
description: Id of the project from which to read the live algorithm.
description: Request to read orders from a live algorithm.
+ ExportLiveOrdersRequest:
+ required:
+ - projectId
+ type: object
+ properties:
+ projectId:
+ type: integer
+ examples:
+ - 23456789
+ description: Id of the project from which to download the orders.
+ start:
+ type: integer
+ examples:
+ - 1727222400
+ description: Start of the date range in Unix time (seconds). The default value is one hour before the first deployment of the project.
+ end:
+ type: integer
+ examples:
+ - 1792022400
+ description: End of the date range in Unix time (seconds). The default value is the current time.
+ description: Request to download the orders of the live deployments of a project.
+ ExportLiveTradesRequest:
+ required:
+ - projectId
+ type: object
+ properties:
+ projectId:
+ type: integer
+ examples:
+ - 23456789
+ description: Id of the project from which to download the closed trades.
+ start:
+ type: integer
+ examples:
+ - 1727222400
+ description: Earliest entry time of the trades in Unix time (seconds). The default value is one hour before the first deployment of the project.
+ description: Request to download the closed trades of the live deployments of a project.
ReadLiveTradesRequest:
required:
- start
diff --git a/Resources/algorithm-results/orders.php b/Resources/algorithm-results/orders.php
index 038e3fc6e6..b95ff15647 100644
--- a/Resources/algorithm-results/orders.php
+++ b/Resources/algorithm-results/orders.php
@@ -15,7 +15,7 @@
The timestamps in the Order Summary table are based in Eastern Time (ET).
To view the orders data in CSV format, open the =$pageName?> results page, click the Orders tab, and then click . The content of the CSV file is the content displayed in the Orders Summary table when the table rows are collapsed. The timestamps in the CSV file are based in Coordinated Universal Time (UTC). if ($pageName == "live") { ?>The CSV file only contains the orders from the last 750 days. To get older orders, call the ReadLiveOrdersread_live_orders method or the /live/orders/read endpoint. } ?> if ($localPlatform) { ?>If you download the order summary CSV for a local backtest, the file is stored in <organizationWorkspace> / <projectName> / backtests / <unixTimestamp> / orders.csv. } ?>
+To view the orders data in CSV format, open the =$pageName?> results page, click the Orders tab, and then click . The content of the CSV file is the content displayed in the Orders Summary table when the table rows are collapsed. The timestamps in the CSV file are based in Coordinated Universal Time (UTC). if ($pageName == "live") { ?>To download the CSV file with the API, call the /live/export/orders endpoint. The CSV file only contains the orders from the last 750 days. To get older orders, call the ReadLiveOrdersread_live_orders method or the /live/orders/read endpoint. } ?> if ($localPlatform) { ?>If you download the order summary CSV for a local backtest, the file is stored in <organizationWorkspace> / <projectName> / backtests / <unixTimestamp> / orders.csv. } ?>
if ($pageName == "backtest") { ?>The timestamps in the Trades Summary table are based in Eastern Time (ET).
To view the trades data in CSV format, open the =$pageName?> results page, click the Trades tab, and then click . The content of the CSV file is the content displayed in the Trades Summary table when the table rows are collapsed. The timestamps in the CSV file are based in Coordinated Universal Time (UTC). if ($localPlatform) { ?>If you download the trade summary CSV for a local backtest, the file is stored in <organizationWorkspace> / <projectName> / backtests / <unixTimestamp> / trades.csv. } ?>
+To view the trades data in CSV format, open the =$pageName?> results page, click the Trades tab, and then click . The content of the CSV file is the content displayed in the Trades Summary table when the table rows are collapsed. The timestamps in the CSV file are based in Coordinated Universal Time (UTC). if ($pageName == "live") { ?>To download the CSV file with the API, call the /live/export/trades endpoint. } ?> if ($localPlatform) { ?>If you download the trade summary CSV for a local backtest, the file is stored in <organizationWorkspace> / <projectName> / backtests / <unixTimestamp> / trades.csv. } ?>
if ($pageName == "backtest") { ?>text/csv - {wrapper["description"]} | \n'
+ "|
|---|---|
| content | string {schema["description"]} | \n'
+ "
| Example | \n\n'
+ f'\n{example}\n | \n