Skip to main content
GET
/
v1
/
stock
/
screener
Stock Screener
curl --request GET \
  --url https://api.aries.com/v1/stock/screener \
  --header 'Authorization: Bearer <token>'
[
  {
    "security": {
      "id": "sec_XaL6mg",
      "company_id": "com_qzEByJ",
      "stock_exchange_id": "sxg_ozMr9y",
      "exchange": null,
      "exchange_mic": null,
      "name": "Microsoft Corporation",
      "code": null,
      "currency": null,
      "ticker": "MSFT",
      "composite_ticker": "MSFT:US",
      "figi": "BBG000BPHFS9",
      "composite_figi": null,
      "share_class_figi": null,
      "primary_listing": null
    },
    "data": [
      {
        "tag": "pricetoearnings",
        "number_value": 24.2204,
        "text_value": null
      },
      {
        "tag": "marketcap",
        "number_value": 2888569710564,
        "text_value": null
      }
    ]
  }
]
orderColumn must be one of: marketcap, pricetoearnings, roe, volume, open_price, dilutedeps, cashandequivalents. Other values (e.g. pricetobook) default to marketcap. orderDirection defaults to desc.

Response

Success returns 200 OK with a JSON array. Each element has:
  • security — Identity and metadata: id, company_id, stock_exchange_id, exchange, exchange_mic, name, code, currency, ticker, composite_ticker, figi, composite_figi, share_class_figi, primary_listing (fields may be null).
  • data — Array of screened tag values: each object has tag (e.g. pricetoearnings, marketcap), number_value, and text_value (one of which may be null).
[
  {
    "security": {
      "id": "sec_XaL6mg",
      "company_id": "com_qzEByJ",
      "stock_exchange_id": "sxg_ozMr9y",
      "exchange": null,
      "exchange_mic": null,
      "name": "Microsoft Corporation",
      "code": null,
      "currency": null,
      "ticker": "MSFT",
      "composite_ticker": "MSFT:US",
      "figi": "BBG000BPHFS9",
      "composite_figi": null,
      "share_class_figi": null,
      "primary_listing": null
    },
    "data": [
      { "tag": "pricetoearnings", "number_value": 24.2204, "text_value": null },
      { "tag": "marketcap", "number_value": 2888569710564.0, "text_value": null }
    ]
  }
]

Examples

Market cap + P/E filter

GET /v1/stock/screener?marketCapMin=1000000000&peRatioMin=5&peRatioMax=25&pageSize=100&orderColumn=marketcap&orderDirection=desc

ROE + EPS filter

GET /v1/stock/screener?roeMin=0.15&epsMin=1&pageSize=50&orderColumn=roe&orderDirection=desc

P/B + P/S ratio (value stocks)

GET /v1/stock/screener?pbRatioMin=0.5&pbRatioMax=3&psRatioMax=5&pageSize=100&orderColumn=marketcap&orderDirection=asc

Volume + open price range

GET /v1/stock/screener?volumeMin=500000&openPriceMin=10&openPriceMax=100&pageSize=100&orderColumn=volume&orderDirection=desc

Cash-rich companies

GET /v1/stock/screener?cashAndEquivalentsMin=1000000000&marketCapMin=5000000000&pageSize=50&orderColumn=cashandequivalents&orderDirection=desc

State filter (e.g. Texas)

GET /v1/stock/screener?state=Texas&marketCapMin=100000000&pageSize=50&orderColumn=marketcap&orderDirection=desc

Primary only, large page size

GET /v1/stock/screener?marketCapMin=500000000&roeMin=0.1&pageSize=500&orderColumn=marketcap&orderDirection=desc&primaryOnly=true

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

peRatioMin
number

P/E ratio >= value (Intrinio: pricetoearnings)

peRatioMax
number

P/E ratio <= value

peRatioAbove
number

P/E ratio > value

peRatioBelow
number

P/E ratio < value

roeMin
number

Return on equity >= value (e.g. 0.2 = 20%)

roeMax
number
roeAbove
number
roeBelow
number
marketCapMin
number

Market cap >= value (e.g. 1000000000)

marketCapMax
number
marketCapAbove
number
marketCapBelow
number
openPriceMin
number

Open price >= value

openPriceMax
number
openPriceAbove
number
openPriceBelow
number
volumeMin
integer

Volume >= value

volumeMax
integer
volumeAbove
integer
volumeBelow
integer
cashAndEquivalentsMin
number
cashAndEquivalentsMax
number
cashAndEquivalentsAbove
number
cashAndEquivalentsBelow
number
epsMin
number

Diluted EPS >= value

epsMax
number
epsAbove
number
epsBelow
number
pbRatioMin
number

P/B ratio >= value

pbRatioMax
number
pbRatioAbove
number
pbRatioBelow
number
psRatioMin
number

P/S ratio >= value

psRatioMax
number
psRatioAbove
number
psRatioBelow
number
state
string

State (exact match, e.g. Texas)

descriptionContains
string

Company description contains text

pageSize
integer

Results per request (1–50000)

Required range: 1 <= x <= 50000
orderColumn
enum<string>

Sort by this field. Allowed: marketcap, pricetoearnings, roe, volume, open_price, dilutedeps, cashandequivalents. Unsupported values (e.g. pricetobook) default to marketcap.

Available options:
marketcap,
pricetoearnings,
roe,
volume,
open_price,
dilutedeps,
cashandequivalents
orderDirection
enum<string>

Sort direction. Defaults to desc when omitted or invalid.

Available options:
asc,
desc
primaryOnly
boolean

Return only primary listings

Response

Array of screened securities; each item has security (id, ticker, name, etc.) and data (array of tag, number_value, text_value)

security
object

Security identity and metadata

data
object[]

Screened data-tag values (e.g. pricetoearnings, marketcap)