dev.coinop/longwatch

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "url",
        "rss",
        "price",
        "edgar"
      ],
      "description": "watch type"
    },
    "url": {
      "type": "string",
      "description": "url|rss: page or feed URL to watch"
    },
    "coin": {
      "type": "string",
      "description": "price: CoinGecko id, e.g. 'bitcoin'"
    },
    "above": {
      "type": "number",
      "description": "price: alert when USD price crosses above this"
    },
    "below": {
      "type": "number",
      "description": "price: alert when USD price crosses below this"
    },
    "move_pct_24h": {
      "type": "number",
      "description": "price: alert when |24h change| exceeds this percent"
    },
    "ticker": {
      "type": "string",
      "description": "edgar: stock ticker, e.g. 'NVDA'"
    },
    "cik": {
      "type": "number",
      "description": "edgar: SEC CIK, as an alternative to ticker"
    },
    "forms": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "edgar: form filter, e.g. [\"8-K\",\"4\"]"
    },
    "webhook": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        }
      },
      "required": [
        "url"
      ],
      "additionalProperties": false,
      "description": "optional: POST alerts to this URL as they occur (signed); polling still works"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "watch_id": {
      "type": "string",
      "description": "watch_id returned by create_watch"
    },
    "key": {
      "type": "string",
      "description": "key returned by create_watch"
    },
    "since": {
      "type": "number",
      "description": "highest alert seq already seen; 0 on first poll"
    }
  },
  "required": [
    "watch_id",
    "key"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "watch_id": {
      "type": "string",
      "description": "watch_id to delete"
    },
    "key": {
      "type": "string",
      "description": "key returned by create_watch"
    }
  },
  "required": [
    "watch_id",
    "key"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}