TradeInstrument trade.instrument@1

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version
1.0.0
Owner
trade
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/trade/instrument.v1.json

trade.instrument@1: one instrument as OpenVibe.Trade's API shows it (server/domain/reading.js instrumentDto).

Fields

FieldTypeRequiredDescriptionConstraints
idstringyes
symbolstringyes
namestringyes
kindenumyes
  • one of "equity", "fund", "index", "currency", "commodity", "crypto", "other"
exchangestring | null
cikstring | null
  • pattern ^[0-9]{10}$
currencystring | null
statusenumyes
  • one of "active", "archived"
urlstringyes
created_atstring | null
  • format date-time
updated_atstring | null
  • format date-time

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: equity
{
  "id": "ins_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "symbol": "ACME",
  "name": "Acme Corporation",
  "kind": "equity",
  "exchange": "NASDAQ",
  "cik": "0000123456",
  "currency": "USD",
  "status": "active",
  "url": "https://openvibe.trade/i/ACME",
  "created_at": "2026-09-20T10:00:00.000Z",
  "updated_at": "2026-09-20T10:00:00.000Z"
}
Rejected: bad-kind
{
  "id": "ins_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "symbol": "ACME",
  "name": "Acme Corporation",
  "kind": "bond",
  "exchange": "NASDAQ",
  "cik": "0000123456",
  "currency": "USD",
  "status": "active",
  "url": "https://openvibe.trade/i/ACME",
  "created_at": "2026-09-20T10:00:00.000Z",
  "updated_at": "2026-09-20T10:00:00.000Z"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('trade.instrument@1', value);   // { valid, errors: [{ path, message }] }