TradeAlertReadResult trade.alert-read-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/alert-read-result.v1.json

trade.alert-read-result@1: answers of trade.alert.read on OpenVibe.Trade (the acting person's): GET /api/v1/alerts → { rules }; GET /api/v1/alerts/deliveries?limit= → { deliveries } (newest first, at most 200: which rule fired on what, and the event sent).

Fields

This schema has no named fields.

Examples

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

{
  "rules": [
    {
      "id": "alr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "kind": "threshold",
      "status": "active",
      "instrument": {
        "id": "ins_01JAB2C3D4E5F6G7H8J9K0MNPQ",
        "symbol": "ACME",
        "name": "Acme Corporation"
      },
      "metric": "close",
      "operator": "below",
      "threshold": "150",
      "unit": "USD",
      "currency": "USD",
      "form_types": null,
      "armed": true,
      "created_at": "2026-09-25T10:00:00.000Z",
      "updated_at": "2026-09-25T10:00:00.000Z"
    }
  ]
}

{
  "deliveries": [
    {
      "id": 1
    }
  ]
}

Validate

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