GET `/api/v1/feeds`

Feeds and their schedule.

Scope data:read
operationId dataFeeds

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

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

Python (requests)

import os, requests

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

Response fields

Field	Type	Description
`data`	list of Feed	The records of this page or list.
`data[].id`	id (string)	The record's id (a string of digits).
`data[].name`	string	The feed's name.
`data[].dataset`	string	The data set: securities, accounts, positions, lots, cash, prices, fx, corporate_actions, issuers, brokers, benchmarks…
`data[].source`	string	How files arrive: dropbox, push or pull.
`data[].format`	string	File format.
`data[].filename_pattern`	string	The pattern a file name must follow.
`data[].apply_mode`	string	How a feed's clean files are applied: "auto", "hold" (always reviewed) or "hold_on_threshold".
`data[].expected_by`	string or null	The time (New York) the file is expected by; later raises a "late" alert.
`data[].cutoff`	string or null	After this time (New York) the business date is "missed".
`data[].calendar`	string	The business calendar the feed follows.
`data[].sod_step`	string or null	The start-of-day step the feed belongs to.
`data[].depends_on`	list of string	Feeds that must be applied first.
`data[].active`	boolean	Whether it is in use.

Example response

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

{
    "data": [
        {
            "id": "1042",
            "name": "Morning prices",
            "dataset": "prices",
            "source": "dropbox",
            "format": "xml",
            "filename_pattern": "<FIRM>_PRICE_<YYYYMMDD>_<SEQ>.xml",
            "apply_mode": "auto",
            "expected_by": "07:00",
            "cutoff": "08:30",
            "calendar": "US",
            "sod_step": "prices",
            "depends_on": [
                "security"
            ],
            "active": 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.

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`
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/feeds"
}

On the screens

The same thing in the app is explained in: