Get Stock KPI Values

curl --request GET \
  --url https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "calendar_end_date": "<string>",
      "calendar_quarter": "<string>",
      "calendar_year": 123,
      "created_at": "2024-01-15T10:00:00Z",
      "fiscal_quarter": "<string>",
      "fiscal_year": 123,
      "metrics": [
        {}
      ],
      "period_id": "<string>",
      "period_type": "<string>",
      "symbol": "<string>",
      "updated_at": "2024-01-15T10:00:00Z"
    }
  ],
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

Stock

Get Stock KPI Values

Feature Overview

OpenAPI JSON Spec Retrieve KPI (Key Performance Indicators) values for a specific stock by fiscal year and quarter.

Main Use Cases

Financial Analysis: Analyze company KPI trends over time
Investment Research: Review key performance metrics for investment decisions
Quarterly Comparison: Compare KPIs across different periods
Performance Tracking: Monitor company performance indicators

Parameters

Parameter	Type	Required	Description
symbol	string	Yes	Stock symbol (e.g., AAPL, NVDA)
fiscal_year	int	Yes	Fiscal year
fiscal_quarter	string	Yes	Fiscal quarter: Q1, Q2, Q3, Q4 for quarterly; FY for annual

Response Data Description

Each KPI record includes:

symbol: Stock symbol
periodType: Period type (annual/quarterly)
periodId: Unique period identifier
calendarEndDate: Report date (YYYY-MM-DD)
calendarYear: Calendar year
calendarQuarter: Calendar quarter
fiscalYear: Fiscal year
fiscalQuarter: Fiscal quarter
createdAt: Ingestion time — when we first stored this record (RFC3339)
values: KPI values as JSON object

Usage Examples

Get Q2 FY2024 KPIs for Apple: ?symbol=AAPL&fiscal_year=2024&fiscal_quarter=Q2
Get full year FY2024 KPIs for NVIDIA: ?symbol=NVDA&fiscal_year=2024&fiscal_quarter=FY

Important Notes

Symbol parameter must be uppercase
Fiscal quarter values: Q1, Q2, Q3, Q4 (quarterly data), or FY (annual data)

GET

stocks

company

kpi

Get Stock KPI Values

curl --request GET \
  --url https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://data-tools.prd.arrays.org/api/v1/stocks/company/kpi")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "calendar_end_date": "<string>",
      "calendar_quarter": "<string>",
      "calendar_year": 123,
      "created_at": "2024-01-15T10:00:00Z",
      "fiscal_quarter": "<string>",
      "fiscal_year": 123,
      "metrics": [
        {}
      ],
      "period_id": "<string>",
      "period_type": "<string>",
      "symbol": "<string>",
      "updated_at": "2024-01-15T10:00:00Z"
    }
  ],
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

Authorizations

X-API-Key

string

header

required

API Key authentication. Example: "your-api-key-here"

Query Parameters

symbol

string

required

Stock symbol (uppercase, e.g., AAPL)

fiscal_year

integer

required

Fiscal year

fiscal_quarter

enum<string>

required

Fiscal quarter (Q1/Q2/Q3/Q4 for quarterly, FY for annual)

Available options:

Q1,

Q2,

Q3,

Q4,

FY

Response

Successfully retrieved KPI values

data

object[]

Show child attributes

error

object

Show child attributes

metadata

any

pagination

any

request_id

string

success

boolean