v2

latestOpenAPI 3.0.4Commercial License2026-08-0718678294.5 KB

Subscriptions

Create a price watch

Create a persistent price watch that emits events when its condition is met.

post/v1/subscriptions

Request body

namestring

codesstring[]

Commodity codes to evaluate. Codes and minimum interval depend on the account tier.

codestring

Legacy single-code shorthand; folded into codes.

interval_secondsinteger required

Evaluation interval in seconds, subject to the account tier's minimum.

deliver_webhookboolean

source'api' | 'mcp' | 'dashboard'

tool_namestring

Example request

{
  "name": "My WTI watch",
  "codes": [
    "WTI_USD",
    "BRENT_CRUDE_USD"
  ],
  "code": "WTI_USD",
  "interval_seconds": 3600,
  "deliver_webhook": true,
  "source": "mcp",
  "tool_name": "watch_commodity"
}

Response

Price watch created

status'success' required

Example response

{
  "status": "success",
  "data": {
    "subscription": {
      "id": "018f47a2-4d4d-7a44-9fa4-123456789abc",
      "name": "My WTI watch",
      "codes": [
        "WTI_USD",
        "BRENT_CRUDE_USD"
      ],
      "interval_seconds": 3600,
      "status": "active",
      "source": "api",
      "tool_name": "watch_commodity"
    }
  }
}