---
title: "Rolling surprise index per currency"
method: GET
path: "/rest/api/v1/projects/{projectId}/economicCalendar/surpriseIndex"
tags: ["News API"]
---

# Rolling surprise index per currency

`GET /rest/api/v1/projects/{projectId}/economicCalendar/surpriseIndex`

## Request

- Base URL: `https://api.metacopier.io`
- URL: `https://api.metacopier.io/rest/api/v1/projects/{projectId}/economicCalendar/surpriseIndex`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/metacopier/apis/metacopier-api/docs/rest/api/v1/projects/:projectId/economicCalendar/surpriseIndex/get.ts> (a function with typed inputs; its response is checked against the schema)

Whether a currency's data has been beating or missing expectations lately. The sign is direction corrected, so a rise in unemployment counts as a miss and not as a beat.

## Path parameters

- `projectId` string, uuid, required

## Query parameters

- `currencies` string
- `days` integer

## Response `200`

OK

- SurpriseIndexDTO
  - `currencies` SurpriseIndexEntryDTO[]: Strongest currency first
    - `averageSigma` number, double: Mean directional sigma. Positive means the data has been beating expectations.
    - `beats` integer
    - `currencyCode` string
    - `misses` integer
    - `samples` integer: Releases that carried a usable sigma in the window
  - `fromUtc` string, date-time
  - `toUtc` string, date-time

## Changes

- **2026-08-30** `69d2d39c695e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/metacopier/apis/metacopier-api/changes/rest/api/v1/projects/:projectId/economicCalendar/surpriseIndex/get.md)

---

[API](https://skmtc.dev/metacopier/apis/metacopier-api.md) - [All operations](https://skmtc.dev/metacopier/apis/metacopier-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metacopier/apis/metacopier-api/revisions/2ac6d7461345?raw)