API Reference

API Reference

This page attempts to document the entire Zipline API, currently it is a work in progress.

API documentation for Zipline is outdated and incomplete. Unfortunately, the more reasonable way to get the most up-to-date information is to look at the source code. If you are having trouble or need help with the API, feel free to ask in the Discord.

Errors

All errors are returned in the following format:

Field NameTypeDescription
errorstringThe error message
codestringThe error code, an HTTP status code

There may be additional fields, these are not documented here, but are documented in the specific endpoint.

{
"error": "error message",
"code": 400
}

Authentication

Most endpoints require authentication, this is done by providing an Authorization header with the value being your users auth token OR having a cookie named user being set, with the value being a signed string. For more information about how it's signed see the source.

Last updated: 9/1/2024
Edit this page on GitHub