Insights-as-a-Service

Access pre-computed metrics on financial datasets.

Beta

This API is currently in beta.

Prerequisites: Authentication & API Setup

---

Available Datasets

Dataset ID	Name	Description	Tier
wcb	World Central Banks	Monetary policy metrics from 19 central banks	Pro

---

Available Metrics

Metric	Description	Formula	Range
uncertainty	Uncertainty in communication	(uncertain - certain) / total	-1 to 1
stance	Monetary policy stance	(hawkish - dovish) / (total - irrelevant)	-1 to 1

Interpretation:

• Uncertainty: Positive = uncertain, Negative = certain
• Stance: Positive = hawkish, Negative = dovish

---

Endpoints

List Datasets

GET /v1/metrics

curl -H "x-api-key: $ZQ_API_KEY" $ZQ_BASE_URL/v1/metrics

---

Get Document Metrics

GET /v1/metrics/{dataset_id}/documents

Parameter	Type	Description
bank_name	string	Filter by central bank
year	integer	Filter by year
metric	string	all, uncertainty, stance
limit	integer	Max rows (default: 1000)
offset	integer	Pagination offset
format	string	json or csv

Examples:

# Get Fed metrics
curl -H "x-api-key: $ZQ_API_KEY" \
  "$ZQ_BASE_URL/v1/metrics/wcb/documents?bank_name=federal_reserve_system"

# Filter by year
curl -H "x-api-key: $ZQ_API_KEY" \
  "$ZQ_BASE_URL/v1/metrics/wcb/documents?year=2024&limit=100"

# Download as CSV
curl -H "x-api-key: $ZQ_API_KEY" \
  "$ZQ_BASE_URL/v1/metrics/wcb/documents?format=csv" -o metrics.csv

Response:

{
  "dataset": "wcb",
  "items": [
    {
      "DOCUMENT_ID": "fed_minutes_2024_01",
      "CENTRAL_BANK": "federal_reserve_system",
      "YEAR": "2024",
      "uncertainty": -0.5789,
      "stance": 0.3023
    }
  ],
  "page": {
    "limit": 10,
    "offset": 0,
    "total": 1250,
    "has_more": true
  }
}

---

Get Summary Statistics

GET /v1/metrics/{dataset_id}/summary

curl -H "x-api-key: $ZQ_API_KEY" \
  "$ZQ_BASE_URL/v1/metrics/wcb/summary?bank_name=federal_reserve_system"

Response:

{
  "dataset": "wcb",
  "total_items": 450,
  "metrics": {
    "uncertainty": {"avg": -0.234, "min": -0.89, "max": 0.45},
    "stance": {"avg": 0.156, "min": -0.72, "max": 0.81}
  }
}

---

Available Central Banks

Value	Central Bank
federal_reserve_system	Federal Reserve (USA)
european_central_bank	European Central Bank
bank_of_england	Bank of England
bank_of_japan	Bank of Japan
peoples_bank_of_china	People's Bank of China
reserve_bank_of_australia	Reserve Bank of Australia
reserve_bank_of_india	Reserve Bank of India
bank_of_mexico	Bank of Mexico
central_bank_of_brazil	Central Bank of Brazil
swiss_national_bank	Swiss National Bank
bank_negara_malaysia	Bank Negara Malaysia
monetary_authority_of_singapore	Monetary Authority of Singapore
central_bank_of_chile	Central Bank of Chile
central_bank_of_egypt	Central Bank of Egypt
central_bank_of_the_philippines	Central Bank of the Philippines
central_bank_of_the_russian_federation	Central Bank of Russia
central_bank_of_china_taiwan	Central Bank of China (Taiwan)
central_bank_republic_of_turkey	Central Bank of Turkey
czech_national_bank	Czech National Bank

---

Support

Email: support@zettaquant.ai