TradeWatchlistResult trade.watchlist-result@1

Generated at 2026-09-26 00:45:03 UTC 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/watchlist-result.v1.json

trade.watchlist-result@1: answers of the watchlist routes on OpenVibe.Trade: GET /api/v1/watchlists → { watchlists }; GET /api/v1/watchlists/:id, POST (201) and PATCH → { watchlist }; PUT …/items/:symbol → { added, watchlist }; DELETE …/items/:symbol → { removed, watchlist }.

Fields

This schema has no named fields.

Examples

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

{
  "added": true,
  "watchlist": {
    "id": "wl_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "name": "Semis",
    "created_at": "2026-09-25T10:00:00.000Z",
    "updated_at": "2026-09-25T10:00:00.000Z",
    "items": [
      {
        "instrument": {
          "id": "ins_01JAB2C3D4E5F6G7H8J9K0MNPQ",
          "symbol": "ACME",
          "name": "Acme Corporation",
          "kind": "equity",
          "exchange": "NASDAQ",
          "status": "active",
          "url": "https://openvibe.trade/i/ACME"
        },
        "note": "earnings in Oct",
        "added_at": "2026-09-25T10:00:00.000Z"
      }
    ]
  }
}

{
  "added": true
}

Validate

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