GET `/api/v1/batches/{id}/rows`

A batch's rows: the diff and the rejected rows with codes.

Scope data:read
operationId dataRows

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/batches/{id}/rows

Path parameters

Name	Description	Example
`id`	The id of the batche.	`311`

Query parameters

Name	Required	Description
`status`	no	new, changed, unchanged, rejected
`limit`	no	1-500
`offset`	no	Offset

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/batches/311/rows" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/batches/311/rows",
    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/batches/311/rows", {
  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: BatchRows. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`batch`	Batch	The batch the file became.
`batch.id`	id (string)	The record's id (a string of digits).
`batch.dataset`	string	The data set: securities, accounts, positions, lots, cash, prices, fx, corporate_actions, issuers, brokers, benchmarks…
`batch.status`	string	staged, held, applied, undone, rejected or discarded.
`batch.source`	string	upload, feed, api, bundle or ai_suggestion.
`batch.mode`	string	"upsert" (default) or "full" (records missing from the file are inactivated).
`batch.file_name`	string	The file's name.
`batch.sha256`	string	SHA-256 of the file.
`batch.business_date`	date or null	The business date the data is for (YYYY-MM-DD).
`batch.counts`	object	Rows by outcome: new, changed, unchanged, rejected, deleted.
`batch.message`	string	A message in plain words.
`batch.hold_reason`	string or null	Why the batch is held for review.
`batch.created_at`	date-time or null	When it was created.
`batch.applied_at`	date-time or null	When it was applied.
`batch.undone_at`	date-time or null	When it was undone.
`data`	list of BatchRow	The records of this page or list.
`data[].row`	integer	Row number in the file.
`data[].status`	string	new, changed, unchanged or rejected.
`data[].key`	string	The record's natural key (e.g. a symbol or account code).
`data[].data`	object	The row as read from the file.
`data[].diff`	object	For a changed row: each field with its old and new value.
`data[].errors`	list	Rejection codes and messages of the row.
`next_offset`	integer or null	The offset of the next page of rows (null: last page).
`has_more`	boolean	True when another page follows.

Example response

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

{
    "batch": {
        "id": "1042",
        "dataset": "prices",
        "status": "staged",
        "source": "api",
        "mode": "upsert",
        "file_name": "ACME_PRICE_20261027_001.xml",
        "sha256": "e3b0…",
        "business_date": "2026-10-27",
        "counts": {
            "new": 3,
            "changed": 12,
            "unchanged": 580,
            "rejected": 1
        },
        "message": "",
        "hold_reason": null,
        "created_at": "2026-10-27T14:30:00Z",
        "applied_at": "2026-10-27T14:30:00Z",
        "undone_at": null
    },
    "data": [
        {
            "row": 2,
            "status": "changed",
            "key": "AAPL",
            "data": {
                "symbol": "AAPL",
                "date": "2026-10-27",
                "close": "233.10"
            },
            "diff": {
                "close": [
                    "231.45",
                    "233.10"
                ]
            },
            "errors": []
        }
    ],
    "next_offset": null,
    "has_more": false
}

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`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
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/batches/311/rows"
}

On the screens

The same thing in the app is explained in: