Developers › API reference › Records
GET /api/v1/events
The hash-chained event log.
- Scope
events:read - operationId
recordsEvents
The token needs the scope events:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.
Paginated. Cursor pagination: limit (1 to 200, default 50); pass next_cursor as cursor until has_more is false. fields= returns only the named fields.
Request
GET /api/v1/events
Query parameters
| Name | Required | Description |
|---|---|---|
limit | no | Page size, 1 to 200 (default 50) |
cursor | no | The next_cursor of the previous page |
sort | no | "-id" (newest first, default) or "id" |
fields | no | Sparse fieldset: comma-separated field names |
category | no | Category |
action | no | Action |
user | no | User id |
from | no | ISO 8601 |
to | no | ISO 8601 |
Headers
| Header | Required | Value |
|---|---|---|
Authorization | yes | Bearer <token>: an OAuth access token (vat_…) or a personal access token (vpt_…). Get a token |
Examples
Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.
curl
curl "https://vestoris.com/api/v1/events?category=order&from=2026-10-27T00%3A00%3A00Z&limit=100" \
-H "Authorization: Bearer $VESTORIS_TOKEN"
Python (requests)
import os, requests
r = requests.get(
"https://vestoris.com/api/v1/events",
headers={
"Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
},
params={
"category": "order",
"from": "2026-10-27T00:00:00Z",
"limit": "100"
},
timeout=30,
)
r.raise_for_status() # errors are application/problem+json with a stable "code"
print(r.json())
JavaScript (fetch)
const res = await fetch("https://vestoris.com/api/v1/events?category=order&from=2026-10-27T00%3A00%3A00Z&limit=100", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
},
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);
Response
200 OK, application/json: a page of Event. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.
Response fields
| Field | Type | Description |
|---|---|---|
data | list of Event | The records of this page. |
data[].id | id (string) | The record's id (a string of digits). |
data[].at | date-time or null | When it happened. |
data[].user_id | id (string) or null | The user. |
data[].actor | string | Who did it, as shown in the log (a person, a service account or "system"). |
data[].category | string | The event's category (auth, order, compliance, data, workflow, admin, ai…). |
data[].action | string | What happened, e.g. order.created, rule.signed_off, auth.login. |
data[].entity_type | string or null | The kind of record the event is about. |
data[].entity_id | id (string) or null | The id of the record the event is about. |
data[].account_id | id (string) or null | The account's id. |
data[].outcome | string | "ok" or "denied". |
data[].details | object | Details of the event. |
data[].prev_hash | string | The previous event's hash (the chain). |
data[].hash | string | This event's hash (SHA-256 of the previous hash and the row). |
next_cursor | string or null | Pass as ?cursor= for the next page; null on the last page. |
has_more | boolean | True when another page follows. |
Example response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "1042",
"at": "2026-10-27T14:30:00Z",
"user_id": "7",
"actor": "Taylor Brooks",
"category": "order",
"action": "order.created",
"entity_type": "order",
"entity_id": "5301",
"account_id": "12",
"outcome": "ok",
"details": {
"symbol": "AAPL",
"quantity": "1800"
},
"prev_hash": "a03f…",
"hash": "b41e…"
}
],
"next_cursor": "eyJpZCI6NTI5OX0",
"has_more": true
}
Example values. Your values depend on your firm's data; prices, orders and fills are simulated.
Status codes and errors
Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.
| Status | When | Problem codes |
|---|---|---|
| 200 | Success | |
| 400 | The request is malformed | invalid_request |
| 401 | No token, or it is invalid or expired | invalid_token |
| 403 | The token lacks the scope, or the person or service account behind it lacks the privilege or account permission | insufficient_scope forbidden ip_not_allowed |
| 429 | Rate limited: wait for Retry-After seconds | rate_limited |
{
"type": "https://vestoris.com/developers/errors#validation_failed",
"title": "Validation failed",
"status": 422,
"detail": "Quantity must be greater than zero.",
"code": "validation_failed",
"instance": "/api/v1/events"
}
On the screens
The same thing in the app is explained in: