Get Financial Metrics Screener Time Range

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

{
  "data": [
    {
      "date": "2024-01-01",
      "items": [
        {
          "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>"
    ]
  },
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

Stock

Get Financial Metrics Screener Time Range

OpenAPI JSON Spec Retrieve stocks filtered by financial metrics over a time range. Returns stocks matching the specified metric type and value range, grouped by date.

Overview: This endpoint filters stocks based on financial metrics from stock_financial_metrics table and stock_metrics table over a specified time range. Results are grouped by date (YYYY-MM-DD format).

Financial Metrics: Same as the snapshot endpoint - supports all financial metric types (CURRENT_RATIO_MRQ, PE_RATIO, MARKET_CAP, etc.)

Data Limitation:

The underlying data table for financial metrics has a limit of 1000 records per day
This means each date in the response can contain at most 1000 stock records

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 (up to 1000 per day)

Limit Parameter:

Use limit to further limit the maximum number of results returned per day (optional, defaults to no limit)
This is useful for pagination or when you only need the top N results per day

Response Format: Returns an array of date-grouped data items. Each item contains a date (YYYY-MM-DD format) and an array of stocks with their symbol, snapshot time (Unix timestamp seconds, UTC), metric type, and metric value for that date. 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

timerange

Get Financial Metrics Screener Time Range

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

{
  "data": [
    {
      "date": "2024-01-01",
      "items": [
        {
          "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>"
    ]
  },
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

Authorizations

X-API-Key

string

header

required

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

Query Parameters

start_time

integer

required

Start time (Unix timestamp in seconds, UTC)

end_time

integer

required

End time (Unix timestamp in seconds, UTC)

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

limit

integer

Maximum number of results per day (optional, defaults to no limit)

Response

Successfully retrieved financial metrics screener time range data

data

object[]

Show child attributes

error

object

Show child attributes

pagination

any

request_id

string

success

boolean

Get Financial Metrics Screener Get Technical Metrics Screener