cryptodataapi-com Event / Catalyst Regime API

openapi: 3.2.0
info:
  title: Crypto Data Event / Catalyst Regime API
  description: 'Real-time crypto market intelligence API. Built for AI agents: gasless USDC payments via x402 protocol, one-call onboarding, and 180+ endpoints for prices, derivatives, funding, and sentiment.'
  version: '2026-10-28'
servers:
- url: https://cryptodataapi.com
tags:
- name: Event / Catalyst Regime
  description: Forward catalyst calendar — token unlocks, macro prints, depegs — with event-risk scoring.
paths:
  /api/v1/event/regime:
    get:
      tags:
      - Event / Catalyst Regime
      summary: Get Event Regime
      description: 'Forward catalyst calendar — dated token unlocks, macro prints, and depegs.


        The main Event/Catalyst payload: every catalyst in the next ``window_days``

        (default 7) with its directional bias and magnitude, plus the market-wide

        Event Risk score. Unlocks bias short (supply overhang); macro prints are

        ``risk_flag`` (the surprise is unknown ahead of time); major depegs bias

        short. Use `/event/calendar` for richer filtering, `/event/regime/score` for

        the composite alone.


        **Partly backfillable** — unlocks / macro / depeg replay from schedule + price

        history; the ``sector_rotation`` sidecar on `/event/regime/score` is

        live-only and lands null on backfilled days.'
      operationId: get_event_regime_api_v1_event_regime_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: window_days
        in: query
        required: false
        schema:
          type: integer
          maximum: 30
          minimum: 1
          description: Forward horizon for the calendar
          default: 7
          title: Window Days
        description: Forward horizon for the calendar
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventRegimeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/event/regime/score:
    get:
      tags:
      - Event / Catalyst Regime
      summary: Get Event Regime Score
      description: 'Market-wide Event Risk composite (0-100) + sub-scores + live-only sidecars.


        Baseline 0 (event risk is absence-by-default). Bands: dormant (<10), quiet

        (10-29), elevated (30-54), heavy (55-79), critical (≥80). Composite =

        0.40·unlock + 0.25·macro + 0.35·depeg, re-normalized over available feeds

        (``partial``/``inputs_available`` flag which were live). The

        ``sector_rotation`` (CoinGecko categories) sidecar is live-only and

        excluded from the composite.'
      operationId: get_event_regime_score_api_v1_event_regime_score_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventRegimeScoreResponse'
      security:
      - APIKeyHeader: []
  /api/v1/event/calendar:
    get:
      tags:
      - Event / Catalyst Regime
      summary: Get Event Calendar
      description: 'Filterable / queryable forward catalyst calendar (up to 30d out).


        The query surface for the calendar: narrow by catalyst ``type``, affected

        ``symbol``, ``bias``, ``min_magnitude``, and ``window_days``.'
      operationId: get_event_calendar_api_v1_event_calendar_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: type
        in: query
        required: false
        schema:
          title: Type
          enum:
          - unlock
          - macro_print
          - depeg
          - mint
          - null
          type:
          - string
          - 'null'
      - name: window_days
        in: query
        required: false
        schema:
          type: integer
          maximum: 30
          minimum: 1
          default: 30
          title: Window Days
      - name: symbol
        in: query
        required: false
        schema:
          description: Filter to catalysts affecting this ticker
          title: Symbol
          type:
          - string
          - 'null'
        description: Filter to catalysts affecting this ticker
      - name: bias
        in: query
        required: false
        schema:
          title: Bias
          enum:
          - long
          - short
          - neutral
          - risk_flag
          - null
          type:
          - string
          - 'null'
      - name: min_magnitude
        in: query
        required: false
        schema:
          type: number
          maximum: 1.0
          minimum: 0.0
          default: 0.0
          title: Min Magnitude
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventRegimeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-price-usdc: '0.008'
      x-payment: x402
      x-payment-route-id: event_calendar
  /api/v1/event/regime/refresh:
    post:
      tags:
      - Event / Catalyst Regime
      summary: Refresh Event Regime
      description: Force recompute the Event / Catalyst regime cache (Pro+).
      operationId: refresh_event_regime_api_v1_event_regime_refresh_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventRegimeRefreshResponse'
      security:
      - APIKeyHeader: []
  /api/v1/event/regime/{symbol}:
    get:
      tags:
      - Event / Catalyst Regime
      summary: Get Event Regime Symbol
      description: Per-symbol catalyst overlay — pending catalysts (≤7d) + net bias (Pro+).
      operationId: get_event_regime_symbol_api_v1_event_regime__symbol__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          title: Symbol
        example: BTC
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSymbolOverlayResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    EventRegimeScoreResponse:
      properties:
        as_of:
          type: string
          title: As Of
        event_risk_score:
          type: number
          title: Event Risk Score
          description: 0-100; baseline 0 (absence = no event risk)
        band:
          type: string
          enum:
          - dormant
          - quiet
          - elevated
          - heavy
          - critical
          title: Band
        unlock_subscore:
          type: number
          title: Unlock Subscore
          default: 0.0
        macro_subscore:
          type: number
          title: Macro Subscore
          default: 0.0
        depeg_subscore:
          type: number
          title: Depeg Subscore
          default: 0.0
        events_7d:
          type: integer
          title: Events 7D
          default: 0
        events_30d:
          type: integer
          title: Events 30D
          default: 0
        counts:
          additionalProperties: true
          type: object
          title: Counts
        partial:
          type: boolean
          title: Partial
          default: false
        inputs_available:
          items:
            type: string
          type: array
          title: Inputs Available
          default: []
        sector_rotation:
          title: Sector Rotation
          description: Live-only CoinGecko sector leaders/laggards; null on backfill
          additionalProperties: true
          type:
          - object
          - 'null'
      type: object
      required:
      - as_of
      - event_risk_score
      - band
      title: EventRegimeScoreResponse
      description: Market-wide Event Risk composite + sub-scores + live-only sidecars.
    EventPendingItem:
      properties:
        event_type:
          type: string
          enum:
          - unlock
          - macro_print
          - depeg
          - mint
          title: Event Type
        date:
          type: string
          title: Date
        days_until:
          type: integer
          title: Days Until
        bias:
          type: string
          enum:
          - long
          - short
          - neutral
          - risk_flag
          - mixed
          title: Bias
        magnitude:
          title: Magnitude
          type:
          - number
          - 'null'
      type: object
      required:
      - event_type
      - date
      - days_until
      - bias
      title: EventPendingItem
    EventSymbolOverlayResponse:
      properties:
        symbol:
          type: string
          title: Symbol
        hl_symbol:
          title: Hl Symbol
          type:
          - string
          - 'null'
        pending:
          items:
            $ref: '#/components/schemas/EventPendingItem'
          type: array
          title: Pending
          default: []
        net_bias:
          type: string
          enum:
          - long
          - short
          - neutral
          - risk_flag
          - mixed
          title: Net Bias
          default: neutral
        net_magnitude:
          type: number
          title: Net Magnitude
          default: 0.0
        nearest_event_days:
          title: Nearest Event Days
          type:
          - integer
          - 'null'
        timestamp:
          type: string
          title: Timestamp
      type: object
      required:
      - symbol
      - timestamp
      title: EventSymbolOverlayResponse
      description: Per-symbol catalyst overlay (Pro+).
    EventRegimeRefreshResponse:
      properties:
        refreshed:
          type: boolean
          title: Refreshed
        events:
          type: integer
          title: Events
        event_risk_score:
          type: number
          title: Event Risk Score
        timestamp:
          type: string
          title: Timestamp
      type: object
      required:
      - refreshed
      - events
      - event_risk_score
      - timestamp
      title: EventRegimeRefreshResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    EventCatalystModel:
      properties:
        event_type:
          type: string
          enum:
          - unlock
          - macro_print
          - depeg
          - mint
          title: Event Type
        title:
          type: string
          title: Title
        date:
          type: string
          title: Date
        days_until:
          type: integer
          title: Days Until
        symbols:
          items:
            type: string
          type: array
          title: Symbols
          default: []
        bias:
          type: string
          enum:
          - long
          - short
          - neutral
          - risk_flag
          - mixed
          title: Bias
        magnitude:
          title: Magnitude
          type:
          - number
          - 'null'
        unlocked_value_usd:
          title: Unlocked Value Usd
          type:
          - number
          - 'null'
        pct_of_fdv:
          title: Pct Of Fdv
          type:
          - number
          - 'null'
        deviation_bps:
          title: Deviation Bps
          type:
          - number
          - 'null'
        macro_class:
          title: Macro Class
          type:
          - string
          - 'null'
        delta_usd:
          title: Delta Usd
          type:
          - number
          - 'null'
        pct_of_supply:
          title: Pct Of Supply
          type:
          - number
          - 'null'
        source:
          type: string
          title: Source
          default: ''
      type: object
      required:
      - event_type
      - title
      - date
      - days_until
      - bias
      title: EventCatalystModel
    EventRegimeResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/EventCatalystModel'
          type: array
          title: Items
        count:
          type: integer
          title: Count
        window_days:
          type: integer
          title: Window Days
        event_risk_score:
          type: number
          title: Event Risk Score
        band:
          type: string
          enum:
          - dormant
          - quiet
          - elevated
          - heavy
          - critical
          title: Band
        timestamp:
          type: string
          title: Timestamp
      type: object
      required:
      - items
      - count
      - window_days
      - event_risk_score
      - band
      - timestamp
      title: EventRegimeResponse
      description: Forward event calendar — the main /event/regime payload.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key