Developers › API reference › Orders

GET /api/v1/orders

Orders on the accounts you can see.

• Scope orders:read
• operationId ordersList

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/orders

Query parameters

Headers

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl "https://vestoris.com/api/v1/orders?limit=20&state=working%2Cpartially_filled&side=buy" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/orders",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    params={
        "limit": "20",
        "state": "working,partially_filled",
        "side": "buy"
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

const res = await fetch("https://vestoris.com/api/v1/orders?limit=20&state=working%2Cpartially_filled&side=buy", {
  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 OrderSummary. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Example response

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

{
    "data": [
        {
            "id": "5301",
            "symbol": "AAPL",
            "side": "buy",
            "order_type": "limit",
            "quantity": "1800",
            "filled_quantity": "900",
            "limit_price": "232.00",
            "avg_fill_price": "231.52",
            "state": "partially_filled",
            "compliance_state": "pass",
            "is_block": true,
            "algo": "vwap",
            "created_by": "9",
            "created_at": "2026-10-27T14:30:00Z"
        }
    ],
    "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.

{
    "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/orders"
}

On the screens

The same thing in the app is explained in:

• The dashboard
• Orders and the order list
• The trade blotter