Server API¶
The py-beacon server is the local HTTP API that Beacon desktop talks to. This reference is generated from the server's OpenAPI specification, version 0.2.0.
Install it with the server extra:
For how to use it (signing in, jobs, live events and errors), read the server guide first. This reference lists every endpoint and shape.
Endpoints¶
| Group | Endpoints |
|---|---|
| General | 2 |
| Beacon | 8 |
| Coverage | 2 |
| Data | 11 |
| Data stores | 10 |
| Derivatives | 4 |
| Indices | 12 |
| Jobs | 3 |
| Optimise | 9 |
| Reports | 6 |
| Risk | 3 |
| Universes | 6 |
| Watchlists | 4 |
Errors¶
Every endpoint can answer with these statuses. The body is always an ErrorEnvelope.
| Status | Meaning |
|---|---|
| 400 | The request could not be read at all: a body that is not decodable, or headers that contradict it. |
| 401 | Missing or invalid bearer token. |
| 404 | Requested data does not exist. |
| 405 | The path exists but does not accept this method. |
| 422 | Request or rule failed validation. |
| 500 | Library error during processing. |
| 501 | Endpoint exists but is not implemented. |
| 503 | A required optional dependency is absent. |