The Instruments API lets you read instrument type schemas, create and manage individual instruments, and organise them with hierarchical tags. All routes are scoped to a workspace.
Instrument types define the schema for a class of instruments (e.g. Equity, Bond, ETF). Robot users can read types to understand the available schemas but cannot create or modify them — that requires the Editor role.
GET/instrument-typesList instrument typesViewer+▶
GET/instrument-types/{id}Get an instrument typeViewer+▶
Field definitions describe the custom attributes available on instruments of a given type. Robot users can read fields to understand what field_values to supply when creating or updating instruments.
GET/instrument-type-fieldsList type fieldsViewer+▶
GET/instrument-type-fields/{id}Get a type fieldViewer+▶
POST/instrument-type-fields/filterFilter type fieldsViewer+▶
POST/instrument-type-fields/countCount type fieldsViewer+▶
Instruments
Individual instrument records. Each instrument belongs to one type and carries custom field values defined by that type’s schema. Supports full-text search, EAV field filtering, and tag-based queries.
GET/instrumentsList instrumentsViewer+▶
POST/instrumentsCreate an instrumentMember▶
Creates an instrument and upserts all field_values atomically. The extra_fields_snapshot in the response reflects all values immediately.