Skip to main content

VOCSET API Documentation

Version History​

VersionDateChanges
1.2.52026-09-21Amend and Cancel on POST /api/trade. GET /api/trade returns status and version. New GET /api/trade/{internalTradeID}/revisions. Client cannot be amended. Cancel needs only tradeID + status.
1.2.02026-08-22Programmatic API-key rotation (POST /api/auth/apiKey/rotate). Company fields accept an ISO 17442 LEI. Executing / full-service brokers may omit executingBroker and clearingBroker.
1.1.12026-02-01Simplified multi-leg trade format.
1.1.02026-01-16Updated for multi-leg trade support.
1.0.12025-12-29Various small updates.
1.0.02024-11-19Initial release — single-leg trades.

This document describes the 1.2.5 public trade and API-key surface. It is a restricted subset of VOCSET: trade upload, live blotter read, revision history, and credential rotation.


Authentication & Authorisation​

All endpoints require an API key. Create a key and secret from your user profile in the VOCSET application.

Send both values on every request:

X-API-KEY: <api_key>
X-API-SECRET: <api_secret>

Successful authenticated responses include:

x-api-key-expiry: 2026-11-20T17:16:12Z

That is the ISO-8601 UTC instant when the current key expires (60 days from creation). Rotate before then.

An invalid or inactive key is rejected.

Response envelope​

Successful and most error bodies look like:

{
"timestamp": "2026-09-21T17:16:12.424011385Z",
"status": 200,
"result": {},
"path": "/api/trade"
}

result is the payload: an array of per-row outcomes on POST /api/trade, an array of trades on GET /api/trade, a history object on revisions, or the new key pair on rotation. HTTP 200 on upload does not mean every row succeeded — inspect each element's status.

Handling trades​

Managing API keys​