Developers › API reference › Data

POST /api/v1/batches/{id}/apply

Apply a staged batch.

• Scope data:write
• Idempotency-Key
• operationId dataApply

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

Request

POST /api/v1/batches/{id}/apply

Path parameters

Headers

Examples

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

curl -X POST "https://vestoris.com/api/v1/batches/311/apply" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11'

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/batches/311/apply",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    },
    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/batches/311/apply", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
  },
});
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: Batch. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Example response

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

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

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/batches/311/apply"
}

On the screens

The same thing in the app is explained in:

• The loading center
• Load history