Finnhub API

https://finnhub.io/docs/api
Admin
Finnhub provides real-time financial data APIs for stocks, forex, and crypto, enabling developers to...
Tokens:453,029
Snippets:6,434
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Price Metrics Response Example

Source: https://finnhub.io/docs/api/company-dps-estimates

Example JSON response structure for company price metrics.

```json
{
  "data": {
    "100DayEMA": 295.7694,
    "100DaySMA": 319.2297,
    "10DayAverageTradingVolume": 53717320,
    "10DayEMA": 247.4641,
    "10DaySMA": 247.372,
    "14DayRSI": 34.0517,
    "1MonthHigh": 314.67,
    "1MonthHighDate": "2022-08-16",
    "50DayEMA": 277.482,
    "50DaySMA": 288.313,
    "52WeekHigh": 414.5,
    "52WeekHighDate": "2021-11-04",
    "52WeekLow": 206.86,
    "52WeekLowDate": "2022-05-24",
    "5DayEMA": 245.8814,
    "ytdPriceReturn": 10.1819
  },
  "symbol": "TSLA"
}
```

--------------------------------

### Sector Metrics Response Example

Source: https://finnhub.io/docs/api/company-dps-estimates

Example JSON response structure for sector metrics data.

```json
{
  "data": [
    {
      "metrics": {
        "assetTurnoverAnnual": {
          "a": 0.7245,
          "m": 0.5426
        },
        "assetTurnoverTTM": {
          "a": 0.7254,
          "m": 0.5463
        },
      },
      "sector": "Communication Services"
    },
    {
      "metrics": {
        "currentDividendYieldTTM": {
          "a": 30.9763,
          "m": 2.09
        },
        "currentEv/freeCashFlowAnnual": {
          "a": 286.4793,
          "m": 19.8488
        },
      },
      "sector": "Consumer Discretionary"
    }
  ],
  "region": "Asia_Ocenia"
}
```

--------------------------------

### Global Filings Filter Response Example

Source: https://finnhub.io/docs/api/quote

Example JSON response structure for the global filings filter endpoint.

```json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
[
    {
        "id": "SEC",
        "name": "US SEC Edgar Filings"
    },
    {
        "id": "TR",
        "name": "Event Transcripts"
    },
    {
        "id": "SEDAR",
        "name": "Canada SEDAR Filings"
    },
    {
        "id": "CH",
        "name": "UK Companies House Filings"
    },
    {
        "id": "PR",
        "name": "Press Releases"
    },
    {
        "id": "RR",
        "name": "Research Reports"
    },
    {
        "id": "GF",
        "name": "Global Filings"
    }
]
```

--------------------------------

### GET /news

Source: https://finnhub.io/docs/api/stock-uspto-patent

Retrieves the latest market news.

```APIDOC
## GET /news

### Description
Get latest market news.

### Method
GET

### Endpoint
/news

### Parameters
#### Query Parameters
- **category** (string) - Required - News category (general, forex, crypto, merger).
- **minId** (number) - Optional - Use this field to get only news after this ID. Default to 0.

### Response
#### Success Response (200)
- **category** (string) - News category.
- **datetime** (number) - Published time in UNIX timestamp.
- **headline** (string) - News headline.
- **id** (number) - News ID.
- **image** (string) - Thumbnail image URL.
- **related** (string) - Related stocks and companies mentioned in the article.
- **source** (string) - News source.
- **summary** (string) - News summary.
- **url** (string) - URL of the original article.

### Response Example
[
  {
    "category": "technology",
    "datetime": 1596589501,
    "headline": "Square surges after reporting 64% jump in revenue",
    "id": 5085164,
    "image": "https://image.cnbcfm.com/api/v1/image/105569283.jpg",
    "related": "",
    "source": "CNBC",
    "summary": "Shares of Square soared on Tuesday.",
    "url": "https://www.cnbc.com/2020/08/04/square-sq-earnings-q2-2020.html"
  }
]
```

--------------------------------

### GET /mutual-fund/eet

Source: https://finnhub.io/docs/api/crypto-exchanges

Retrieves EET data for EU funds.

```APIDOC
## GET /mutual-fund/eet

### Description
Get EET data for EU funds. Premium access is required.

### Method
GET

### Endpoint
/mutual-fund/eet

### Parameters
#### Query Parameters
- **isin** (string) - Required - ISIN of the fund.

### Response
#### Success Response (200)
- **data** (object) - EET data.
- **isin** (string) - ISIN of the fund.

### Response Example
{
   "data":{
      "boardGenderDiversityConsidered":true,
      "carbonFootprintScope123Considered":false
   },
   "isin":"LU2036931686"
}
```

--------------------------------

### Sample JSON Response for Estimates

Source: https://finnhub.io/docs/api/revenue-breakdown

Example structure of the JSON response returned by the estimates endpoints.

```json
{
  "data": [
    {
      "epsAvg": 2.65,
      "epsHigh": 2.98,
      "epsLow": 2.05,
      "numberAnalysts": 35,
      "period": "2020-06-30",
      "quarter": 3,
      "year": 2020
    },
    {
      "epsAvg": 2.52,
      "epsHigh": 3.02,
      "epsLow": 2.21,
      "numberAnalysts": 34,
      "period": "2020-03-31",
      "quarter": 2,
      "year": 2020
    }
  ],
  "freq": "quarterly",
  "symbol": "AAPL"
}
```

```json
{
  "data": [
    {
      "numberAnalysts": 31,
      "period": "2020-06-30",
      "ebitdaAvg": 58800500000,
      "ebitdaHigh": 64060000000,
      "ebitdaLow": 54072000000,
      "quarter": 3,
      "year": 2020
    },
    {
      "numberAnalysts": 31,
      "period": "2020-03-31",
      "ebitdaAvg": 61287300000,
      "ebitdaHigh": 66557000000,
      "ebitdaLow": 54871000000,
      "quarter": 2,
      "year": 2020
    }
  ],
  "freq": "quarterly",
  "symbol": "AAPL"
}
```

--------------------------------

### GET /mutual-fund/eet-pai

Source: https://finnhub.io/docs/api/crypto-exchanges

Retrieves EET PAI data for EU funds.

```APIDOC
## GET /mutual-fund/eet-pai

### Description
Get EET PAI data for EU funds. Premium access is required.

### Method
GET

### Endpoint
/mutual-fund/eet-pai

### Parameters
#### Query Parameters
- **isin** (string) - Required - ISIN of the fund.

### Response
#### Success Response (200)
- **data** (object) - EET PAI data.
- **isin** (string) - ISIN of the fund.

### Response Example
{
   "data":{
      "airPollutantEmissionsCoveredHoldings":27.94263,
      "airPollutantEmissionsEligibleHoldings":490.89858
   },
   "isin":"LU2036931686"
}
```

--------------------------------

### Retrieve Company Basic Financials with Python

Source: https://finnhub.io/docs/api/company-dps-estimates

Initializes the Finnhub client and fetches all available financial metrics for a specified stock symbol.

```python
import finnhub
finnhub_client = finnhub.Client(api_key="")

print(finnhub_client.company_basic_financials('AAPL', 'all'))
```

--------------------------------

### Run Pattern Recognition with Python

Source: https://finnhub.io/docs/api/company-dps-estimates

Initializes the Finnhub client and executes the pattern recognition algorithm for a specific symbol and timeframe.

```python
1
2
3
4
5
import finnhub
finnhub_client = finnhub.Client(api_key="")

print(finnhub_client.pattern_recognition('AAPL', 'D'))


```

--------------------------------

### FCF Estimates API Response Example

Source: https://finnhub.io/docs/api/company-dps-estimates

Example JSON response structure for an FCF estimates query.

```json
{
  "data": [
    {
      "numberAnalysts": 31,
      "period": "2020-06-30",
      "fcfAvg": 58800500000,
      "fcfHigh": 64060000000,
      "fcfLow": 54072000000,
      "quarter": 3,
      "year": 2020
    },
    {
      "numberAnalysts": 31,
      "period": "2020-03-31",
      "fcfAvg": 61287300000,
      "fcfHigh": 66557000000,
      "fcfLow": 54871000000,
      "quarter": 2,
      "year": 2020
    }
  ],
  "freq": "quarterly",
  "symbol": "AAPL"
}
```

--------------------------------

### DPS Estimates API Response Example

Source: https://finnhub.io/docs/api/company-dps-estimates

Example JSON response structure for a DPS estimates query.

```json
{
  "data": [
    {
      "numberAnalysts": 31,
      "period": "2020-06-30",
      "dpsAvg": 0.82,
      "dpsHigh": 0.9,
      "dpsLow": 0.74,
      "quarter": 3,
      "year": 2020
    },
    {
      "numberAnalysts": 31,
      "period": "2020-03-31",
      "dpsAvg": 0.77,
      "dpsHigh": 0.88,
      "dpsLow": 0.7,
      "quarter": 2,
      "year": 2020
    }
  ],
  "freq": "quarterly",
  "symbol": "AAPL"
}
```

--------------------------------

### Bid-Ask Response Structure

Source: https://finnhub.io/docs/api/bank-branch-api

Example JSON response containing bid/ask prices, volumes, and a reference timestamp.

```json
1
2
3
4
5
6
7
{
  "a": 338.65,
  "av": 2,
  "b": 338.61,
  "bv": 2,
  "t": 1591995678874
}
```

--------------------------------

### Sample JSON Response for Basic Financials

Source: https://finnhub.io/docs/api/company-dps-estimates

Example structure of the JSON response containing series data and key financial metrics.

```json
{
   "series": {
    "annual": {
      "currentRatio": [
        {
          "period": "2019-09-28",
          "v": 1.5401
        },
        {
          "period": "2018-09-29",
          "v": 1.1329
        }
      ],
      "salesPerShare": [
        {
          "period": "2019-09-28",
          "v": 55.9645
        },
        {
          "period": "2018-09-29",
          "v": 53.1178
        }
      ],
      "netMargin": [
        {
          "period": "2019-09-28",
          "v": 0.2124
        },
        {
          "period": "2018-09-29",
          "v": 0.2241
        }
      ]
    }
  },
  "metric": {
    "10DayAverageTradingVolume": 32.50147,
    "52WeekHigh": 310.43,
    "52WeekLow": 149.22,
    "52WeekLowDate": "2019-01-14",
    "52WeekPriceReturnDaily": 101.96334,
    "beta": 1.2989,
  },
  "metricType": "all",
  "symbol": "AAPL"
}
```

--------------------------------

### Sample JSON response for stock upgrades/downgrades

Source: https://finnhub.io/docs/api/company-dps-estimates

Example of the JSON structure returned by the API containing analyst actions and grades.

```json
[
  {
    "symbol": "BYND",
    "gradeTime": 1567728000,
    "company": "DA Davidson",
    "fromGrade": "",
    "toGrade": "Underperform",
    "action": "init"
  },
  {
    "symbol": "BYND",
    "gradeTime": 1566259200,
    "company": "JP Morgan",
    "fromGrade": "Neutral",
    "toGrade": "Overweight",
    "action": "up"
  },
  {
    "symbol": "BYND",
    "gradeTime": 1564704000,
    "company": "Bank of America",
    "fromGrade": "",
    "toGrade": "Neutral",
    "action": "reit"
  }
]
```

--------------------------------

### GET /stock/insider-sentiment

Source: https://finnhub.io/docs/api/company-ebitda-estimates

Get insider sentiment data for US companies. The MSPR ranges from -100 for the most negative to 100 for the most positive.

```APIDOC
## GET /stock/insider-sentiment

### Description
Get insider sentiment data for US companies. The MSPR ranges from -100 for the most negative to 100 for the most positive which can signal price changes in the coming 30-90 days.

### Method
GET

### Endpoint
/stock/insider-sentiment

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Symbol of the company (e.g., AAPL).
- **from** (string) - Required - From date (e.g., 2020-03-15).
- **to** (string) - Required - To date (e.g., 2020-03-16).

### Response
#### Success Response (200)
- **data** (array) - Array of sentiment data.
- **change** (number) - Net buying/selling from all insiders' transactions.
- **month** (integer) - Month.
- **mspr** (number) - Monthly share purchase ratio.
- **symbol** (string) - Symbol of the company.
- **year** (integer) - Year.

#### Response Example
{
  "data": [
    {
      "symbol": "TSLA",
      "year": 2021,
      "month": 3,
      "change": 5540,
      "mspr": 12.209097
    }
  ],
  "symbol": "TSLA"
}
```

--------------------------------

### Retrieve EBIT Estimates with Python

Source: https://finnhub.io/docs/api/company-earnings

Fetches company EBIT estimates using the Finnhub client library. Requires a valid API key to be initialized.

```python
1
2
3
4
5
import finnhub
finnhub_client = finnhub.Client(api_key="")

print(finnhub_client.company_ebit_estimates('TSLA', freq='quarterly'))


```

--------------------------------

### Mutual Fund Profile API Response Example

Source: https://finnhub.io/docs/api/company-dps-estimates

Example JSON response structure returned by the mutual fund profile endpoint.

```json
{
  "profile": {
    "benchmark": "CRSP US Total Stock Market TR",
    "beta": 1.05,
    "category": "Multi-Cap Core",
    "cusip": "",
    "deferredLoad": 0,
    "description": "Created in 1992, Vanguard Total Stock Market Index Fund is designed to provide investors with exposure to the entire U.S. equity market, including small-, mid-, and large-cap growth and value stocks. The fund’s key attributes are its low costs, broad diversification, and the potential for tax efficiency. Investors looking for a low-cost way to gain broad exposure to the U.S. stock market who are willing to accept the volatility that comes with stock market investing may wish to consider this fund as either a core equity holding or your only domestic stock fund.",
    "expenseRatio": 0.04,
    "fee12b1": 0,
    "frontLoad": 0,
    "fundFamily": "VANGUARD ADMIRAL",
    "inceptionDate": "2000-11-13",
    "investmentSegment": "Growth & Income",
    "iraMinInvestment": 0,
    "isin": "",
    "manager": "O'Reilly,Nejman",
    "maxRedemptionFee": 0,
    "name": "Vanguard Index Funds: Vanguard Total Stock Market Index Fund; Admiral Class Shares",
    "standardMinInvestment": 3000,
    "status": "Open",
    "totalNav": 280758000000,
    "turnover": 8
  },
  "symbol": "VTSAX"
}
```
Tokens:
Raw