Work with Results

A successful request returns a JSON object with the time series for each investment that returned data, plus metadata about the request. This page explains how to read the response, how to parse the observations, and how to check for investments that returned no data.

Response Structure

The response has two top-level properties.

Each object in investments contains the following properties.

Each timeSeries object contains the following properties.

The following response is for a request for daily-price with two investments, where one identifier returned no data.

{
  "investments": [
    {
      "identifiers": {
        "performanceId": "0P00000CSY"
      },
      "timeSeries": {
        "categories": ["performance"],
        "dataPoint": "daily-price",
        "data": [
          { "date": "2025-01-02", "value": 0.71234 },
          { "date": "2025-01-03", "value": 0.72108 }
        ]
      },
      "metadata": {
        "exchangeCountry": "USA",
        "domicile": "USA",
        "baseCurrency": "USD"
      }
    }
  ],
  "metadata": {
    "messages": {
      "investments": [
        { "id": "0P000PPP6Q", "idType": "performanceId" }
      ],
      "type": "Warning",
      "message": "Lookup : Invalid investments.",
      "code": "404.common.125"
    },
    "requestId": "f1a94c72-3d08-4b61-9e21-2c85da673f10",
    "time": "2025-10-30T14:25:47.883412Z"
  }
}

Identify the Observation Type

The shape of the data array depends on the data point. Use the dataPoint value in each timeSeries object to decide how to parse it.

Univariate observations are returned by most data points. Each observation contains a date and a single value.

{
  "data": [
    { "date": "2025-01-31", "value": 0.02341 },
    { "date": "2025-02-28", "value": -0.01204 }
  ]
}

Multivariate observations are returned by daily-ohlcv only. Each observation contains a date and separate fields for the open, high, low and closing price and the volume.

{
  "data": [
    {
      "date": "2025-01-02",
      "dailyOpenPrice": 5.17,
      "dailyHighPrice": 5.21,
      "dailyLowPrice": 5.14,
      "dailyClosingPrice": 5.19,
      "dailyVolume": 130918
    }
  ]
}

You choose the observation type by choosing the data point, not through a request parameter. For more detail, see Core Concepts.

Match Results to Investments

Investments that can't be matched don't return data, so the investments array may contain fewer entries than the values you sent in ids. Match each result to your request using the values in identifiers, not the position of the entry in the array.

Handle Unmatched Investments

A 200 status code doesn't guarantee that every requested investment returned data. If the API can't match an identifier to an investment, it returns no data for that investment and lists it in metadata.messages. Always check this object when you process a response.

metadata.messages contains the following properties.

The following warning codes can be returned.

For how identifiers and lookup filters are matched, see Specify Investments.

Response Metadata

The top-level metadata object also contains the following properties.

Handle Errors

A request that fails returns an error response instead of time series data. The response contains the following properties.

{
  "statusCode": 400,
  "errorCode": "400.timeSeries.009",
  "message": "Invalid frequency 'm' for datapoint 'daily-closing-price'.",
  "requestId": "c63e7f6c-b52d-42c3-9d1b-4a4b4ac05f3c"
}

For the meaning of each error and how to resolve it, see Errors and Troubleshooting.