GET `/api/v1/blotter/views`

Saved blotter views (yours and the firm's).

Scope orders:read
operationId ordersViews

The token needs the scope orders:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

GET /api/v1/blotter/views

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/blotter/views" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/blotter/views",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    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/blotter/views", {
  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: BlotterViewList. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`data`	list of BlotterView	The records of this page or list.
`data[].id`	id (string)	The record's id (a string of digits).
`data[].name`	string	Name.
`data[].shared`	boolean	Whether everyone in the firm can use it.
`data[].mine`	boolean	Whether you made it.
`data[].my_default`	boolean	Whether it is your default view.
`data[].firm_default`	boolean	Whether it is the firm's default view.
`data[].config`	any	The view: columns, widths, formats, sort, grouping, default filters and colour rules.
`data[].notices`	list	Fields left out of the view, and why.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "id": "1042",
            "name": "Execution quality",
            "shared": false,
            "mine": true,
            "my_default": false,
            "firm_default": false,
            "config": {
                "columns": [
                    "created_at",
                    "symbol",
                    "side",
                    "quantity",
                    "state"
                ],
                "group_by": "symbol"
            },
            "notices": []
        }
    ]
}

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/blotter/views"
}

On the screens

The same thing in the app is explained in: