cryptodataapi-com Security / Black Swan Regime API

openapi: 3.2.0
info:
  title: Crypto Data Security / Black Swan 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: Security / Black Swan Regime
  description: Hack/exploit event feed and the security regime score.
paths:
  /api/v1/security/regime:
    get:
      tags:
      - Security / Black Swan Regime
      summary: Get Security Regime
      description: 'Recent security events — confirmed hacks/exploits + live stablecoin depegs.


        The main Security/Black Swan payload: every security event in the last

        ``window_days`` (default 10) with its affected symbols, severity, and acute

        short bias, plus the market-wide Security Stress score. Use

        `/security/regime/score` for the composite alone.


        **Partly backfillable** — the hack / flow-stress / depeg subscores replay from

        the dated DefiLlama hacks registry, archived net flows, and price history; the

        ``security_headlines`` RSS sidecar on `/security/regime/score` is live-only and

        lands null on backfilled days.'
      operationId: get_security_regime_api_v1_security_regime_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: window_days
        in: query
        required: false
        schema:
          type: integer
          maximum: 10
          minimum: 1
          description: Lookback for recent security events
          default: 10
          title: Window Days
        description: Lookback for recent security events
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRegimeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/security/regime/score:
    get:
      tags:
      - Security / Black Swan Regime
      summary: Get Security Regime Score
      description: 'Market-wide Security Stress composite (0-100) + sub-scores + live sidecar.


        Baseline 0 (security stress is absence-by-default). Bands: dormant (<10),

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

        0.45·hack + 0.30·flow + 0.25·depeg, re-normalized over available feeds

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

        ``security_headlines`` sidecar (classified rekt/SlowMist RSS) is live-only and

        excluded from the composite.'
      operationId: get_security_regime_score_api_v1_security_regime_score_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRegimeScoreResponse'
      security:
      - APIKeyHeader: []
  /api/v1/security/events:
    get:
      tags:
      - Security / Black Swan Regime
      summary: Get Security Events
      description: 'Filterable recent security-events list (up to 10d back).


        Narrow by event ``type``, affected ``symbol``, and ``min_severity``.'
      operationId: get_security_events_api_v1_security_events_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: type
        in: query
        required: false
        schema:
          title: Type
          enum:
          - hack
          - depeg
          - null
          type:
          - string
          - 'null'
      - name: window_days
        in: query
        required: false
        schema:
          type: integer
          maximum: 10
          minimum: 1
          default: 10
          title: Window Days
      - name: symbol
        in: query
        required: false
        schema:
          description: Filter to events affecting this ticker
          title: Symbol
          type:
          - string
          - 'null'
        description: Filter to events affecting this ticker
      - name: min_severity
        in: query
        required: false
        schema:
          type: number
          maximum: 1.0
          minimum: 0.0
          default: 0.0
          title: Min Severity
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRegimeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/security/regime/refresh:
    post:
      tags:
      - Security / Black Swan Regime
      summary: Refresh Security Regime
      description: Force recompute the Security / Black Swan regime cache (Pro+).
      operationId: refresh_security_regime_api_v1_security_regime_refresh_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRegimeRefreshResponse'
      security:
      - APIKeyHeader: []
  /api/v1/security/regime/{symbol}:
    get:
      tags:
      - Security / Black Swan Regime
      summary: Get Security Regime Symbol
      description: Per-symbol security overlay — implicating events + acute bias (Pro+).
      operationId: get_security_regime_symbol_api_v1_security_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/SecuritySymbolOverlayResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SecurityRegimeResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SecurityEventModel'
          type: array
          title: Items
        count:
          type: integer
          title: Count
        window_days:
          type: integer
          title: Window Days
        security_stress_score:
          type: number
          title: Security Stress Score
        band:
          type: string
          enum:
          - dormant
          - quiet
          - elevated
          - heavy
          - critical
          title: Band
        timestamp:
          type: string
          title: Timestamp
      type: object
      required:
      - items
      - count
      - window_days
      - security_stress_score
      - band
      - timestamp
      title: SecurityRegimeResponse
      description: Recent security events + market-wide stress — the main /security payload.
    SecurityEventModel:
      properties:
        event_type:
          type: string
          enum:
          - hack
          - depeg
          title: Event Type
        title:
          type: string
          title: Title
        date:
          type: string
          title: Date
        days_ago:
          type: integer
          title: Days Ago
        symbols:
          items:
            type: string
          type: array
          title: Symbols
          default: []
        bias:
          type: string
          enum:
          - short
          - long
          - neutral
          - mixed
          title: Bias
        severity:
          title: Severity
          type:
          - number
          - 'null'
        amount_usd:
          title: Amount Usd
          type:
          - number
          - 'null'
        deviation_bps:
          title: Deviation Bps
          type:
          - number
          - 'null'
        classification:
          title: Classification
          type:
          - string
          - 'null'
        technique:
          title: Technique
          type:
          - string
          - 'null'
        target_type:
          title: Target Type
          type:
          - string
          - 'null'
        chains:
          title: Chains
          items:
            type: string
          type:
          - array
          - 'null'
        source:
          type: string
          title: Source
          default: ''
      type: object
      required:
      - event_type
      - title
      - date
      - days_ago
      - bias
      title: SecurityEventModel
    SecurityPendingItem:
      properties:
        event_type:
          type: string
          enum:
          - hack
          - depeg
          title: Event Type
        date:
          type: string
          title: Date
        days_ago:
          type: integer
          title: Days Ago
        bias:
          type: string
          enum:
          - short
          - long
          - neutral
          - mixed
          title: Bias
        severity:
          title: Severity
          type:
          - number
          - 'null'
      type: object
      required:
      - event_type
      - date
      - days_ago
      - bias
      title: SecurityPendingItem
    SecurityRegimeRefreshResponse:
      properties:
        refreshed:
          type: boolean
          title: Refreshed
        events:
          type: integer
          title: Events
        security_stress_score:
          type: number
          title: Security Stress Score
        timestamp:
          type: string
          title: Timestamp
      type: object
      required:
      - refreshed
      - events
      - security_stress_score
      - timestamp
      title: SecurityRegimeRefreshResponse
    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
    SecuritySymbolOverlayResponse:
      properties:
        symbol:
          type: string
          title: Symbol
        hl_symbol:
          title: Hl Symbol
          type:
          - string
          - 'null'
        events:
          items:
            $ref: '#/components/schemas/SecurityPendingItem'
          type: array
          title: Events
          default: []
        acute_bias:
          type: string
          enum:
          - short
          - long
          - neutral
          - mixed
          title: Acute Bias
          default: neutral
        max_severity:
          type: number
          title: Max Severity
          default: 0.0
        timestamp:
          type: string
          title: Timestamp
      type: object
      required:
      - symbol
      - timestamp
      title: SecuritySymbolOverlayResponse
      description: Per-symbol security overlay (Pro+).
    SecurityRegimeScoreResponse:
      properties:
        as_of:
          type: string
          title: As Of
        security_stress_score:
          type: number
          title: Security Stress Score
          description: 0-100; baseline 0 (absence = all clear)
        band:
          type: string
          enum:
          - dormant
          - quiet
          - elevated
          - heavy
          - critical
          title: Band
        hack_subscore:
          type: number
          title: Hack Subscore
          default: 0.0
        flow_subscore:
          type: number
          title: Flow Subscore
          default: 0.0
        depeg_subscore:
          type: number
          title: Depeg Subscore
          default: 0.0
        hacks_in_window:
          type: integer
          title: Hacks In Window
          default: 0
        largest_hack_usd:
          title: Largest Hack Usd
          type:
          - number
          - 'null'
        worst_flow_symbol:
          title: Worst Flow Symbol
          type:
          - string
          - 'null'
        worst_flow_zscore:
          title: Worst Flow Zscore
          type:
          - number
          - 'null'
        events_count:
          type: integer
          title: Events Count
          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: []
        security_headlines:
          title: Security Headlines
          description: Live-only classified RSS advisories (rekt/SlowMist); null on backfill
          additionalProperties: true
          type:
          - object
          - 'null'
      type: object
      required:
      - as_of
      - security_stress_score
      - band
      title: SecurityRegimeScoreResponse
      description: Market-wide Security Stress composite + sub-scores + live-only sidecar.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key