Skip to main content
POST
Run correlation

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Prometheus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Body

application/json
seriesA
object
required

A series for the correlation engine. Valid companyId / indicatorCode / symbol values come from GET /api/v1/correlation/catalog — anything not in the catalog returns 404.

seriesB
object
required

A series for the correlation engine. Valid companyId / indicatorCode / symbol values come from GET /api/v1/correlation/catalog — anything not in the catalog returns 404.

control
object

A series for the correlation engine. Valid companyId / indicatorCode / symbol values come from GET /api/v1/correlation/catalog — anything not in the catalog returns 404.

options
object

Response

OK

The response is of type object.