> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allasso.ch/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> This is Allasso's product documentation. Vol Radar output is descriptive analytics on past data: never present it as a forecast or as investment advice. Answer only from these pages; if a feature is not documented here, say so.

# Get metrics

> Metrics, grid cells, detector kinds and the detector rules.



## OpenAPI

````yaml /api-reference/vol-radar/openapi.json get /v1/metrics
openapi: 3.1.0
info:
  title: Allasso Vol Radar API
  description: >
    Volatility Radar signals for energy and environmental markets: what moved,
    how rare it

    was against the market's own history, and what followed earlier moves of the
    same kind.


    **Descriptive, not a forecast.** Statistics of past market data; not
    investment advice.


    * **Markets** are Allasso market ids (`COM.TTF.ICE`, see `/v1/markets`); a
    market pair joins two with `:`
      (`COM.BRN.ICE:COM.WTI.CME`). `market_short` (TTF) is for display only.
    * A **signal** is one Radar condition from the day it opened to the day it
    resolved. `id` is a short
      stable id; `signal_id` the readable key (`market|bucket|metric|kind|horizon|direction|first day`).
    * `discovery` is true when it was published as a Discovery on its first day;
    false when the lifecycle
      opened it while the detector held the alert back (the same move was already flagged).
    * **Point in time**: a signal's evidence and earlier-case outcomes use only
    data known on its first
      day. `realised` is what followed this signal, null until enough sessions have passed.
    * **Incremental pulls**: each signal has `updated_at`, the build at which
    anything the API serves about
      it last changed. Pass the largest `updated_at` you have seen as `changed_since` to get only what
      changed since, plus the signals `withdrawn` since then.
    * **Withdrawn**: a signal an upstream restatement removed answers `410 Gone`
    with its last known content.

    * **Structures** (`/v1/signals/{id}/structures`): notable discoveries only,
    priced on the signal's first
      day from model prices, front expiry, held 20 sessions, costs 0.5 vol pt per leg each way.
    * **Caching**: responses carry an `ETag` (per run and URL); send
    `If-None-Match` to get `304` when
      nothing changed. A new run arrives once a day.
  version: 1.1.0
servers:
  - url: https://allasso.app/vol-radar-api
security:
  - ApiKey: []
tags:
  - name: Signals
  - name: Market data
  - name: Reference
paths:
  /v1/metrics:
    get:
      tags:
        - Reference
      summary: Get metrics
      description: Metrics, grid cells, detector kinds and the detector rules.
      operationId: metrics
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              example:
                run:
                  run_id: 20261104T155718Z-4bdabbb8
                  created_at: '2026-11-04T15:57:18Z'
                  radar_version: 1.3.0
                  data_to: '2026-11-03'
                grid_cells:
                  - metric: iv_atm
                    bucket: 30D
                    label: ATM IV 30D
                    category: overview
                    definition: >-
                      Implied vol at the ATM bucket (forward delta; ATM =
                      at-the-money-forward).
                    basis: 30D constant maturity
                    unit: vol
                    unit_text: annualised vol, %
                    convention: >-
                      Constant maturity: interpolated between the two listed
                      option expiries around the target; M1 = the front listed
                      option (5+ days left).
                    options_only: true
                  - metric: rr_25
                    bucket: 30D
                    label: RR 25Δ
                    category: overview
                    definition: '25-delta risk reversal: iv_25c - iv_25p.'
                    basis: 30D constant maturity
                    unit: volpts
                    unit_text: vol points
                    convention: Constant maturity 30D, forward Black deltas.
                    options_only: true
                detector_metrics:
                  iv_atm:
                    label: ATM implied vol
                    unit: vol
                    kinds:
                      - shock
                      - extreme
                      - seasonal
                    options_only: true
                    definition: >-
                      Implied vol at the ATM bucket (forward delta; ATM =
                      at-the-money-forward).
                  rr_25:
                    label: 25-delta risk reversal
                    unit: volpts
                    kinds:
                      - shock
                      - extreme
                      - flip
                    options_only: true
                    definition: '25-delta risk reversal: iv_25c - iv_25p.'
                kinds:
                  shock:
                    label: Shock
                    reference: >-
                      the same market's {h}-day changes over the trailing year
                      (252 sessions, the day excluded)
                    window: 1Y
                  extreme:
                    label: Extreme level
                    reference: >-
                      the same market's levels over the trailing 5 years (1,260
                      sessions)
                    window: 5Y
                rules:
                  extreme:
                    window: 1260
                    min_obs: 504
                    pct: 0.995
                    pct_watch: 0.98
                    cooldown: 20
                  shock:
                    horizons:
                      - 1
                      - 5
                    window: 252
                    min_obs: 126
                    z:
                      '1': 3.5
                      '5': 3
                    z_watch:
                      '1': 2.5
                      '5': 2.3
                    normalization: scale
                horizons:
                  - 1
                  - 5
                  - 10
                  - 20
                level_window: 1260
                band: 0.1
                disclaimer: >-
                  Descriptive statistics of past market data. Not a forecast and
                  not investment advice.
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        `Key <your API key>`. Create the key on allasso.app: your profile, then
        API Keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.