Get Financial Metrics Screener

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

import requests

url = "https://data-tools.prd.arrays.org/api/v1/stocks/screener/financial-metrics"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://data-tools.prd.arrays.org/api/v1/stocks/screener/financial-metrics', 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/screener/financial-metrics",
  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/screener/financial-metrics"

	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/screener/financial-metrics")

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": [
    {
      "date": "2024-01-15",
      "metric": "PE_RATIO",
      "snapshot_time": 1705276800,
      "symbol": "AAPL",
      "value": 28.5
    }
  ],
  "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 Financial Metrics Screener

OpenAPI JSON Spec Retrieve stocks filtered by financial metrics at a specific snapshot time. Returns stocks matching the specified metric type and value ranges. Includes companies with a market cap exceeding $5B at the time of the data snapshot. Please note that current market caps may fluctuate below this threshold due to recent price changes.

Overview: This endpoint filters stocks based on financial metrics from the stock_financial_metrics table. The snapshot parameter is a Unix timestamp (seconds) that will be used directly for querying data.

Financial Metrics from stock_financial_metrics table (28 metrics):

PIT (Point-in-Time) Balance Sheet Ratios (5 metrics):

CURRENT_RATIO_MRQ: Current Ratio (Most Recent Quarter) - Current assets divided by current liabilities
DEBT_TO_ASSETS_MRQ: Debt-to-Assets Ratio (MRQ) - Total debt divided by total assets
DEBT_TO_EQUITY_MRQ: Debt-to-Equity Ratio (MRQ) - Total debt divided by total equity
NET_WORKING_CAPITAL_MRQ: Net Working Capital (MRQ) - Current assets minus current liabilities
QUICK_RATIO_MRQ: Quick Ratio (MRQ) - (Current assets - Inventory) divided by current liabilities

TTM (Trailing Twelve Months) Base Metrics (3 metrics):

REVENUE_TTM: Revenue TTM - Total revenue over trailing twelve months
NET_INCOME_TTM: Net Income TTM - Net income over trailing twelve months
EPS_TTM: Earnings Per Share TTM - Earnings per share over trailing twelve months

TTM Profitability Ratios (3 metrics):

ROA_TTM: Return on Assets TTM - Net income divided by average total assets
ROE_TTM: Return on Equity TTM - Net income divided by average shareholder equity
ROIC_TTM: Return on Invested Capital TTM - Net operating profit after tax divided by invested capital

MRQ Margin Ratios (4 metrics):

GROSS_MARGIN_MRQ: Gross Margin (MRQ) - (Revenue - Cost of Goods Sold) / Revenue
OPERATING_MARGIN_MRQ: Operating Margin (MRQ) - Operating income / Revenue
NET_MARGIN_MRQ: Net Margin (MRQ) - Net income / Revenue
FCF_MARGIN_MRQ: Free Cash Flow Margin (MRQ) - Free cash flow / Revenue

Other MRQ Ratios (1 metric):

RD_TO_SALES_TTM: Research & Development to Sales (TTM) - R&D expenses / Revenue

Revenue Growth Metrics (4 metrics):

REVENUE_GROWTH_QOQ: Revenue Growth Quarter-over-Quarter
REVENUE_GROWTH_YOY_QUARTERLY: Revenue Growth Year-over-Year (Quarterly)
REVENUE_GROWTH_YOY_TTM: Revenue Growth Year-over-Year (TTM)
REVENUE_GROWTH_YOY_ANNUAL: Revenue Growth Year-over-Year (Annual)

EPS Growth Metrics (4 metrics):

EPS_GROWTH_QOQ: EPS Growth Quarter-over-Quarter
EPS_GROWTH_YOY_QUARTERLY: EPS Growth Year-over-Year (Quarterly)
EPS_GROWTH_YOY_TTM: EPS Growth Year-over-Year (TTM)
EPS_GROWTH_YOY_ANNUAL: EPS Growth Year-over-Year (Annual)

FCF Growth Metrics (4 metrics):

FCF_GROWTH_QOQ: Free Cash Flow Growth Quarter-over-Quarter
FCF_GROWTH_YOY_QUARTERLY: FCF Growth Year-over-Year (Quarterly)
FCF_GROWTH_YOY_TTM: FCF Growth Year-over-Year (TTM)
FCF_GROWTH_YOY_ANNUAL: FCF Growth Year-over-Year (Annual)

Price-Related Metrics (7 metrics):

MARKET_CAP: Market Capitalization - Total market value of a company’s outstanding shares
PE_RATIO: Price-to-Earnings Ratio - Market price per share divided by earnings per share
PS_RATIO: Price-to-Sales Ratio - Market capitalization divided by revenue
PB_RATIO: Price-to-Book Ratio - Market price per share divided by book value per share
DIVIDEND_YIELD: Dividend Yield - Annual dividend per share divided by market price per share
ENTERPRISE_VALUE: Enterprise Value - Market capitalization + Total debt - Cash and cash equivalents
EV_EBITDA_RATIO: EV/EBITDA Ratio - Enterprise value divided by EBITDA

Filtering:

Use range_min to filter for stocks where the metric value is greater than or equal to the minimum
Use range_max to filter for stocks where the metric value is less than or equal to the maximum
Both filters can be used together to create a range
If neither filter is provided, all stocks matching the metric type will be returned

Response Format: Returns an array of stocks with their symbol, snapshot time (Unix timestamp seconds, UTC), metric type, and metric value. ETF behavior: financial-metrics returns NO ETFs. The 7 valuation metrics (MARKET_CAP, PE_RATIO, PS_RATIO, PB_RATIO, DIVIDEND_YIELD, ENTERPRISE_VALUE, EV_EBITDA_RATIO) are skipped for ETFs — they require shares-outstanding / SEC fundamentals an ETF does not have (ETF MARKET_CAP via AUM is a follow-up). The 28 fundamental metrics (REVENUE_TTM, ROE_TTM, etc.) likewise return no ETFs. Query ETFs via the technical-metrics endpoint.

GET

stocks

screener

financial-metrics

Get Financial Metrics Screener

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

import requests

url = "https://data-tools.prd.arrays.org/api/v1/stocks/screener/financial-metrics"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://data-tools.prd.arrays.org/api/v1/stocks/screener/financial-metrics', 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/screener/financial-metrics",
  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/screener/financial-metrics"

	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/screener/financial-metrics")

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": [
    {
      "date": "2024-01-15",
      "metric": "PE_RATIO",
      "snapshot_time": 1705276800,
      "symbol": "AAPL",
      "value": 28.5
    }
  ],
  "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

snapshot

integer

required

Snapshot time (Unix timestamp in seconds, used directly for querying)

metric_type

string

required

Metric type. Valid values: CURRENT_RATIO_MRQ, DEBT_TO_ASSETS_MRQ, DEBT_TO_EQUITY_MRQ, EPS_GROWTH_QOQ, EPS_GROWTH_YOY_ANNUAL, EPS_GROWTH_YOY_QUARTERLY, EPS_GROWTH_YOY_TTM, EPS_TTM, FCF_GROWTH_QOQ, FCF_GROWTH_YOY_ANNUAL, FCF_GROWTH_YOY_QUARTERLY, FCF_GROWTH_YOY_TTM, FCF_MARGIN_MRQ, GROSS_MARGIN_MRQ, NET_INCOME_TTM, NET_MARGIN_MRQ, NET_WORKING_CAPITAL_MRQ, OPERATING_MARGIN_MRQ, QUICK_RATIO_MRQ, RD_TO_SALES_TTM, REVENUE_GROWTH_QOQ, REVENUE_GROWTH_YOY_ANNUAL, REVENUE_GROWTH_YOY_QUARTERLY, REVENUE_GROWTH_YOY_TTM, REVENUE_TTM, ROA_TTM, ROE_TTM, ROIC_TTM, MARKET_CAP, PE_RATIO, PS_RATIO, PB_RATIO, DIVIDEND_YIELD, ENTERPRISE_VALUE, EV_EBITDA_RATIO

range_min

number<float64>

Minimum value filter (optional). Returns only stocks where metric value >= range_min

range_max

number<float64>

Maximum value filter (optional). Returns only stocks where metric value <= range_max

order_by

string

Sort order (optional). Valid values: ASC (ascending), DESC (descending). Defaults to DESC

Response

Successfully retrieved financial metrics screener data

data

object[]

Show child attributes

error

object

Show child attributes

metadata

any

pagination

any

request_id

string

success

boolean