You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api.md
+36Lines changed: 36 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,6 +52,27 @@ This document outlines the RESTful API endpoints provided by the `stochastix-cor
52
52
---
53
53
### Market Data
54
54
55
+
* **`GET /api/data/exchanges`**
56
+
* **Description:** Retrieves a sorted list of all exchange IDs supported by the backend (via the CCXT library).
57
+
* **Requires:** None
58
+
* **Request Body:** None
59
+
* **Success Response:** `200 OK`
60
+
* **Example Success Response Body:**
61
+
```json
62
+
[
63
+
"ace",
64
+
"alpaca",
65
+
"ascendex",
66
+
"bequant",
67
+
"bigone",
68
+
"binance",
69
+
"binancecoinm",
70
+
"binanceus",
71
+
"binanceusdm",
72
+
"bingx"
73
+
]
74
+
```
75
+
55
76
* **`GET /api/data-availability`**
56
77
* **Description:** Scans the server for available market data (`.stchx` files) and returns a manifest detailing available symbols, their timeframes, and the start/end dates for each dataset.
57
78
* **Requires:** None
@@ -114,6 +135,21 @@ This document outlines the RESTful API endpoints provided by the `stochastix-cor
114
135
* `400 Bad Request`: Invalid input (e.g., validation errors in the request body, end date before start date).
115
136
* `500 Internal Server Error`: If the download message could not be dispatched to the queue.
116
137
138
+
* **`DELETE /api/data/download/{jobId}`**
139
+
* **Description:** Requests the cancellation of a running download job. The cancellation may take a few moments to take effect, as it is checked between data chunk fetches.
140
+
* **Requires:** None
141
+
* **URL Parameters:**
142
+
* `jobId` (string, required): The unique ID of the download job to cancel.
* **Description:** Inspects a specific market data file (`.stchx`). Returns the file's header metadata, a sample of the first and last records, and a full data consistency validation report (checking for gaps, duplicates, and out-of-order records).
0 commit comments