TradeAlertRuleResult trade.alert-rule-result@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/alert-rule-result.v1.json

trade.alert-rule-result@1: the answer of POST /api/v1/alerts on OpenVibe.Trade: 201 { rule }.

Fields

FieldTypeRequiredDescriptionConstraints
ruletrade.alert-ruleyes

Examples

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

Valid: rule
{
  "rule": {
    "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"
  }
}
Rejected: partial
{
  "rule": {
    "id": "x"
  }
}

Validate

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