PreReason

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "claim_code": {
      "type": "string",
      "maxLength": 16,
      "description": "The claim_code from request_access, PR-XXXX-XXXX. Pass with claim_token."
    },
    "access_code": {
      "type": "string",
      "maxLength": 16,
      "description": "The access_code from the access_request block of a refusal, PR-XXXX-XXXX. Polled with the API key this session already holds."
    },
    "claim_token": {
      "type": "string",
      "maxLength": 64,
      "description": "The claim_token from request_access, prc_..."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "briefing"
  ],
  "properties": {
    "date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Historical date in YYYY-MM-DD format (tier-gated: Free=30d, Basic=from Jan 2025, Pro=all)"
    },
    "entity": {
      "type": "string",
      "pattern": "^[A-Za-z0-9.-]{1,12}$",
      "description": "Ticker or code for a parameterised entity briefing: NVDA, 7203, or a CIK, with briefing=equities.company"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "markdown",
      "description": "Response format: markdown (human-readable, default) or json (structured data)"
    },
    "briefing": {
      "enum": [
        "btc.quick-check",
        "btc.context",
        "macro.snapshot",
        "cross.correlations",
        "btc.pulse",
        "btc.grid-stress",
        "btc.momentum",
        "macro.liquidity",
        "btc.on-chain",
        "cross.breadth",
        "btc.miner-survival",
        "btc.full",
        "btc.factors",
        "cross.regime",
        "fx.liquidity",
        "btc.energy",
        "btc.treasury",
        "btc.etf-flows"
      ],
      "type": "string",
      "description": "Briefing ID to fetch"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "verbose": {
      "type": "boolean",
      "description": "Include detailed endpoint descriptions and data coverage info. Defaults to false."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "metric"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "markdown",
      "description": "Response format: markdown (default) or json"
    },
    "metric": {
      "enum": [
        "bitcoin-price",
        "bitcoin-market-cap",
        "bitcoin-volume-24h",
        "bitcoin-change-24h",
        "bitcoin-dominance",
        "bitcoin-hash-rate",
        "bitcoin-difficulty",
        "bitcoin-tx-count",
        "bitcoin-tx-volume",
        "bitcoin-active-addresses",
        "fed-balance",
        "m2-supply",
        "treasury-10y",
        "rrp",
        "eur-usd",
        "cny-usd",
        "yield-curve",
        "tga",
        "treasury-3mo",
        "treasury-2y",
        "treasury-5y",
        "treasury-30y",
        "breakeven-5y",
        "breakeven-10y",
        "t5yifr",
        "mortgage-30y",
        "t10y3m-spread",
        "auction-bid-to-cover-10y",
        "auction-bid-to-cover-30y",
        "indirect-bidder-pct",
        "dealer-takedown-pct",
        "next-treasury-auction-days",
        "fed-funds-rate",
        "ecb-deposit-rate",
        "boj-policy-rate",
        "fed-ecb-spread",
        "fed-boj-spread",
        "carry-trade-returns-proxy",
        "carry-trade-velocity-1d",
        "mortgage-treasury-spread",
        "iwm-spy-credit-spread",
        "spy-vxx-correlation-30d",
        "regime-stability-flag",
        "jpy-usd",
        "oil-brent",
        "oil-wti",
        "ovx",
        "real-rate-10y",
        "gld-gdx-ratio",
        "copper-gold-ratio",
        "slv-sil-ratio",
        "gdxj-gdx-ratio",
        "gold-silver-ratio",
        "brent-wti-spread",
        "etf-gld-1h-velocity",
        "etf-cper-1h-velocity",
        "etf-uso-1h-velocity",
        "etf-uup-velocity-1h",
        "crude-oil-stocks",
        "natgas-storage",
        "oil-inventory-zscore",
        "natgas-storage-zscore",
        "ecb-boj-spread",
        "etf-gld-volume",
        "etf-uso-volume",
        "etf-uup-volume",
        "etf-gld-volume-zscore-30d",
        "etf-uso-volume-zscore-30d",
        "etf-uup-volume-zscore-30d",
        "net-liquidity",
        "hash-ribbon",
        "mvrv-proxy",
        "etf-spy",
        "etf-qqq",
        "etf-iwm",
        "etf-vxx",
        "etf-uup",
        "etf-gld",
        "etf-gdx",
        "etf-gdxj",
        "etf-slv",
        "etf-sil",
        "etf-uso",
        "etf-ung",
        "etf-cper",
        "etf-weat",
        "etf-tlt",
        "etf-ibit",
        "etf-fxe",
        "etf-fxy",
        "usdt-market-cap",
        "usdt-dominance",
        "btc-price-200d-ma",
        "btc-price-200d-distance",
        "btc-etf-net-flow",
        "btc-etf-cumulative-flow",
        "btc-etf-aum",
        "btc-etf-ibit-flow",
        "btc-etf-fbtc-flow",
        "btc-etf-gbtc-flow",
        "btc-etf-other-flow",
        "btc-etf-ibit-aum",
        "btc-etf-fbtc-aum",
        "btc-etf-bitb-aum",
        "btc-etf-arkb-aum",
        "btc-etf-btco-aum",
        "btc-etf-ezbc-aum",
        "btc-etf-brrr-aum",
        "btc-etf-hodl-aum",
        "btc-etf-btcw-aum",
        "btc-etf-gbtc-aum",
        "btc-etf-btc-aum",
        "bitcoin-price-1h-change-pct",
        "raw-hashprice-tick",
        "on-chain-velocity-30d",
        "bitcoin-volume-zscore-30d",
        "btc-perp-oi-contracts",
        "btc-perp-positioning-regime",
        "btc-perp-funding-zscore-30d"
      ],
      "type": "string",
      "description": "Metric name to fetch"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "tier": {
      "enum": [
        "free",
        "basic",
        "pro"
      ],
      "type": "string",
      "description": "Filter briefings by subscription tier (free, basic, or pro). Returns all tiers if omitted."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "search": {
      "type": "string",
      "maxLength": 100,
      "description": "Search term to filter metrics by name or description"
    },
    "category": {
      "enum": [
        "bitcoin",
        "macro",
        "calculated",
        "treasury",
        "eth",
        "eth-onchain",
        "equities",
        "commodities",
        "fx",
        "bonds",
        "crypto"
      ],
      "type": "string",
      "description": "Filter by metric category"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "purpose": {
      "type": "string",
      "maxLength": 200,
      "description": "One line on what the key is for; shown to the human on the approval page."
    },
    "client_name": {
      "type": "string",
      "maxLength": 64,
      "description": "The app or agent asking, for example \"Claude Desktop\" or \"portfolio-bot\". Becomes the key name: \"Agent: <client_name>\"."
    }
  },
  "additionalProperties": false
}