API reference

GET /api/v1/openapi.json

This API's OpenAPI 3.1 document

No token needed.

Answers: 200 OpenApi; errors as problem+json.

GET /api/v1/me

Who the token acts as: user or service account, firm, role, privileges, scopes

Answers: 200 Me; errors as problem+json.

GET /api/v1/scopes

Every scope with its meaning

Answers: 200 ScopeList; errors as problem+json.

GET /api/v1/jobs/{id}

A long-running operation (202 responses point here)

Answers: 200 Job; errors as problem+json.

GET /api/v1/firm

The firm and its settings

Scope: firm:read (and the privileges of the user or service account behind the token).

Answers: 200 Firm; errors as problem+json.

PATCH /api/v1/firm

Change settings (If-Match)

Scope: firm:write (and the privileges of the user or service account behind the token).

Body: FirmPatch

Answers: 200 Firm; errors as problem+json.

GET /api/v1/users

Users of the firm (people and service accounts)

Scope: users:read (and the privileges of the user or service account behind the token).

Answers: 200 page of User; errors as problem+json.

POST /api/v1/users

Invite a person (an email with a link)

Scope: admin:users (and the privileges of the user or service account behind the token).

Body: Invite

Answers: 201 Invitation; errors as problem+json.

GET /api/v1/users/{id}

One user with privileges

Scope: users:read (and the privileges of the user or service account behind the token).

Answers: 200 User; errors as problem+json.

PATCH /api/v1/users/{id}

Change role or status (If-Match)

Scope: admin:users (and the privileges of the user or service account behind the token).

Body: UserPatch

Answers: 200 User; errors as problem+json.

PUT /api/v1/users/{id}/privileges/{privilege}

Grant, remove or reset one privilege

Scope: admin:users (and the privileges of the user or service account behind the token).

Body: PrivilegeSet

Answers: 200 User; errors as problem+json.

GET /api/v1/roles

Roles, their default privileges and maximum account permissions

Scope: users:read (and the privileges of the user or service account behind the token).

Answers: 200 RoleList; errors as problem+json.

GET /api/v1/entitlements

Per-account permissions of every user

Scope: entitlements:read (and the privileges of the user or service account behind the token).

Answers: 200 EntitlementList; errors as problem+json.

PUT /api/v1/entitlements/{userId}/{accountId}

Set one user's permissions on one account

Scope: entitlements:write (and the privileges of the user or service account behind the token).

Body: PermissionSet

Answers: 200 Entitlement; errors as problem+json.

GET /api/v1/access-reviews

Access reviews

Scope: access_reviews:read (and the privileges of the user or service account behind the token).

Answers: 200 page of AccessReview; errors as problem+json.

POST /api/v1/access-reviews

Draft a new access review

Scope: access_reviews:write (and the privileges of the user or service account behind the token).

Answers: 201 AccessReview; errors as problem+json.

GET /api/v1/access-reviews/{id}

One access review with its recommendations

Scope: access_reviews:read (and the privileges of the user or service account behind the token).

Answers: 200 AccessReview; errors as problem+json.

POST /api/v1/access-reviews/{id}/sign-off

Sign off, applying the chosen recommendations (a person)

Scope: access_reviews:write (and the privileges of the user or service account behind the token).

A person must do this: a token from the authorization code flow or a personal access token, never client credentials.

Body: ReviewSignOff

Answers: 200 AccessReview; errors as problem+json.

GET /api/v1/securities

The security master

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Security; errors as problem+json.

POST /api/v1/securities

Add a security

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: SecurityIn

Answers: 201 Security; errors as problem+json.

GET /api/v1/securities/{id}

One security, with its user-defined fields

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 Security; errors as problem+json.

PATCH /api/v1/securities/{id}

Change a security (If-Match)

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: SecurityIn

Answers: 200 Security; errors as problem+json.

GET /api/v1/issuers

Issuers

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Issuer; errors as problem+json.

GET /api/v1/brokers

Brokers (reference only: Vestoris connects to no broker)

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Broker; errors as problem+json.

GET /api/v1/benchmarks

Benchmarks with constituents

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Benchmark; errors as problem+json.

GET /api/v1/account-groups

Account groups (members limited to the accounts you can see)

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 page of AccountGroup; errors as problem+json.

POST /api/v1/account-groups

Create an account group

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: AccountGroupIn

Answers: 201 AccountGroup; errors as problem+json.

GET /api/v1/lists

Restricted, watch and exclusion lists

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 page of SecurityList; errors as problem+json.

GET /api/v1/lists/{id}

One list with its members

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 SecurityList; errors as problem+json.

POST /api/v1/lists/{id}/members

Add securities to a list

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: ListMembersIn

Answers: 200 SecurityList; errors as problem+json.

DELETE /api/v1/lists/{id}/members/{securityId}

Remove a security from a list

Scope: reference:write (and the privileges of the user or service account behind the token).

Answers: 200 SecurityList; errors as problem+json.

GET /api/v1/udf/{table}

The ten user-defined field definitions of a table

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 UdfDefList; errors as problem+json.

PUT /api/v1/udf/{table}/{slot}

Define a field (Admins; versioned)

Scope: udf:admin (and the privileges of the user or service account behind the token).

Body: UdfDefIn

Answers: 200 UdfDef; errors as problem+json.

GET /api/v1/udf/{table}/records/{key}

The user-defined values of one record

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 UdfValues; errors as problem+json.

PUT /api/v1/udf/{table}/records/{key}

Set user-defined values of one record (If-Match)

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: UdfValuesIn

Answers: 200 UdfValues; errors as problem+json.

GET /api/v1/accounts

The accounts you can see, valued at the latest simulated closes

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Account; errors as problem+json.

POST /api/v1/accounts

Add an account (simulated cash)

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: AccountIn

Answers: 201 Account; errors as problem+json.

GET /api/v1/accounts/{id}

One account

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 Account; errors as problem+json.

PATCH /api/v1/accounts/{id}

Change an account, incl. its model (If-Match)

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: AccountIn

Answers: 200 Account; errors as problem+json.

GET /api/v1/accounts/{id}/positions

Positions with value and weight

Scope: portfolio:read (and the privileges of the user or service account behind the token).

Answers: 200 PositionList; errors as problem+json.

GET /api/v1/accounts/{id}/lots

Open tax lots

Scope: portfolio:read (and the privileges of the user or service account behind the token).

Answers: 200 LotList; errors as problem+json.

GET /api/v1/accounts/{id}/cash

Cash balance and recent (simulated) movements

Scope: portfolio:read (and the privileges of the user or service account behind the token).

Answers: 200 Cash; errors as problem+json.

POST /api/v1/accounts/{id}/cash

Deposit or withdraw simulated cash

Scope: portfolio:write (and the privileges of the user or service account behind the token).

Body: CashMove

Answers: 201 Cash; errors as problem+json.

GET /api/v1/accounts/{id}/drift

Drift against the account's model

Scope: portfolio:read (and the privileges of the user or service account behind the token).

Answers: 200 Drift; errors as problem+json.

GET /api/v1/accounts/{id}/risk

Concentration, exposures and factor betas

Scope: portfolio:read (and the privileges of the user or service account behind the token).

Answers: 200 Risk; errors as problem+json.

GET /api/v1/models

Model portfolios

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Model; errors as problem+json.

POST /api/v1/models

Create a model

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: ModelIn

Answers: 201 Model; errors as problem+json.

GET /api/v1/models/{id}

One model with targets

Scope: reference:read (and the privileges of the user or service account behind the token).

Answers: 200 Model; errors as problem+json.

PUT /api/v1/models/{id}

Replace a model's targets (If-Match)

Scope: reference:write (and the privileges of the user or service account behind the token).

Body: ModelIn

Answers: 200 Model; errors as problem+json.

POST /api/v1/rebalance-proposals

Rebalance accounts: proposals in the intent pipeline (never orders); 202 with a job for more than 3 accounts

Scope: portfolio:write (and the privileges of the user or service account behind the token).

Long operations answer 202 with a job (GET /api/v1/jobs/{id}).

Body: RebalanceIn

Answers: 201 PipelineRun · 202 Job; errors as problem+json.

POST /api/v1/what-ifs

A what-if: sector changes for accounts, as a pipeline proposal

Scope: portfolio:write (and the privileges of the user or service account behind the token).

Body: WhatIfIn

Answers: 201 PipelineRun; errors as problem+json.

GET /api/v1/proposals

Rebalance proposals

Scope: pipeline:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Proposal; errors as problem+json.

GET /api/v1/proposals/{id}

One proposal with its trades

Scope: pipeline:read (and the privileges of the user or service account behind the token).

Answers: 200 Proposal; errors as problem+json.

GET /api/v1/prices

Daily (simulated) closes of a security

Scope: market:read (and the privileges of the user or service account behind the token).

Answers: 200 PriceList; errors as problem+json.

GET /api/v1/prices/latest

The latest close of securities

Scope: market:read (and the privileges of the user or service account behind the token).

Answers: 200 PriceList; errors as problem+json.

GET /api/v1/fx-rates

FX rates

Scope: market:read (and the privileges of the user or service account behind the token).

Answers: 200 FxList; errors as problem+json.

GET /api/v1/corporate-actions

Corporate actions (splits, cash dividends)

Scope: market:read (and the privileges of the user or service account behind the token).

Answers: 200 page of CorporateAction; errors as problem+json.

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

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

Scope: market:read (and the privileges of the user or service account behind the token).

Answers: 200 AsOf; errors as problem+json.

GET /api/v1/orders

Orders on the accounts you can see

Scope: orders:read (and the privileges of the user or service account behind the token).

Answers: 200 page of OrderSummary; errors as problem+json.

POST /api/v1/orders

Enter an order: checked by compliance and routed by the workflow rules like any order (paper trading)

Scope: orders:write (and the privileges of the user or service account behind the token).

Body: OrderIn

Answers: 201 Order; errors as problem+json.

GET /api/v1/orders/{id}

One order with allocations, compliance and history

Scope: orders:read (and the privileges of the user or service account behind the token).

Answers: 200 Order; errors as problem+json.

POST /api/v1/orders/{id}/amend

Amend quantity or limit (compliance re-checked; If-Match)

Scope: orders:write (and the privileges of the user or service account behind the token).

Body: OrderAmend

Answers: 200 Order; errors as problem+json.

POST /api/v1/orders/{id}/cancel

Cancel the unfilled part

Scope: orders:write (and the privileges of the user or service account behind the token).

Body: Reason

Answers: 200 Order; errors as problem+json.

POST /api/v1/orders/{id}/release

Release an approved order to the simulator (compliance re-checked)

Scope: orders:write (and the privileges of the user or service account behind the token).

Body: Release

Answers: 200 Order; errors as problem+json.

POST /api/v1/orders/{id}/rework

Re-plan a working order's unfilled shares with another algo

Scope: orders:write (and the privileges of the user or service account behind the token).

Body: Release

Answers: 200 Order; errors as problem+json.

POST /api/v1/orders/{id}/approve

Approve (four eyes: never the person who entered it)

Scope: orders:approve (and the privileges of the user or service account behind the token).

An approval: four eyes apply; a service account needs its client's "may approve" setting.

Body: Note

Answers: 200 Order; errors as problem+json.

POST /api/v1/orders/{id}/reject

Reject

Scope: orders:approve (and the privileges of the user or service account behind the token).

An approval: four eyes apply; a service account needs its client's "may approve" setting.

Body: Reason

Answers: 200 Order; errors as problem+json.

POST /api/v1/orders/{id}/override

Override a soft compliance warning with a written reason

Scope: orders:write (and the privileges of the user or service account behind the token).

Body: Reason

Answers: 200 Order; errors as problem+json.

POST /api/v1/orders/{id}/allocate

Confirm the allocation of executions (Operations)

Scope: orders:write (and the privileges of the user or service account behind the token).

Answers: 200 Order; errors as problem+json.

GET /api/v1/orders/{id}/fills

Simulated fills of an order

Scope: orders:read (and the privileges of the user or service account behind the token).

Answers: 200 FillList; errors as problem+json.

GET /api/v1/executions

Simulated fills on the accounts you can see

Scope: orders:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Fill; errors as problem+json.

GET /api/v1/blotter/views

Saved blotter views (yours and the firm's)

Scope: orders:read (and the privileges of the user or service account behind the token).

Answers: 200 BlotterViewList; errors as problem+json.

POST /api/v1/blotter/views

Save a blotter view (validated against the field registry)

Scope: orders:write (and the privileges of the user or service account behind the token).

Body: BlotterViewIn

Answers: 201 BlotterView; errors as problem+json.

PUT /api/v1/blotter/views/{id}

Replace a blotter view

Scope: orders:write (and the privileges of the user or service account behind the token).

Body: BlotterViewIn

Answers: 200 BlotterView; errors as problem+json.

DELETE /api/v1/blotter/views/{id}

Delete a blotter view

Scope: orders:write (and the privileges of the user or service account behind the token).

Answers: 204 Done (no content); errors as problem+json.

GET /api/v1/overrides

Override requests

Scope: compliance:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Override; errors as problem+json.

POST /api/v1/overrides/{id}/decision

Approve or reject an override (Compliance; four eyes)

Scope: orders:approve (and the privileges of the user or service account behind the token).

An approval: four eyes apply; a service account needs its client's "may approve" setting.

Body: Decision

Answers: 200 Override; errors as problem+json.

GET /api/v1/compliance/rules

Rules (every version)

Scope: compliance:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Rule; errors as problem+json.

POST /api/v1/compliance/rules

Draft a rule (structured definition)

Scope: compliance:rules:write (and the privileges of the user or service account behind the token).

Body: RuleIn

Answers: 201 Rule; errors as problem+json.

GET /api/v1/compliance/rules/{id}

One rule version with restatement and test bench

Scope: compliance:read (and the privileges of the user or service account behind the token).

Answers: 200 Rule; errors as problem+json.

PATCH /api/v1/compliance/rules/{id}

Change a draft (If-Match)

Scope: compliance:rules:write (and the privileges of the user or service account behind the token).

Body: RuleIn

Answers: 200 Rule; errors as problem+json.

GET /api/v1/compliance/rules/{id}/versions

Every version of the rule's lineage

Scope: compliance:read (and the privileges of the user or service account behind the token).

Answers: 200 RuleList; errors as problem+json.

POST /api/v1/compliance/rules/{id}/test-bench

Run the test bench (202: a job)

Scope: compliance:rules:write (and the privileges of the user or service account behind the token).

Long operations answer 202 with a job (GET /api/v1/jobs/{id}).

Body: Days

Answers: 202 Job; errors as problem+json.

POST /api/v1/compliance/rules/{id}/submit

Submit for sign-off

Scope: compliance:rules:write (and the privileges of the user or service account behind the token).

Answers: 200 Rule; errors as problem+json.

GET /api/v1/compliance/rules/{id}/sign-off

What you would sign off, with a confirmation token for X-Vestoris-Confirm

Scope: compliance:rules:approve (and the privileges of the user or service account behind the token).

A person must do this: a token from the authorization code flow or a personal access token, never client credentials.

Answers: 200 SignOffPreview; errors as problem+json.

POST /api/v1/compliance/rules/{id}/sign-off

Sign off (a person, never client credentials; X-Vestoris-Confirm)

Scope: compliance:rules:approve (and the privileges of the user or service account behind the token).

A person must do this: a token from the authorization code flow or a personal access token, never client credentials.

An approval: four eyes apply; a service account needs its client's "may approve" setting.

Needs X-Vestoris-Confirm with the confirm_token of the preview.

Body: SignOff

Answers: 200 Rule; errors as problem+json.

POST /api/v1/compliance/rules/{id}/reject

Send back to the author with comments

Scope: compliance:rules:approve (and the privileges of the user or service account behind the token).

A person must do this: a token from the authorization code flow or a personal access token, never client credentials.

Body: Reason

Answers: 200 Rule; errors as problem+json.

POST /api/v1/compliance/rules/{id}/retire

Ask for an active rule to be retired (signed off like a change)

Scope: compliance:rules:write (and the privileges of the user or service account behind the token).

Body: Reason

Answers: 200 Rule; errors as problem+json.

GET /api/v1/compliance/violations

Violations

Scope: compliance:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Violation; errors as problem+json.

GET /api/v1/compliance/violations/{id}

One violation

Scope: compliance:read (and the privileges of the user or service account behind the token).

Answers: 200 Violation; errors as problem+json.

POST /api/v1/compliance/violations/{id}/transition

Acknowledge, resolve, waive (with a reason) or escalate

Scope: compliance:violations:write (and the privileges of the user or service account behind the token).

Body: ViolationTransition

Answers: 200 Violation; errors as problem+json.

GET /api/v1/compliance/packages

Rule packages and their assignments

Scope: compliance:read (and the privileges of the user or service account behind the token).

Answers: 200 PackageList; errors as problem+json.

GET /api/v1/compliance/register

The rule register (JSON, or ?format=pdf)

Scope: compliance:reports:read (and the privileges of the user or service account behind the token).

Answers: 200 Register; errors as problem+json.

GET /api/v1/compliance/reports

Periodic compliance reports

Scope: compliance:reports:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Report; errors as problem+json.

POST /api/v1/compliance/reports

Generate a report for a period (202: a job)

Scope: compliance:reports:read (and the privileges of the user or service account behind the token).

Long operations answer 202 with a job (GET /api/v1/jobs/{id}).

Body: ReportIn

Answers: 202 Job; errors as problem+json.

GET /api/v1/pipeline/runs

Your intent-pipeline requests

Scope: pipeline:read (and the privileges of the user or service account behind the token).

Answers: 200 page of PipelineRun; errors as problem+json.

POST /api/v1/pipeline/runs

Interpret a request in plain English (stage 0; the AI may be used)

Scope: pipeline:write (and the privileges of the user or service account behind the token).

Body: PipelineIn

Answers: 201 PipelineRun; errors as problem+json.

GET /api/v1/pipeline/runs/{id}

A request with its stages

Scope: pipeline:read (and the privileges of the user or service account behind the token).

Answers: 200 PipelineRun; errors as problem+json.

POST /api/v1/pipeline/runs/{id}/run

Run the stages: entitlements, proposals, compliance pre-check

Scope: pipeline:write (and the privileges of the user or service account behind the token).

Answers: 200 PipelineRun; errors as problem+json.

POST /api/v1/pipeline/runs/{id}/orders

Create the orders (each checked again; nothing is executed)

Scope: pipeline:write (and the privileges of the user or service account behind the token).

Answers: 200 PipelineRun; errors as problem+json.

GET /api/v1/surveillance/alerts

Surveillance and anomaly alerts

Scope: surveillance:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Alert; errors as problem+json.

GET /api/v1/surveillance/alerts/{id}

One alert

Scope: surveillance:read (and the privileges of the user or service account behind the token).

Answers: 200 Alert; errors as problem+json.

POST /api/v1/surveillance/alerts/{id}/review

Review an alert (reviewed, dismissed, escalated) with a note

Scope: surveillance:write (and the privileges of the user or service account behind the token).

Body: AlertReview

Answers: 200 Alert; errors as problem+json.

GET /api/v1/workflow/items

Items in flight you can see (the monitor's board)

Scope: workflow:read (and the privileges of the user or service account behind the token).

Answers: 200 page of WorkflowItem; errors as problem+json.

GET /api/v1/workflow/items/{id}

One item with history, comments and approvals

Scope: workflow:read (and the privileges of the user or service account behind the token).

Answers: 200 WorkflowItem; errors as problem+json.

POST /api/v1/workflow/items/{id}/actions

Claim, release, reassign, escalate, set the priority, move to a desk, comment, watch (never approve)

Scope: workflow:act (and the privileges of the user or service account behind the token).

Body: WorkflowAction

Answers: 200 WorkflowItem; errors as problem+json.

GET /api/v1/workflow/my-work

What waits on you, what you requested, what you watch

Scope: workflow:read (and the privileges of the user or service account behind the token).

Answers: 200 MyWork; errors as problem+json.

GET /api/v1/workflow/rules

Workflow rules (every version)

Scope: workflow:read (and the privileges of the user or service account behind the token).

Answers: 200 page of WorkflowRule; errors as problem+json.

POST /api/v1/workflow/rules

Draft a rule from a structure, or from a sentence ("text"); replayed on the test bench

Scope: workflow:rules:write (and the privileges of the user or service account behind the token).

Body: WorkflowRuleIn

Answers: 201 WorkflowRule; errors as problem+json.

GET /api/v1/workflow/rules/{id}

One workflow rule

Scope: workflow:read (and the privileges of the user or service account behind the token).

Answers: 200 WorkflowRule; errors as problem+json.

POST /api/v1/workflow/rules/{id}/test-bench

Replay the last days of items (202: a job)

Scope: workflow:rules:write (and the privileges of the user or service account behind the token).

Long operations answer 202 with a job (GET /api/v1/jobs/{id}).

Body: Days

Answers: 202 Job; errors as problem+json.

POST /api/v1/workflow/rules/{id}/submit

Submit for sign-off

Scope: workflow:rules:write (and the privileges of the user or service account behind the token).

Answers: 200 WorkflowRule; errors as problem+json.

GET /api/v1/workflow/rules/{id}/sign-off

What you would sign off, with a confirmation token

Scope: workflow:rules:approve (and the privileges of the user or service account behind the token).

A person must do this: a token from the authorization code flow or a personal access token, never client credentials.

Answers: 200 SignOffPreview; errors as problem+json.

POST /api/v1/workflow/rules/{id}/sign-off

Sign off as Admin or Compliance (a person; X-Vestoris-Confirm)

Scope: workflow:rules:approve (and the privileges of the user or service account behind the token).

A person must do this: a token from the authorization code flow or a personal access token, never client credentials.

An approval: four eyes apply; a service account needs its client's "may approve" setting.

Needs X-Vestoris-Confirm with the confirm_token of the preview.

Body: WorkflowSignOff

Answers: 200 WorkflowRule; errors as problem+json.

GET /api/v1/workflow/desks

Desks, members and assignment modes

Scope: workflow:read (and the privileges of the user or service account behind the token).

Answers: 200 DeskList; errors as problem+json.

GET /api/v1/workflow/slas

SLA minutes and escalations per stage

Scope: workflow:read (and the privileges of the user or service account behind the token).

Answers: 200 SlaList; errors as problem+json.

GET /api/v1/workflow/views

Saved monitor views

Scope: workflow:read (and the privileges of the user or service account behind the token).

Answers: 200 MonitorViewList; errors as problem+json.

POST /api/v1/data/{dataset}

Load a file (CSV, TXT, XLSX or Vestoris XML) into a data set; the body is the file

Scope: data:load:<data set> (and the privileges of the user or service account behind the token).

Also accepts legacy API keys (deprecated: Deprecation and Sunset headers are sent; see /developers/legacy-keys).

Body: The file itself (application/octet-stream)

Answers: 201 LegacyBatch · 422 LegacyBatch; errors as problem+json.

GET /api/v1/batches

Load history

Scope: data:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Batch; errors as problem+json.

GET /api/v1/batches/{id}

A batch's status and counts

Scope: data:read (and the privileges of the user or service account behind the token).

Also accepts legacy API keys (deprecated: Deprecation and Sunset headers are sent; see /developers/legacy-keys).

Answers: 200 LegacyBatchStatus; errors as problem+json.

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

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

Scope: data:read (and the privileges of the user or service account behind the token).

Answers: 200 BatchRows; errors as problem+json.

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

Apply a staged batch

Scope: data:write (and the privileges of the user or service account behind the token).

Answers: 200 Batch; errors as problem+json.

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

Undo an applied batch (unless later trades depend on it)

Scope: data:write (and the privileges of the user or service account behind the token).

Answers: 200 Batch; errors as problem+json.

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

Discard a staged batch

Scope: data:write (and the privileges of the user or service account behind the token).

Answers: 200 Batch; errors as problem+json.

POST /api/v1/feeds/bundles

Load a folder of feed files (.zip); each file needs its data:load scope

Scope: data:load:<data set> (and the privileges of the user or service account behind the token).

Also accepts legacy API keys (deprecated: Deprecation and Sunset headers are sent; see /developers/legacy-keys).

Body: The file itself (application/octet-stream)

Answers: 201 LegacyBundle · 202 LegacyBundle; errors as problem+json.

GET /api/v1/feeds/bundles/{id}

A folder's status, per file

Scope: data:read (and the privileges of the user or service account behind the token).

Also accepts legacy API keys (deprecated: Deprecation and Sunset headers are sent; see /developers/legacy-keys).

Answers: 200 LegacyBundle; errors as problem+json.

POST /api/v1/feeds/{id}/files

Push a file to an HTTPS-push feed (the feed's data:load scope)

Scope: data:load:<data set> (and the privileges of the user or service account behind the token).

Also accepts legacy API keys (deprecated: Deprecation and Sunset headers are sent; see /developers/legacy-keys).

Body: The file itself (application/octet-stream)

Answers: 202 LegacyFeedFile · 422 LegacyFeedFile; errors as problem+json.

GET /api/v1/feeds

Feeds and their schedule

Scope: data:read (and the privileges of the user or service account behind the token).

Answers: 200 FeedList; errors as problem+json.

GET /api/v1/feeds/runs

Feed runs of a business date

Scope: data:read (and the privileges of the user or service account behind the token).

Answers: 200 FeedRunList; errors as problem+json.

POST /api/v1/feeds/runs/{id}/review

Apply or reject a held feed file

Scope: data:write (and the privileges of the user or service account behind the token).

Body: HeldReview

Answers: 200 FeedRun; errors as problem+json.

GET /api/v1/schedules

Scheduled jobs and their last runs

Scope: data:read (and the privileges of the user or service account behind the token).

Answers: 200 ScheduleList; errors as problem+json.

GET /api/v1/start-of-day

The start-of-day chain of a business date

Scope: data:read (and the privileges of the user or service account behind the token).

Answers: 200 StartOfDay; errors as problem+json.

GET /api/v1/data-quality/issues

Data quality issues

Scope: data:read (and the privileges of the user or service account behind the token).

Answers: 200 page of DqIssue; errors as problem+json.

GET /api/v1/events

The hash-chained event log

Scope: events:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Event; errors as problem+json.

GET /api/v1/events/verify

Verify the firm's hash chain

Scope: events:read (and the privileges of the user or service account behind the token).

Answers: 200 ChainCheck; errors as problem+json.

GET /api/v1/ai-log

AI interactions (metadata; inputs and outputs are on the AI log page)

Scope: ai_log:read (and the privileges of the user or service account behind the token).

Answers: 200 page of AiInteraction; errors as problem+json.

POST /api/v1/copilot/questions

Ask the copilot (answers only from what you may see; logged)

Scope: ai:use (and the privileges of the user or service account behind the token).

Body: Question

Answers: 200 CopilotAnswer; errors as problem+json.

POST /api/v1/commands/{screen}

Plan a natural-language command and preview it (screen: portfolio, blotter, monitor, wfrules); nothing runs

Scope: ai:use (and the privileges of the user or service account behind the token).

Body: CommandIn

Answers: 201 Command; errors as problem+json.

GET /api/v1/commands/{id}

A command with its plan, preview and results

Scope: ai:use (and the privileges of the user or service account behind the token).

Answers: 200 Command; errors as problem+json.

POST /api/v1/commands/{id}/execute

Execute the previewed plan (X-Vestoris-Confirm: the preview token; "typed" for large or destructive plans)

Scope: commands:execute (and the privileges of the user or service account behind the token).

Needs X-Vestoris-Confirm with the confirm_token of the preview.

Body: CommandExecute

Answers: 200 Command; errors as problem+json.

POST /api/v1/commands/{id}/cancel

Cancel a previewed command

Scope: ai:use (and the privileges of the user or service account behind the token).

Answers: 200 Command; errors as problem+json.

GET /api/v1/webhooks

Webhooks

Scope: webhooks:read (and the privileges of the user or service account behind the token).

Answers: 200 WebhookList; errors as problem+json.

POST /api/v1/webhooks

Add a webhook (the signing secret is returned once)

Scope: webhooks:write (and the privileges of the user or service account behind the token).

Body: WebhookIn

Answers: 201 WebhookCreated; errors as problem+json.

PATCH /api/v1/webhooks/{id}

Change events, URL or status

Scope: webhooks:write (and the privileges of the user or service account behind the token).

Body: WebhookIn

Answers: 200 Webhook; errors as problem+json.

DELETE /api/v1/webhooks/{id}

Delete a webhook

Scope: webhooks:write (and the privileges of the user or service account behind the token).

Answers: 204 Done (no content); errors as problem+json.

GET /api/v1/webhooks/{id}/deliveries

The delivery log

Scope: webhooks:read (and the privileges of the user or service account behind the token).

Answers: 200 page of Delivery; errors as problem+json.

POST /api/v1/webhooks/{id}/deliveries/{deliveryId}/redeliver

Send a delivery again

Scope: webhooks:write (and the privileges of the user or service account behind the token).

Answers: 200 Delivery; errors as problem+json.

POST /api/v1/webhooks/{id}/ping

Send a test event

Scope: webhooks:write (and the privileges of the user or service account behind the token).

Answers: 202 Delivery; errors as problem+json.

GET /api/v1/owner/inquiries

Inquiries from the site's forms (site administrators only)

Scope: owner:inquiries (and the privileges of the user or service account behind the token).

Answers: 200 InquiryList; errors as problem+json.