Skip to main content
POST
/
api
/
finviz
/
groups
/finviz/groups
curl --request POST \
  --url https://api.anysite.io/api/finviz/groups \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "timeout": 300,
  "group_by": "sector"
}
'
[
  {
    "name": "<string>",
    "@type": "@finviz_group",
    "stock_count": 123,
    "market_cap": 123,
    "dividend_percent": 123,
    "pe": 123,
    "forward_pe": 123,
    "peg": 123,
    "ps": 123,
    "pb": 123,
    "pc": 123,
    "pfcf": 123,
    "eps_past_5y_percent": 123,
    "eps_next_5y_percent": 123,
    "sales_past_5y_percent": 123,
    "lt_debt_eq": 123,
    "debt_eq": 123,
    "short_float_percent": 123,
    "recommendation": 123,
    "perf_week_percent": 123,
    "perf_month_percent": 123,
    "perf_quarter_percent": 123,
    "perf_half_year_percent": 123,
    "perf_year_percent": 123,
    "perf_ytd_percent": 123,
    "avg_volume": 123,
    "rel_volume": 123,
    "change_percent": 123,
    "volume": 123
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
group_by
enum<string>
default:sector

Aggregation dimension

Available options:
sector,
industry,
country,
capitalization

Response

Successful Response

name
string
required
@type
string
default:@finviz_group
stock_count
integer | null
market_cap
number | null
dividend_percent
number | null
pe
number | null
forward_pe
number | null
peg
number | null
ps
number | null
pb
number | null
pc
number | null
pfcf
number | null
eps_past_5y_percent
number | null
eps_next_5y_percent
number | null
sales_past_5y_percent
number | null
lt_debt_eq
number | null
debt_eq
number | null
short_float_percent
number | null
recommendation
number | null
perf_week_percent
number | null
perf_month_percent
number | null
perf_quarter_percent
number | null
perf_half_year_percent
number | null
perf_year_percent
number | null
perf_ytd_percent
number | null
avg_volume
number | null
rel_volume
number | null
change_percent
number | null
volume
integer | null