v1

latestOpenAPI 3.0.32026-07-24190128.9 KB

Graph Performance API

Fetch and compare historical performance for smallcases on a single time axis.

scids[] required. Array query parameters use repeated params, for example: ?scids[]=SCSB_0001&scids[]=SCSB_0002.

get/v1/{gateway}/engine/graph/performance

Path parameters

gatewaystring required

Gateway identifier.

Query parameters

scids[]string[]

Smallcase IDs, scids[] required.

stockBenchmarkIds[]string[]

Stock or index benchmarks to overlay.

duration'1y' | '3y' | '5y' | 'max'

Performance duration. Defaults to max.

Headers

x-gateway-authtokenstring required

Auth token for the logged-in user.

x-gateway-apisecretstring required

Your gateway API secret.

Response

Performance graph data. Each requested asset ID is returned as a top-level key inside data.

successboolean required

Whether the request completed successfully.

errorsstring[] required

Errors returned for the request.

Example response

{
  "data": {
    "durations": [
      "1m",
      "1y",
      "3y",
      "5y",
      "max"
    ],
    "currentDuration": "1m"
  }
}
All 19 operations