API Reference/api/user/api/user/export

/api/user/export

Info

GET
See current or download available exports

Query

Field NameTypeDescription
namestringThe name of the export to get

200
Ok (JSON or application/zip)

If name is not provided, returns a JSON array with available exports that you can download.

Field NameTypeDescription
namestringThe name of the export
sizenumberThe size of the export in bytes
{
"exports": [
{
"name": "zipline_export_1_1669958089608.zip",
"size": 123456
},
...
]
}

If name is provided, returns a zip file with the export.

401
Forbidden (JSON)

  • cannot access export owned by another user - The export you are trying to access does not belong to you.

POST
Create an export

200
Ok (JSON)

This will return immediately, even if the export is not finished, so you must wait for the export to finish before downloading it.

Field NameTypeDescription
urlstringThe url to download the export
{
"url": "/api/user/export?name=zipline_export_1_1669958089608.zip"
}

404
Not Found (JSON)

  • no files found - No files were found to export.
Last updated: 8/5/2023
Edit this page on GitHub