/finviz/groups

POST /api/finviz/groups

Price: 5 credits

Get aggregated market statistics grouped by sector, industry, country, or capitalization

How to use it

Get aggregate statistics for each group when stocks are grouped by sector, industry, country, or capitalization tier. Each group includes the number of constituent stocks, total market cap, average dividend yield, valuation multiples, EPS and sales growth, debt ratios, short float, analyst recommendation, multi-horizon performance, and volume. Percentage fields are decimals.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• group_by string — Aggregation dimension (default: "sector"; one of: "sector", "industry", "country", "capitalization")

Response

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

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.