Skip to main content
GET
/
openapi
/
v1
/
fx
/
correlation
FX correlation matrix
curl --request GET \
  --url https://api.hayinsights.com/openapi/v1/fx/correlation \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "statusCode": 200,
  "data": {
    "window": "90d",
    "asOf": "2026-06-19",
    "samples": 89,
    "symbols": [
      "DXY",
      "EUR/USD",
      "XAU/USD"
    ],
    "matrix": [
      [
        1,
        -0.87,
        -0.52
      ],
      [
        -0.87,
        1,
        0.62
      ],
      [
        -0.52,
        0.62,
        1
      ]
    ]
  },
  "meta": {
    "timestamp": "2026-06-19T08:50:42.363Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Your HayInsights API key (prefixed apk_). Create and manage keys in the HayInsights dashboard (Account → API keys).

Send it in the X-API-Key header on every request to /openapi/v1/*. Which data domains you may access and your request quota are both governed by the subscription plan attached to the key — see the Plans & features and Rate limits guides.

Query Parameters

​
assets
string

Comma-separated list of assets / symbols to include (e.g. DXY,EUR/USD,XAU/USD). Returns the default symbol set when omitted.

Example:

"DXY,EUR/USD,XAU/USD"

Response

FX correlation matrix.

Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via allOf) and adds a typed data property.

​
success
boolean
required

Always true for a successful response.

Example:

true

​
statusCode
integer
required

Mirrors the HTTP status code.

Example:

200

​
data
object
required

Rolling correlation matrix across FX, crypto and gold benchmarks over the look-back window. matrix[i][j] is the Pearson correlation between symbols[i] and symbols[j].

​
meta
object

Response metadata. Always present; timestamp is the server time the response was generated.