Fixes brokerage for API Reference

QuantConnect · Apr 26, 2024 · 4fd605e · 4fd605e
1 parent 8d23d64
commit 4fd605e
Show file tree

Hide file tree

Showing 8 changed files with 1,224 additions and 132 deletions.
diff --git a/...oud Platform/99 API Reference/05 Backtest Management/01 Create Backtest/03 Responses.html b/...oud Platform/99 API Reference/05 Backtest Management/01 Create Backtest/03 Responses.html
@@ -141,9 +141,9 @@ <h4>200 Success</h4>
         "ClosedTrades": [
           {
             "Symbol": {
-              "Value": "string",
-              "ID": "string",
-              "Permtick": "string"
+              "value": "string",
+              "id": "string",
+              "permtick": "string"
             },
             "EntryTime": "2021-11-26T15:18:27.693Z",
             "EntryPrice": 0,
@@ -281,9 +281,9 @@ <h4>200 Success</h4>
         "ClosedTrades": [
           {
             "Symbol": {
-              "Value": "string",
-              "ID": "string",
-              "Permtick": "string"
+              "value": "string",
+              "id": "string",
+              "permtick": "string"
             },
             "EntryTime": "2021-11-26T15:18:27.693Z",
             "EntryPrice": 0,
@@ -518,9 +518,9 @@ <h4>200 Success</h4>
     "ClosedTrades": [
       {
         "Symbol": {
-          "Value": "string",
-          "ID": "string",
-          "Permtick": "string"
+          "value": "string",
+          "id": "string",
+          "permtick": "string"
         },
         "EntryTime": "2021-11-26T15:18:27.693Z",
         "EntryPrice": 0,
@@ -658,9 +658,9 @@ <h4>200 Success</h4>
     "ClosedTrades": [
       {
         "Symbol": {
-          "Value": "string",
-          "ID": "string",
-          "Permtick": "string"
+          "value": "string",
+          "id": "string",
+          "permtick": "string"
         },
         "EntryTime": "2021-11-26T15:18:27.693Z",
         "EntryPrice": 0,
@@ -932,9 +932,9 @@ <h4>200 Success</h4>
   "ClosedTrades": [
     {
       "Symbol": {
-        "Value": "string",
-        "ID": "string",
-        "Permtick": "string"
+        "value": "string",
+        "id": "string",
+        "permtick": "string"
       },
       "EntryTime": "2021-11-26T15:18:27.693Z",
       "EntryPrice": 0,
@@ -1275,9 +1275,9 @@ <h4>200 Success</h4>
 <div class="cli section-example-container"><pre>
 {
   "Symbol": {
-    "Value": "string",
-    "ID": "string",
-    "Permtick": "string"
+    "value": "string",
+    "id": "string",
+    "permtick": "string"
   },
   "EntryTime": "2021-11-26T15:18:27.693Z",
   "EntryPrice": 0,
@@ -1302,22 +1302,22 @@ <h4>200 Success</h4>
 </tr>
 </thead>
 <tr>
-<td width="20%">Value</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
+<td width="20%">value</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
 </tr>
 <tr>
-<td width="20%">ID</td> <td> <code>string</code> <br/> The security identifier for this symbol.</td>
+<td width="20%">id</td> <td> <code>string</code> <br/> The security identifier for this symbol.</td>
 </tr>
 <tr>
-<td width="20%">Permtick</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
+<td width="20%">permtick</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
 </tr>
 <tr>
 <td width="20%">Example</td>
 <td>
 <div class="cli section-example-container"><pre>
 {
-  "Value": "string",
-  "ID": "string",
-  "Permtick": "string"
+  "value": "string",
+  "id": "string",
+  "permtick": "string"
 }</pre>
 </div>
 </td>

diff --git a/...m/99 API Reference/05 Backtest Management/02 Read Backtest/02 Portfolio/03 Responses.html b/...m/99 API Reference/05 Backtest Management/02 Read Backtest/02 Portfolio/03 Responses.html
@@ -21,9 +21,9 @@ <h4>200 Success</h4>
   "portfolio": {
     "Holdings": {
       "Symbol": {
-        "Value": "string",
-        "ID": "string",
-        "Permtick": "string"
+        "value": "string",
+        "id": "string",
+        "permtick": "string"
       },
       "Type": "Base",
       "CurrencySymbol": "$",
@@ -65,9 +65,9 @@ <h4>200 Success</h4>
 {
   "Holdings": {
     "Symbol": {
-      "Value": "string",
-      "ID": "string",
-      "Permtick": "string"
+      "value": "string",
+      "id": "string",
+      "permtick": "string"
     },
     "Type": "Base",
     "CurrencySymbol": "$",
@@ -128,9 +128,9 @@ <h4>200 Success</h4>
 <div class="cli section-example-container"><pre>
 {
   "Symbol": {
-    "Value": "string",
-    "ID": "string",
-    "Permtick": "string"
+    "value": "string",
+    "id": "string",
+    "permtick": "string"
   },
   "Type": "Base",
   "CurrencySymbol": "$",
@@ -151,22 +151,22 @@ <h4>200 Success</h4>
 </tr>
 </thead>
 <tr>
-<td width="20%">Value</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
+<td width="20%">value</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
 </tr>
 <tr>
-<td width="20%">ID</td> <td> <code>string</code> <br/> The security identifier for this symbol.</td>
+<td width="20%">id</td> <td> <code>string</code> <br/> The security identifier for this symbol.</td>
 </tr>
 <tr>
-<td width="20%">Permtick</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
+<td width="20%">permtick</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
 </tr>
 <tr>
 <td width="20%">Example</td>
 <td>
 <div class="cli section-example-container"><pre>
 {
-  "Value": "string",
-  "ID": "string",
-  "Permtick": "string"
+  "value": "string",
+  "id": "string",
+  "permtick": "string"
 }</pre>
 </div>
 </td>

diff --git a/...form/99 API Reference/05 Backtest Management/02 Read Backtest/03 Orders/03 Responses.html b/...form/99 API Reference/05 Backtest Management/02 Read Backtest/03 Orders/03 Responses.html
@@ -28,9 +28,9 @@ <h4>200 Success</h4>
       "string"
     ],
     "symbol": {
-      "Value": "string",
-      "ID": "string",
-      "Permtick": "string"
+      "value": "string",
+      "id": "string",
+      "permtick": "string"
     },
     "limitPrice": ,
     "stopPrice": 0,
@@ -50,9 +50,9 @@ <h4>200 Success</h4>
     "direction": 0 = Buy,
     "value": 0,
     "orderSubmissionData": {
-      "BidPrice": 0,
-      "AskPrice": 0,
-      "LastPrice": 0
+      "bidPrice": 0,
+      "askPrice": 0,
+      "lastPrice": 0
     },
     "isMarketable": true,
     "properties": {
@@ -67,9 +67,9 @@ <h4>200 Success</h4>
         "orderEventId": 0,
         "id": 0,
         "symbol": {
-          "Value": "string",
-          "ID": "string",
-          "Permtick": "string"
+          "value": "string",
+          "id": "string",
+          "permtick": "string"
         },
         "status": "new",
         "orderFeeAmount": 0,
@@ -214,9 +214,9 @@ <h4>200 Success</h4>
     "string"
   ],
   "symbol": {
-    "Value": "string",
-    "ID": "string",
-    "Permtick": "string"
+    "value": "string",
+    "id": "string",
+    "permtick": "string"
   },
   "limitPrice": ,
   "stopPrice": 0,
@@ -236,9 +236,9 @@ <h4>200 Success</h4>
   "direction": 0 = Buy,
   "value": 0,
   "orderSubmissionData": {
-    "BidPrice": 0,
-    "AskPrice": 0,
-    "LastPrice": 0
+    "bidPrice": 0,
+    "askPrice": 0,
+    "lastPrice": 0
   },
   "isMarketable": true,
   "properties": {
@@ -253,9 +253,9 @@ <h4>200 Success</h4>
       "orderEventId": 0,
       "id": 0,
       "symbol": {
-        "Value": "string",
-        "ID": "string",
-        "Permtick": "string"
+        "value": "string",
+        "id": "string",
+        "permtick": "string"
       },
       "status": "new",
       "orderFeeAmount": 0,
@@ -298,22 +298,22 @@ <h4>200 Success</h4>
 </tr>
 </thead>
 <tr>
-<td width="20%">Value</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
+<td width="20%">value</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
 </tr>
 <tr>
-<td width="20%">ID</td> <td> <code>string</code> <br/> The security identifier for this symbol.</td>
+<td width="20%">id</td> <td> <code>string</code> <br/> The security identifier for this symbol.</td>
 </tr>
 <tr>
-<td width="20%">Permtick</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
+<td width="20%">permtick</td> <td> <code>string</code> <br/> The current symbol for this ticker.</td>
 </tr>
 <tr>
 <td width="20%">Example</td>
 <td>
 <div class="cli section-example-container"><pre>
 {
-  "Value": "string",
-  "ID": "string",
-  "Permtick": "string"
+  "value": "string",
+  "id": "string",
+  "permtick": "string"
 }</pre>
 </div>
 </td>
@@ -325,22 +325,22 @@ <h4>200 Success</h4>
 </tr>
 </thead>
 <tr>
-<td width="20%">BidPrice</td> <td> <code>number</code> <br/> The bid price at an order submission time.</td>
+<td width="20%">bidPrice</td> <td> <code>number</code> <br/> The bid price at an order submission time.</td>
 </tr>
 <tr>
-<td width="20%">AskPrice</td> <td> <code>number</code> <br/> The ask price at an order submission time.</td>
+<td width="20%">askPrice</td> <td> <code>number</code> <br/> The ask price at an order submission time.</td>
 </tr>
 <tr>
-<td width="20%">LastPrice</td> <td> <code>number</code> <br/> The current price at an order submission time.</td>
+<td width="20%">lastPrice</td> <td> <code>number</code> <br/> The current price at an order submission time.</td>
 </tr>
 <tr>
 <td width="20%">Example</td>
 <td>
 <div class="cli section-example-container"><pre>
 {
-  "BidPrice": 0,
-  "AskPrice": 0,
-  "LastPrice": 0
+  "bidPrice": 0,
+  "askPrice": 0,
+  "lastPrice": 0
 }</pre>
 </div>
 </td>
@@ -445,9 +445,9 @@ <h4>200 Success</h4>
   "orderEventId": 0,
   "id": 0,
   "symbol": {
-    "Value": "string",
-    "ID": "string",
-    "Permtick": "string"
+    "value": "string",
+    "id": "string",
+    "permtick": "string"
   },
   "status": "new",
   "orderFeeAmount": 0,