Developers › API reference › Data

GET /api/v1/start-of-day

The start-of-day chain of a business date.

  • Scope data:read
  • operationId dataSod

The token needs the scope data: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/start-of-day

Query parameters

NameRequiredDescription
datenoYYYY-MM-DD

Headers

HeaderRequiredValue
AuthorizationyesBearer <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/start-of-day" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/start-of-day",
    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/start-of-day", {
  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: StartOfDay. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields
FieldTypeDescription
business_datestringThe business date the data is for (YYYY-MM-DD).
statusstringpending, running, complete, failed or overridden.
stepsanyEach step (calendars, securities, accounts, positions, prices, corporate actions, data quality, pre-open compliance) with its status.
messagestringA message in plain words.
completed_atdate-time or nullWhen the chain completed.
override_reasonstringOverride reason.

Example response

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

{
    "business_date": "2026-10-27",
    "status": "complete",
    "steps": [
        {
            "step": "prices",
            "status": "complete"
        }
    ],
    "message": "",
    "completed_at": "2026-10-27T14:30:00Z",
    "override_reason": "text"
}

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.

StatusWhenProblem codes
200Success
400The request is malformedinvalid_request
401No token, or it is invalid or expiredinvalid_token
403The token lacks the scope, or the person or service account behind it lacks the privilege or account permissioninsufficient_scope forbidden ip_not_allowed
429Rate limited: wait for Retry-After secondsrate_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/start-of-day"
}

On the screens

The same thing in the app is explained in: