Developers › API reference › Market data

GET /api/v1/as-of/{dataset}/{key}

A record as it was on a date (effective-dated history).

  • Scope market:read
  • operationId marketAsOf

The token needs the scope market: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/as-of/{dataset}/{key}

Path parameters

NameDescriptionExample
datasetThe data set (securities, accounts, issuers, prices…).securities
keyThe record's key (a symbol, an account code…).AAPL

Query parameters

NameRequiredDescription
dateyesYYYY-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/as-of/securities/AAPL?date=2026-09-30" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/as-of/securities/AAPL",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    params={
        "date": "2026-09-30"
    },
    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/as-of/securities/AAPL?date=2026-09-30", {
  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: AsOf. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields
FieldTypeDescription
datasetstringThe data set.
keystringThe record's natural key (e.g. a symbol or account code).
datestringA date (YYYY-MM-DD).
recordobjectThe record as it was on that date.
valid_fromdate or nullFirst date this version was valid.
valid_todate or nullLast date (null: still valid).
batch_idid (string) or nullThe id of the data batch that made it.

Example response

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

{
    "dataset": "securities",
    "key": "AAPL",
    "date": "2026-10-27",
    "record": [],
    "valid_from": "2026-10-01",
    "valid_to": null,
    "batch_id": "311"
}

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
404Not found, or not visible to you (the API never confirms what you may not see)not_found
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/as-of/securities/AAPL"
}

On the screens

The same thing in the app is explained in: