Developers › API reference

Reference data API

The security master, issuers, brokers, benchmarks, account groups and lists.

Objects

Securities (the security master: identifiers, issuer, classification, trading attributes, ESG flags, user-defined values), issuers, brokers (reference only: Vestoris connects to no broker), benchmarks with constituents, account groups (members limited to the accounts you can see; other_accounts counts the rest) and lists (restricted, watch, exclusion) with members.

Notes

  • Changing a security needs If-Match with its ETag.
  • List changes take effect at once in every rule that uses the list, and are in the event log.
  • For bulk changes, load a file through the Data endpoints instead.

Endpoints

CallWhat it doesScope
GET/securitiesThe security masterreference:read
GET/securities/{id}One security, with its user-defined fieldsreference:read
POST/securitiesAdd a securityreference:write
PATCH/securities/{id}Change a security (If-Match)reference:write
GET/issuersIssuersreference:read
GET/brokersBrokers (reference only: Vestoris connects to no broker)reference:read
GET/benchmarksBenchmarks with constituentsreference:read
GET/account-groupsAccount groups (members limited to the accounts you can see)reference:read
POST/account-groupsCreate an account groupreference:write
GET/listsRestricted, watch and exclusion listsreference:read
GET/lists/{id}One list with its membersreference:read
POST/lists/{id}/membersAdd securities to a listreference:write
DELETE/lists/{id}/members/{securityId}Remove a security from a listreference:write