> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mindcase.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Finviz Metrics API

> Finviz stock metrics for US-listed stocks with company name, index membership, market cap class, valuation, growth, margins and ownership. Pass the US tickers to look up.

`POST /v1/data/finviz/metrics/run`

**Pricing:** $0.0025 per metric ($2.50 per 1,000).

## Request

Send the inputs under `params`. Only the keys below are accepted; any other key returns `422 invalid_params`.

**tickers** `string[]` *required*

One or more US stock tickers, e.g. AAPL or BRK-B. Finviz covers US-listed companies only: non-US listings (RELIANCE.NS) and market indices (NIFTY, SENSEX) are refused with a clear error. One request reads them all.

## Example

```bash cURL theme={null}
curl -X POST "https://api.mindcase.co/v1/data/finviz/metrics/run?wait=true" \
  -H "Authorization: Bearer $MINDCASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "params": {
    "tickers": [
      "AAPL",
      "MSFT",
      "JPM"
    ]
  }
}'
```

```python Python theme={null}
import os, requests

r = requests.post(
    "https://api.mindcase.co/v1/data/finviz/metrics/run",
    params={"wait": "true"},
    headers={"Authorization": f"Bearer {os.environ['MINDCASE_API_KEY']}"},
    json={"params": {
    "tickers": [
        "AAPL",
        "MSFT",
        "JPM"
    ]
}},
)
job = r.json()
rows = job.get("data", [])  # if job["status"] == "running", poll /v1/jobs/{job_id}/results
```

```javascript Node.js theme={null}
const r = await fetch("https://api.mindcase.co/v1/data/finviz/metrics/run?wait=true", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MINDCASE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ params: {
  "tickers": [
    "AAPL",
    "MSFT",
    "JPM"
  ]
} }),
});
const job = await r.json();
const rows = job.data ?? []; // if job.status === "running", poll /v1/jobs/{job_id}/results
```

## Response fields

Each row in `data` is one metric, keyed by these fields.

| Field | Name | Type |
| - | - | - |
| `ticker` | Ticker | text |
| `companyName` | Company Name | text |
| `indexMembership` | Index Membership | text |
| `marketCapClass` | Market Cap Class | text |
| `price` | Price | currency |
| `marketCap` | Market Cap | currency |
| `enterpriseValue` | Enterprise Value | currency |
| `peRatio` | Pe Ratio | number |
| `forwardPeRatio` | Forward Pe Ratio | number |
| `pegRatio` | Peg Ratio | number |
| `priceToSales` | Price To Sales | number |
| `priceToBook` | Price To Book | number |
| `priceToFreeCashFlow` | Price To Free Cash Flow | number |
| `evToEbitda` | Ev To Ebitda | number |
| `epsTtm` | Eps Ttm | currency |
| `epsNextQuarter` | Eps Next Quarter | currency |
| `epsGrowthThisYearPercent` | Eps Growth This Year Percent | number |
| `epsGrowthNextYearPercent` | Eps Growth Next Year Percent | number |
| `salesTtm` | Sales Ttm | currency |
| `netIncomeTtm` | Net Income Ttm | currency |
| `grossMarginPercent` | Gross Margin Percent | number |
| `operatingMarginPercent` | Operating Margin Percent | number |
| `profitMarginPercent` | Profit Margin Percent | number |
| `roePercent` | Roe Percent | number |
| `roaPercent` | Roa Percent | number |
| `roicPercent` | Roic Percent | number |
| `debtToEquity` | Debt To Equity | number |
| `longTermDebtToEquity` | Long Term Debt To Equity | number |
| `currentRatio` | Current Ratio | number |
| `quickRatio` | Quick Ratio | number |
| `dividendYieldPercent` | Dividend Yield Percent | number |
| `payoutRatioPercent` | Payout Ratio Percent | number |
| `analystRecommendation` | Analyst Recommendation | number |
| `targetPrice` | Target Price | currency |
| `beta` | Beta | number |
| `sharesOutstanding` | Shares Outstanding | number |
| `insiderOwnershipPercent` | Insider Ownership Percent | number |
| `institutionalOwnershipPercent` | Institutional Ownership Percent | number |
| `shortFloatPercent` | Short Float Percent | number |
| `employees` | Employees | integer |
| `earningsDate` | Earnings Date | text |
| `ipoDate` | Ipo Date | text |
| `website` | Website | url |
| `description` | Description | text |
| `finvizUrl` | Finviz URL | url |

## Example response

Abridged: long text and lists are shortened.

```json theme={null}
{
  "job_id": "7f3a1c2e-0b9d-4c55-9a51-3f2e8d1b6a40",
  "agent": "finviz/metrics",
  "status": "completed",
  "row_count": 1,
  "truncated": false,
  "data": [
    {
      "pegRatio": 4,
      "epsTtm": 8.97,
      "operatingMarginPercent": 33.01,
      "forwardPeRatio": 32.73,
      "quickRatio": 0.94,
      "evToEbitda": 29.18,
      "epsGrowthThisYearPercent": 5.17,
      "peRatio": 38.15,
      "insiderOwnershipPercent": 0.12,
      "institutionalOwnershipPercent": 68.97,
      "marketCap": 4975380000000,
      "longTermDebtToEquity": 0.64,
      "shortFloatPercent": 0.91,
      "enterpriseValue": 5004420000000,
      "priceToBook": 44.39,
      "earningsDate": "Nov 02 AMC",
      "priceToSales": 10.39,
      "employees": 167000,
      "roePercent": 142.26,
      "website": "http://www.apple.com",
      "currentRatio": 1.02,
      "analystRecommendation": 2.27,
      "targetPrice": 339.72,
      "finvizUrl": "https://finviz.com/quote.ashx?t=AAPL",
      "profitMarginPercent": 27.6
    }
  ]
}
```

## Related APIs

For live prices use [`yahoo-finance/prices`](https://docs.mindcase.co/apis/yahoo-finance/prices); for reported financials use [`sec/financials-as-reported`](https://docs.mindcase.co/apis/sec/financials-as-reported).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.