Skip to main content

Documentation for ScryLab v0.1.6

Changelogs

List Data Sources

GET /api/sources

Lists all data sources currently loaded in ScryLab.

Tip

Practical guide for using this in a workflow: Import Data from Python & MATLAB

Request

GET /api/sources HTTP/1.1
Host: localhost:5678

No parameters required.

Response

Status Code: 200 OK

Body:

{
"status": "ok",
"result": [
{
"source_id": "937896ff-f856-4b20-8888-e5127f0835b5",
"name": "My Data",
"file_path": "/home/user/data/my_data.mf4",
"file_type": "mf4",
"source_number": 1
}
]
}

Response Fields

FieldTypeDescription
resultarrayList of all data sources
result[].source_idstringData source ID (used as target_source_id)
result[].namestringName of the data source
result[].file_pathstringFile path of the source
result[].file_typestringFile format (e.g. "mf4", "DataSource")
result[].source_numberintegerData source number

Example

Terminal window
curl http://localhost:5678/api/sources

Errors

This endpoint always returns 200 OK, even when no data sources are loaded (result: []).