openapi: 3.0.1
info:
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: Finnhub API
version: 1.0.0
servers:
- url: https://finnhub.io/api/v1
paths:
/search:
get:
description: Search for best-matching symbols based on your query. You can input
anything from symbol, security's name to ISIN and Cusip.
operationId: symbol-search
parameters:
- description: Query text can be symbol, name, isin, or cusip.
in: query
name: q
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SymbolLookup'
description: successful operation
security:
- api_key: []
summary: Symbol Lookup
tags:
- Default
/stock/symbol:
get:
description: List supported stocks. We use the following symbology to identify
stocks on Finnhub Exchange_Ticker.Exchange_Code. A list of supported
exchange codes can be found here. A list of supported CFD Indices can be found here.
operationId: stock-symbols
parameters:
- description: Exchange you want to get the list of symbols from. List of exchange
codes can be found here.
in: query
name: exchange
required: true
schema:
type: string
- description: Filter by MIC code.
in: query
name: mic
schema:
type: string
- description: Filter by security type used by OpenFigi standard.
in: query
name: securityType
schema:
type: string
- description: Filter by currency.
in: query
name: currency
schema:
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/StockSymbol'
type: array
description: successful operation
security:
- api_key: []
summary: Stock Symbol
tags:
- Default
/stock/profile:
get:
description: Get general information of a company. You can query by symbol,
ISIN or CUSIP
operationId: company-profile
parameters:
- description: 'Symbol of the company: AAPL e.g.'
in: query
name: symbol
schema:
type: string
- description: ISIN
in: query
name: isin
schema:
type: string
- description: CUSIP
in: query
name: cusip
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyProfile'
description: successful operation
security:
- api_key: []
summary: Company Profile
tags:
- Default
/stock/profile2:
get:
description: Get general information of a company. You can query by symbol,
ISIN or CUSIP. This is the free version of Company
Profile.
operationId: company-profile2
parameters:
- description: 'Symbol of the company: AAPL e.g.'
in: query
name: symbol
schema:
type: string
- description: ISIN
in: query
name: isin
schema:
type: string
- description: CUSIP
in: query
name: cusip
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyProfile2'
description: successful operation
security:
- api_key: []
summary: Company Profile 2
tags:
- Default
/stock/executive:
get:
description: Get a list of company's executives and members of the Board.
operationId: company-executive
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyExecutive'
description: successful operation
security:
- api_key: []
summary: Company Executive
tags:
- Default
/news:
get:
description: Get latest market news.
operationId: market-news
parameters:
- description: This parameter can be 1 of the following values general,
forex, crypto, merger.
in: query
name: category
required: true
schema:
type: string
- description: Use this field to get only news after this ID. Default to 0
in: query
name: minId
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/MarketNews'
type: array
description: successful operation
security:
- api_key: []
summary: Market News
tags:
- Default
/company-news:
get:
description: List latest company news by symbol. This endpoint is only available
for North American companies.
operationId: company-news
parameters:
- description: Company symbol.
in: query
name: symbol
required: true
schema:
type: string
- description: From date YYYY-MM-DD.
in: query
name: from
required: true
schema:
format: date
type: string
- description: To date YYYY-MM-DD.
in: query
name: to
required: true
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CompanyNews'
type: array
description: successful operation
security:
- api_key: []
summary: Company News
tags:
- Default
/press-releases:
get:
description: Get latest major press releases of a company. This data can be
used to highlight the most significant events comprised of mostly press releases
sourced from the exchanges, BusinessWire, AccessWire, GlobeNewswire, Newsfile,
and PRNewswire.
operationId: press-releases
parameters:
- description: Company symbol.
in: query
name: symbol
required: true
schema:
type: string
- description: 'From time: 2020-01-01.'
in: query
name: from
schema:
format: date
type: string
- description: 'To time: 2020-01-05.'
in: query
name: to
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/PressRelease'
description: successful operation
security:
- api_key: []
summary: Major Press Releases
tags:
- Default
/news-sentiment:
get:
description: Get company's news sentiment and statistics. This endpoint is only
available for US companies.
operationId: news-sentiment
parameters:
- description: Company symbol.
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/NewsSentiment'
description: successful operation
security:
- api_key: []
summary: News Sentiment
tags:
- Default
/stock/peers:
get:
description: Get company peers. Return a list of peers in the same country and
GICS sub-industry
operationId: company-peers
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
items:
type: string
type: array
description: successful operation
security:
- api_key: []
summary: Peers
tags:
- Default
/stock/metric:
get:
description: Get company basic financials such as margin, P/E ratio, 52-week
high/low etc.
operationId: company-basic-financials
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
- description: Metric type. Can be 1 of the following values all
in: query
name: metric
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/BasicFinancials'
description: successful operation
security:
- api_key: []
summary: Basic Financials
tags:
- Default
/stock/ownership:
get:
description: Get a full list of shareholders of a company in descending order
of the number of shares held. Data is sourced from 13F form,
Schedule 13D and 13G for US market, UK Share
Register for UK market, SEDI for Canadian market and equivalent
filings for other international markets.
operationId: ownership
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
- description: Limit number of results. Leave empty to get the full list.
in: query
name: limit
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Ownership'
description: successful operation
security:
- api_key: []
summary: Ownership
tags:
- Default
/stock/fund-ownership:
get:
description: Get a full list fund and institutional investors of a company in
descending order of the number of shares held. Data is sourced from 13F
form, Schedule 13D and 13G for US market,
UK Share Register for UK market, SEDI for Canadian
market and equivalent filings for other international markets.
operationId: fund-ownership
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
- description: Limit number of results. Leave empty to get the full list.
in: query
name: limit
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/FundOwnership'
description: successful operation
security:
- api_key: []
summary: Fund Ownership
tags:
- Default
/stock/insider-transactions:
get:
description: Company insider transactions data sourced from Form 3,4,5.
This endpoint only covers US companies at the moment. Limit to 100 transactions
per API call.
operationId: insider-transactions
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
- description: 'From date: 2020-03-15.'
in: query
name: from
schema:
format: date
type: string
- description: 'To date: 2020-03-16.'
in: query
name: to
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/InsiderTransactions'
description: successful operation
security:
- api_key: []
summary: Insider Transactions
tags:
- Default
/stock/financials:
get:
description:
Get standardized balance sheet, income statement and cash flow for global companies going back 30+ years. Data is sourced from original filings most of which made available through SEC Filings and International Filings endpoints.
Wondering why our standardized data is different from Bloomberg, Reuters, Factset, S&P or Yahoo Finance ? Check out our FAQ page to learn more
operationId: financials parameters: - description: 'Symbol of the company: AAPL.' in: query name: symbol required: true schema: type: string - description: Statement can take 1 of these valuesbs, ic, cf
for Balance Sheet, Income Statement, Cash Flow respectively.
in: query
name: statement
required: true
schema:
type: string
- description: Frequency can take 1 of these values annual, quarterly,
ttm, ytd. TTM (Trailing Twelve Months) option is available for Income
Statement and Cash Flow. YTD (Year To Date) option is only available for
Cash Flow.
in: query
name: freq
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialStatements'
description: successful operation
security:
- api_key: []
summary: Financial Statements
tags:
- Default
/stock/financials-reported:
get:
description: Get financials as reported. This data is available for bulk download
on Kaggle
SEC Financials database.
operationId: financials-reported
parameters:
- description: Symbol.
in: query
name: symbol
schema:
type: string
- description: CIK.
in: query
name: cik
schema:
type: string
- description: Access number of a specific report you want to retrieve financials
from.
in: query
name: accessNumber
schema:
type: string
- description: Frequency. Can be either annual or quarterly.
Default to annual.
in: query
name: freq
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialsAsReported'
description: successful operation
security:
- api_key: []
summary: Financials As Reported
tags:
- Default
/stock/revenue-breakdown:
get:
description: Get revenue breakdown by product. This dataset is only available
for US companies which disclose their revenue breakdown in the annual or quarterly
reports.
operationId: revenue-breakdown
parameters:
- description: Symbol.
in: query
name: symbol
schema:
type: string
- description: CIK.
in: query
name: cik
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/RevenueBreakdown'
description: successful operation
security:
- api_key: []
summary: Revenue Breakdown
tags:
- Default
/stock/filings:
get:
description: List company's filing. Limit to 250 documents at a time. This data
is available for bulk download on Kaggle SEC Filings database.
operationId: filings
parameters:
- description: Symbol. Leave symbol,cik and accessNumber
empty to list latest filings.
in: query
name: symbol
schema:
type: string
- description: CIK.
in: query
name: cik
schema:
type: string
- description: Access number of a specific report you want to retrieve data
from.
in: query
name: accessNumber
schema:
type: string
- description: Filter by form. You can use this value NT 10-K to
find non-timely filings for a company.
in: query
name: form
schema:
type: string
- description: 'From date: 2020-03-15.'
in: query
name: from
schema:
format: date
type: string
- description: 'To date: 2020-03-16.'
in: query
name: to
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Filing'
type: array
description: successful operation
security:
- api_key: []
summary: SEC Filings
tags:
- Default
/stock/international-filings:
get:
description: List filings for international companies which covers 95%+ of global
market cap. Limit to 250 documents at a time. These are the documents we use
to source our fundamental data.
operationId: international-filings
parameters:
- description: Symbol. Leave empty to list latest filings.
in: query
name: symbol
schema:
type: string
- description: Filter by country using country's 2-letter code.
in: query
name: country
schema:
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/InternationalFiling'
type: array
description: successful operation
security:
- api_key: []
summary: International Filings
tags:
- Default
/stock/filings-sentiment:
get:
description: Get sentiment analysis of 10-K and 10-Q filings from SEC. An abnormal
increase in the number of positive/negative words in filings can signal a
significant change in the company's stock price in the upcoming 4 quarters.
We make use of Loughran and McDonald Sentiment Word Lists to calculate
the sentiment for each filing.
operationId: filings-sentiment
parameters:
- description: Access number of a specific report you want to retrieve data
from.
in: query
name: accessNumber
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SECSentimentAnalysis'
description: successful operation
security:
- api_key: []
summary: SEC Sentiment Analysis
tags:
- Default
/stock/similarity-index:
get:
description: Calculate the textual difference between a company's 10-K / 10-Q reports and the same type of report in the previous year using Cosine Similarity. For example, this endpoint compares 2019's 10-K with 2018's 10-K. Companies breaking from its routines in disclosure of financial condition and risk analysis section can signal a significant change in the company's stock price in the upcoming 4 quarters.
operationId: similarity-index parameters: - description: Symbol. Required if cik is empty in: query name: symbol schema: type: string - description: CIK. Required if symbol is empty in: query name: cik schema: type: string - description:annual or quarterly. Default to annual
in: query
name: freq
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SimilarityIndex'
description: successful operation
security:
- api_key: []
summary: Similarity Index
tags:
- Default
/calendar/ipo:
get:
description: Get recent and upcoming IPO.
operationId: ipo-calendar
parameters:
- description: 'From date: 2020-03-15.'
in: query
name: from
required: true
schema:
format: date
type: string
- description: 'To date: 2020-03-16.'
in: query
name: to
required: true
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/IPOCalendar'
description: successful operation
security:
- api_key: []
summary: IPO Calendar
tags:
- Default
/stock/dividend:
get:
description: Get dividends data for common stocks going back 30 years.
operationId: stock-dividends
parameters:
- description: Symbol.
in: query
name: symbol
required: true
schema:
type: string
- description: YYYY-MM-DD.
in: query
name: from
required: true
schema:
format: date
type: string
- description: YYYY-MM-DD.
in: query
name: to
required: true
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Dividends'
type: array
description: successful operation
security:
- api_key: []
summary: Dividends
tags:
- Default
/stock/recommendation:
get:
description: Get latest analyst recommendation trends for a company.
operationId: recommendation-trends
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/RecommendationTrend'
type: array
description: successful operation
security:
- api_key: []
summary: Recommendation Trends
tags:
- Default
/stock/price-target:
get:
description: Get latest price target consensus.
operationId: price-target
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/PriceTarget'
description: successful operation
security:
- api_key: []
summary: Price Target
tags:
- Default
/stock/upgrade-downgrade:
get:
description: Get latest stock upgrade and downgrade.
operationId: upgrade-downgrade
parameters:
- description: 'Symbol of the company: AAPL. If left blank, the API will return
latest stock upgrades/downgrades.'
in: query
name: symbol
schema:
type: string
- description: 'From date: 2000-03-15.'
in: query
name: from
schema:
format: date
type: string
- description: 'To date: 2020-03-16.'
in: query
name: to
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/UpgradeDowngrade'
type: array
description: successful operation
security:
- api_key: []
summary: Stock Upgrade/Downgrade
tags:
- Default
/stock/revenue-estimate:
get:
description: Get company's revenue estimates.
operationId: company-revenue-estimates
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
- description: 'Can take 1 of the following values: annual, quarterly.
Default to quarterly'
in: query
name: freq
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/RevenueEstimates'
description: successful operation
security:
- api_key: []
summary: Revenue Estimates
tags:
- Default
/stock/eps-estimate:
get:
description: Get company's EPS estimates.
operationId: company-eps-estimates
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
- description: 'Can take 1 of the following values: annual, quarterly.
Default to quarterly'
in: query
name: freq
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/EarningsEstimates'
description: successful operation
security:
- api_key: []
summary: Earnings Estimates
tags:
- Default
/stock/earnings:
get:
description: Get company historical quarterly earnings surprise going back to
2000.
operationId: company-earnings
parameters:
- description: 'Symbol of the company: AAPL.'
in: query
name: symbol
required: true
schema:
type: string
- description: Limit number of period returned. Leave blank to get the full
history.
in: query
name: limit
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/EarningResult'
type: array
description: successful operation
security:
- api_key: []
summary: Earnings Surprises
tags:
- Default
/calendar/earnings:
get:
description: Get historical and coming earnings release. EPS and Revenue in
this endpoint are non-GAAP, which means they are adjusted to exclude some
one-time or unusual items. This is the same data investors usually react to
and talked about on the media. Estimates are sourced from both sell-side and
buy-side analysts.
operationId: earnings-calendar
parameters:
- description: 'From date: 2020-03-15.'
in: query
name: from
schema:
format: date
type: string
- description: 'To date: 2020-03-16.'
in: query
name: to
schema:
format: date
type: string
- description: 'Filter by symbol: AAPL.'
in: query
name: symbol
schema:
type: string
- description: Set to true to include international markets. Default
value is false
in: query
name: international
schema:
type: boolean
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/EarningsCalendar'
description: successful operation
security:
- api_key: []
summary: Earnings Calendar
tags:
- Default
/quote:
get:
description: Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time updates.
Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed. Contact Us to learn more.
operationId: quote parameters: - description: Symbol in: query name: symbol required: true schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/Quote' description: successful operation security: - api_key: [] summary: Quote tags: - Default /stock/candle: get: description:Get candlestick data (OHLCV) for stocks.
Daily data will be adjusted for Splits. Intraday data will remain unadjusted.
operationId: stock-candles parameters: - description: Symbol. in: query name: symbol required: true schema: type: string - description: Supported resolution includes1, 5, 15, 30, 60, D, W, M
.Some timeframes might not be available depending on the exchange.
in: query
name: resolution
required: true
schema:
type: string
- description: UNIX timestamp. Interval initial value.
in: query
name: from
required: true
schema:
format: int64
type: integer
- description: UNIX timestamp. Interval end value.
in: query
name: to
required: true
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/StockCandles'
description: successful operation
security:
- api_key: []
summary: Stock Candles
tags:
- Default
/stock/tick:
get:
description: |-
Get historical tick data for global exchanges. You can send the request directly to our tick server at https://tick.finnhub.io/ with the same path and parameters or get redirected there if you call our main server.
For US market, you can visit our bulk download page in the Dashboard here to speed up the download process.
Note that for Nasdaq Nordic and Baltic, you need to use ISIN instead of symbol to query tick data.
| Exchange | Segment | Delay |
|---|---|---|
| US CTA/UTP | Full SIP | 15 minute |
| TSX |
|
End-of-day |
| LSE |
|
15 minute |
| Euronext |
|
End-of-day |
| Deutsche Börse |
|
End-of-day |
| Nasdaq Nordic & Baltic |
|
End-of-day |
25000'
in: query
name: limit
required: true
schema:
format: int64
type: integer
- description: Number of ticks to skip. Use this parameter to loop through the
entire data.
in: query
name: skip
required: true
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/TickData'
description: successful operation
security:
- api_key: []
summary: Tick Data
tags:
- Default
/stock/bbo:
get:
description: Get historical best bid and offer for US stocks, LSE, TSX, Euronext and Deutsche Borse.
For US market, this endpoint only serves historical NBBO from the beginning of 2020. To download more historical data, please visit our bulk download page in the Dashboard here.
operationId: stock-nbbo parameters: - description: Symbol. in: query name: symbol required: true schema: type: string - description: 'Date: 2020-04-02.' in: query name: date required: true schema: format: date type: string - description: 'Limit number of ticks returned. Maximum value:25000'
in: query
name: limit
required: true
schema:
format: int64
type: integer
- description: Number of ticks to skip. Use this parameter to loop through the
entire data.
in: query
name: skip
required: true
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/HistoricalNBBO'
description: successful operation
security:
- api_key: []
summary: Historical NBBO
tags:
- Default
/stock/bidask:
get:
description: Get last bid/ask data for US stocks.
operationId: stock-bidask
parameters:
- description: Symbol.
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/LastBid-Ask'
description: successful operation
security:
- api_key: []
summary: Last Bid-Ask
tags:
- Default
/stock/split:
get:
description: Get splits data for stocks.
operationId: stock-splits
parameters:
- description: Symbol.
in: query
name: symbol
required: true
schema:
type: string
- description: YYYY-MM-DD.
in: query
name: from
required: true
schema:
format: date
type: string
- description: YYYY-MM-DD.
in: query
name: to
required: true
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Split'
type: array
description: successful operation
security:
- api_key: []
summary: Splits
tags:
- Default
/stock/dividend2:
get:
description: Get global dividends data.
operationId: stock-basic-dividends
parameters:
- description: Symbol.
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Dividends2'
description: successful operation
security:
- api_key: []
summary: Dividends 2 (Basic)
tags:
- Default
/index/constituents:
get:
description: Get a list of index's constituents. A list of supported indices
for this endpoint can be found here.
operationId: indices-constituents
parameters:
- description: symbol
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/IndicesConstituents'
description: successful operation
security:
- api_key: []
summary: Indices Constituents
tags:
- Default
/index/historical-constituents:
get:
description: Get full history of index's constituents including symbols and
dates of joining and leaving the Index. Currently support ^GSPC (S&P
500), ^NDX (Nasdaq 100), ^DJI (Dow Jones)
operationId: indices-historical-constituents
parameters:
- description: symbol
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/IndicesHistoricalConstituents'
description: successful operation
security:
- api_key: []
summary: Indices Historical Constituents
tags:
- Default
/etf/profile:
get:
description: Get ETF profile information. This endpoint has global coverage.
operationId: etfs-profile
parameters:
- description: ETF symbol.
in: query
name: symbol
schema:
type: string
- description: ETF isin.
in: query
name: isin
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ETFsProfile'
description: successful operation
security:
- api_key: []
summary: ETFs Profile
tags:
- Default
/etf/holdings:
get:
description: Get full ETF holdings/constituents. This endpoint has global coverage.
Widget only shows top 10 holdings.
operationId: etfs-holdings
parameters:
- description: ETF symbol.
in: query
name: symbol
schema:
type: string
- description: ETF isin.
in: query
name: isin
schema:
type: string
- description: Skip the first n results. You can use this parameter to query
historical constituents data. The latest result is returned if skip=0 or
not set.
in: query
name: skip
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ETFsHoldings'
description: successful operation
security:
- api_key: []
summary: ETFs Holdings
tags:
- Default
/etf/sector:
get:
description: Get ETF sector exposure data.
operationId: etfs-sector-exposure
parameters:
- description: ETF symbol.
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ETFsSectorExposure'
description: successful operation
security:
- api_key: []
summary: ETFs Sector Exposure
tags:
- Default
/etf/country:
get:
description: Get ETF country exposure data.
operationId: etfs-country-exposure
parameters:
- description: ETF symbol.
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ETFsCountryExposure'
description: successful operation
security:
- api_key: []
summary: ETFs Country Exposure
tags:
- Default
/mutual-fund/profile:
get:
description: Get mutual funds profile information. This endpoint covers US mutual
funds only.
operationId: mutual-fund-profile
parameters:
- description: Fund's symbol.
in: query
name: symbol
schema:
type: string
- description: Fund's isin.
in: query
name: isin
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/MutualFundProfile'
description: successful operation
security:
- api_key: []
summary: Mutual Funds Profile
tags:
- Default
/mutual-fund/holdings:
get:
description: Get full Mutual Funds holdings/constituents.
operationId: mutual-fund-holdings
parameters:
- description: Fund's symbol.
in: query
name: symbol
schema:
type: string
- description: Fund's isin.
in: query
name: isin
schema:
type: string
- description: Skip the first n results. You can use this parameter to query
historical constituents data. The latest result is returned if skip=0 or
not set.
in: query
name: skip
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/MutualFundHoldings'
description: successful operation
security:
- api_key: []
summary: Mutual Funds Holdings
tags:
- Default
/mutual-fund/sector:
get:
description: Get Mutual Funds sector exposure data.
operationId: mutual-fund-sector-exposure
parameters:
- description: Mutual Fund symbol.
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/MutualFundSectorExposure'
description: successful operation
security:
- api_key: []
summary: Mutual Funds Sector Exposure
tags:
- Default
/mutual-fund/country:
get:
description: Get Mutual Funds country exposure data.
operationId: mutual-fund-country-exposure
parameters:
- description: Symbol.
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/MutualFundCountryExposure'
description: successful operation
security:
- api_key: []
summary: Mutual Funds Country Exposure
tags:
- Default
/forex/exchange:
get:
description: List supported forex exchanges
operationId: forex-exchanges
responses:
"200":
content:
application/json:
schema:
items:
type: string
type: array
description: successful operation
security:
- api_key: []
summary: Forex Exchanges
tags:
- Default
/forex/symbol:
get:
description: List supported forex symbols.
operationId: forex-symbols
parameters:
- description: Exchange you want to get the list of symbols from.
in: query
name: exchange
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ForexSymbol'
type: array
description: successful operation
security:
- api_key: []
summary: Forex Symbol
tags:
- Default
/forex/candle:
get:
description: Get candlestick data for forex symbols.
operationId: forex-candles
parameters:
- description: Use symbol returned in /forex/symbol endpoint for
this field.
in: query
name: symbol
required: true
schema:
type: string
- description: Supported resolution includes 1, 5, 15, 30, 60, D, W, M
.Some timeframes might not be available depending on the exchange.
in: query
name: resolution
required: true
schema:
type: string
- description: UNIX timestamp. Interval initial value.
in: query
name: from
required: true
schema:
format: int64
type: integer
- description: UNIX timestamp. Interval end value.
in: query
name: to
required: true
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ForexCandles'
description: successful operation
security:
- api_key: []
summary: Forex Candles
tags:
- Default
/forex/rates:
get:
description: Get rates for all forex pairs. Ideal for currency conversion
operationId: forex-rates
parameters:
- description: Base currency. Default to EUR.
in: query
name: base
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Forexrates'
description: successful operation
security:
- api_key: []
summary: Forex rates
tags:
- Default
/crypto/exchange:
get:
description: List supported crypto exchanges
operationId: crypto-exchanges
responses:
"200":
content:
application/json:
schema:
items:
type: string
type: array
description: successful operation
security:
- api_key: []
summary: Crypto Exchanges
tags:
- Default
/crypto/symbol:
get:
description: List supported crypto symbols by exchange
operationId: crypto-symbols
parameters:
- description: Exchange you want to get the list of symbols from.
in: query
name: exchange
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CryptoSymbol'
type: array
description: successful operation
security:
- api_key: []
summary: Crypto Symbol
tags:
- Default
/crypto/candle:
get:
description: Get candlestick data for crypto symbols.
operationId: crypto-candles
parameters:
- description: Use symbol returned in /crypto/symbol endpoint for
this field.
in: query
name: symbol
required: true
schema:
type: string
- description: Supported resolution includes 1, 5, 15, 30, 60, D, W, M
.Some timeframes might not be available depending on the exchange.
in: query
name: resolution
required: true
schema:
type: string
- description: UNIX timestamp. Interval initial value.
in: query
name: from
required: true
schema:
format: int64
type: integer
- description: UNIX timestamp. Interval end value.
in: query
name: to
required: true
schema:
format: int64
type: integer
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/CryptoCandles'
description: successful operation
security:
- api_key: []
summary: Crypto Candles
tags:
- Default
/scan/pattern:
get:
description: Run pattern recognition algorithm on a symbol. Support double top/bottom,
triple top/bottom, head and shoulders, triangle, wedge, channel, flag, and
candlestick patterns.
operationId: pattern-recognition
parameters:
- description: Symbol
in: query
name: symbol
required: true
schema:
type: string
- description: Supported resolution includes 1, 5, 15, 30, 60, D, W, M
.Some timeframes might not be available depending on the exchange.
in: query
name: resolution
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/PatternRecognition'
description: successful operation
security:
- api_key: []
summary: Pattern Recognition
tags:
- Default
/scan/support-resistance:
get:
description: Get support and resistance levels for a symbol.
operationId: support-resistance
parameters:
- description: Symbol
in: query
name: symbol
required: true
schema:
type: string
- description: Supported resolution includes 1, 5, 15, 30, 60, D, W, M
.Some timeframes might not be available depending on the exchange.
in: query
name: resolution
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SupportResistance'
description: successful operation
security:
- api_key: []
summary: Support/Resistance
tags:
- Default
/scan/technical-indicator:
get:
description: Get aggregate signal of multiple technical indicators such as MACD,
RSI, Moving Average v.v.
operationId: aggregate-indicator
parameters:
- description: symbol
in: query
name: symbol
required: true
schema:
type: string
- description: Supported resolution includes 1, 5, 15, 30, 60, D, W, M
.Some timeframes might not be available depending on the exchange.
in: query
name: resolution
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AggregateIndicators'
description: successful operation
security:
- api_key: []
summary: Aggregate Indicators
tags:
- Default
/indicator:
post:
description: Return technical indicator with price data. List of supported indicators
can be found here.
operationId: technical-indicator
parameters:
- description: symbol
in: query
name: symbol
required: true
schema:
type: string
- description: Supported resolution includes 1, 5, 15, 30, 60, D, W, M
.Some timeframes might not be available depending on the exchange.
in: query
name: resolution
required: true
schema:
type: string
- description: UNIX timestamp. Interval initial value.
in: query
name: from
required: true
schema:
format: int64
type: integer
- description: UNIX timestamp. Interval end value.
in: query
name: to
required: true
schema:
format: int64
type: integer
- description: Indicator name. Full list can be found here.
in: query
name: indicator
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IndicatorFields'
description: Check out this page to see which indicators and params are supported.
required: false
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/TechnicalIndicator'
description: successful operation
security:
- api_key: []
summary: Technical Indicators
tags:
- Default
x-codegen-request-body-name: indicator_fields
/stock/transcripts/list:
get:
description: List earnings call transcripts' metadata. This endpoint is available
for US, UK and Canadian companies.
operationId: transcripts-list
parameters:
- description: 'Company symbol: AAPL. Leave empty to list the latest transcripts'
in: query
name: symbol
required: true
schema:
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/EarningsCallTranscriptsList'
description: successful operation
security:
- api_key: []
summary: Earnings Call Transcripts List
tags:
- Default
/stock/transcripts:
get:
description: Get earnings call transcripts, audio and participants' list. This endpoint is only available for US, UK, and Candian companies.
15+ years of data is available with 220,000+ audio which add up to 7TB in size.
operationId: transcripts parameters: - description: Transcript's id obtained with Transcripts List endpoint. in: query name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/EarningsCallTranscripts' description: successful operation security: - api_key: [] summary: Earnings Call Transcripts tags: - Default /stock/social-sentiment: get: description:Get social sentiment for stocks on Reddit and Twitter. This endpoint is currently in Beta.
operationId: social-sentiment parameters: - description: Company symbol. in: query name: symbol required: true schema: type: string - description: From dateYYYY-MM-DD.
in: query
name: from
schema:
format: date
type: string
- description: To date YYYY-MM-DD.
in: query
name: to
schema:
format: date
type: string
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/SocialSentiment'
description: successful operation
security:
- api_key: []
summary: Social Sentiment
tags:
- Default
/stock/investment-theme:
get:
description: Thematic investing involves creating a portfolio (or portion of a portfolio) by gathering together a collection of companies involved in certain areas that you predict will generate above-market returns over the long term. Themes can be based on a concept such as ageing populations or a sub-sector such as robotics, and drones. Thematic investing focuses on predicted long-term trends rather than specific companies or sectors, enabling investors to access structural, one-off shifts that can change an entire industry.
This endpoint will help you get portfolios of different investment themes that are changing our life and are the way of the future.
A full list of themes supported can be found here. The theme coverage and portfolios are updated bi-weekly by our analysts. Our approach excludes penny, super-small cap and illiquid stocks.
operationId: investment-themes parameters: - description: Investment theme. A full list of themes supported can be found here. in: query name: theme required: true schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/InvestmentThemes' description: successful operation security: - api_key: [] summary: Investment Themes (Thematic Investing) tags: - Default /stock/supply-chain: get: description:This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.
We currently cover data for S&P500 and Nasdaq 100 companies.
operationId: supply-chain-relationships parameters: - description: Symbol. in: query name: symbol required: true schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/SupplyChainRelationships' description: successful operation security: - api_key: [] summary: Supply Chain Relationships tags: - Default /covid19/us: get: description: Get real-time updates on the number of COVID-19 (Corona virus) cases in the US with a state-by-state breakdown. Data is sourced from CDC and reputable sources. You can also access this API here operationId: covid-19 responses: "200": content: application/json: schema: items: $ref: '#/components/schemas/CovidInfo' type: array description: successful operation security: - api_key: [] summary: COVID-19 tags: - Default /fda-advisory-committee-calendar: get: description: FDA's advisory committees are established to provide functions which support the agency's mission of protecting and promoting the public health, while meeting the requirements set forth in the Federal Advisory Committee Act. Committees are either mandated by statute or established at the discretion of the Department of Health and Human Services. Each committee is subject to renewal at two-year intervals unless the committee charter states otherwise. operationId: fda-committee-meeting-calendar responses: "200": content: application/json: schema: items: $ref: '#/components/schemas/FDAComitteeMeeting' type: array description: successful operation security: - api_key: [] summary: FDA Committee Meeting Calendar tags: - Default /country: get: description: List all countries and metadata. operationId: country responses: "200": content: application/json: schema: items: $ref: '#/components/schemas/CountryMetadata' type: array description: successful operation security: - api_key: [] summary: Country Metadata tags: - Default /calendar/economic: get: description:Get recent and upcoming economic releases.
Historical events and surprises are available for Enterprise clients.
operationId: economic-calendar responses: "200": content: application/json: schema: $ref: '#/components/schemas/EconomicCalendar' description: successful operation security: - api_key: [] summary: Economic Calendar tags: - Default /economic/code: get: description: List codes of supported economic data. operationId: economic-code responses: "200": content: application/json: schema: items: $ref: '#/components/schemas/EconomicCode' type: array description: successful operation security: - api_key: [] summary: Economic Code tags: - Default /economic: get: description: Get economic data. operationId: economic-data parameters: - description: Economic code. in: query name: code required: true schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/EconomicData' description: successful operation security: - api_key: [] summary: Economic Data tags: - Default components: schemas: StockSymbol: example: displaySymbol: displaySymbol symbol: symbol mic: mic description: description figi: figi currency: currency type: type properties: description: description: Symbol description type: string displaySymbol: description: Display symbol name. type: string symbol: description: Unique symbol used to identify this symbol used in/stock/candle
endpoint.
type: string
type:
description: Security type.
type: string
mic:
description: Primary exchange's MIC.
type: string
figi:
description: FIGI identifier.
type: string
currency:
description: Price's currency. This might be different from the reporting
currency of fundamental data.
type: string
type: object
SymbolLookup:
example:
result:
- displaySymbol: displaySymbol
symbol: symbol
description: description
type: type
- displaySymbol: displaySymbol
symbol: symbol
description: description
type: type
count: 0
properties:
result:
description: Array of search results.
items:
$ref: '#/components/schemas/SymbolLookupInfo'
type: array
count:
description: Number of results.
format: int64
type: integer
type: object
SymbolLookupInfo:
example:
displaySymbol: displaySymbol
symbol: symbol
description: description
type: type
properties:
description:
description: Symbol description
type: string
displaySymbol:
description: Display symbol name.
type: string
symbol:
description: Unique symbol used to identify this symbol used in /stock/candle
endpoint.
type: string
type:
description: Security type.
type: string
type: object
CompanyProfile:
example:
country: country
cusip: cusip
city: city
naicsSector: naicsSector
description: description
employeeTotal: 1.4658129
gsector: gsector
weburl: weburl
logo: logo
currency: currency
state: state
ggroup: ggroup
ticker: ticker
address: address
marketCapitalization: 0.8008282
gind: gind
ipo: 2000-01-23
sedol: sedol
finnhubIndustry: finnhubIndustry
naicsNationalIndustry: naicsNationalIndustry
naicsSubsector: naicsSubsector
phone: phone
gsubind: gsubind
name: name
exchange: exchange
naics: naics
isin: isin
shareOutstanding: 6.0274563
properties:
address:
description: Address of company's headquarter.
type: string
city:
description: City of company's headquarter.
type: string
country:
description: Country of company's headquarter.
type: string
currency:
description: Currency used in company filings.
type: string
cusip:
description: CUSIP number.
type: string
sedol:
description: Sedol number.
type: string
description:
description: Company business summary.
type: string
exchange:
description: Listed exchange.
type: string
ggroup:
description: GICS industry group.
type: string
gind:
description: GICS industry.
type: string
gsector:
description: GICS sector.
type: string
gsubind:
description: GICS sub-industry.
type: string
isin:
description: ISIN number.
type: string
naicsNationalIndustry:
description: NAICS national industry.
type: string
naics:
description: NAICS industry.
type: string
naicsSector:
description: NAICS sector.
type: string
naicsSubsector:
description: NAICS subsector.
type: string
name:
description: Company name.
type: string
phone:
description: Company phone number.
type: string
state:
description: State of company's headquarter.
type: string
ticker:
description: Company symbol/ticker as used on the listed exchange.
type: string
weburl:
description: Company website.
type: string
ipo:
description: IPO date.
format: date
type: string
marketCapitalization:
description: Market Capitalization.
format: float
type: number
shareOutstanding:
description: Number of oustanding shares.
format: float
type: number
employeeTotal:
description: Number of employee.
format: float
type: number
logo:
description: Logo image.
type: string
finnhubIndustry:
description: Finnhub industry classification.
type: string
type: object
CompanyProfile2:
example:
finnhubIndustry: finnhubIndustry
country: country
ticker: ticker
marketCapitalization: 0.8008282
phone: phone
weburl: weburl
name: name
ipo: 2000-01-23
logo: logo
currency: currency
exchange: exchange
shareOutstanding: 6.0274563
properties:
country:
description: Country of company's headquarter.
type: string
currency:
description: Currency used in company filings.
type: string
exchange:
description: Listed exchange.
type: string
name:
description: Company name.
type: string
ticker:
description: Company symbol/ticker as used on the listed exchange.
type: string
ipo:
description: IPO date.
format: date
type: string
marketCapitalization:
description: Market Capitalization.
format: float
type: number
shareOutstanding:
description: Number of oustanding shares.
format: float
type: number
logo:
description: Logo image.
type: string
phone:
description: Company phone number.
type: string
weburl:
description: Company website.
type: string
finnhubIndustry:
description: Finnhub industry classification.
type: string
type: object
Company:
example:
sex: sex
name: name
compensation: 6
currency: currency
title: title
age: 0
since: since
properties:
name:
description: Executive name
type: string
age:
description: Age
format: int64
type: integer
title:
description: Title
type: string
since:
description: Year appointed
type: string
sex:
description: Sex
type: string
compensation:
description: Total compensation
format: int64
type: integer
currency:
description: Compensation currency
type: string
type: object
CompanyExecutive:
example:
symbol: symbol
executive:
- sex: sex
name: name
compensation: 6
currency: currency
title: title
age: 0
since: since
- sex: sex
name: name
compensation: 6
currency: currency
title: title
age: 0
since: since
properties:
symbol:
description: Company symbol.
type: string
executive:
description: Array of company's executives and members of the Board.
items:
$ref: '#/components/schemas/Company'
type: array
type: object
MarketNews:
example:
summary: summary
image: image
datetime: 0
related: related
id: 6
source: source
category: category
headline: headline
url: url
properties:
category:
description: News category.
type: string
datetime:
description: Published time in UNIX timestamp.
format: int64
type: integer
headline:
description: News headline.
type: string
id:
description: News ID. This value can be used for minId params
to get the latest news only.
format: int64
type: integer
image:
description: Thumbnail image URL.
type: string
related:
description: Related stocks and companies mentioned in the article.
type: string
source:
description: News source.
type: string
summary:
description: News summary.
type: string
url:
description: URL of the original article.
type: string
type: object
CompanyNews:
example:
summary: summary
image: image
datetime: 0
related: related
id: 6
source: source
category: category
headline: headline
url: url
properties:
category:
description: News category.
type: string
datetime:
description: Published time in UNIX timestamp.
format: int64
type: integer
headline:
description: News headline.
type: string
id:
description: News ID. This value can be used for minId params
to get the latest news only.
format: int64
type: integer
image:
description: Thumbnail image URL.
type: string
related:
description: Related stocks and companies mentioned in the article.
type: string
source:
description: News source.
type: string
summary:
description: News summary.
type: string
url:
description: URL of the original article.
type: string
type: object
Development:
example:
symbol: symbol
datetime: datetime
description: description
headline: headline
url: url
properties:
symbol:
description: Company symbol.
type: string
datetime:
description: Published time in YYYY-MM-DD HH:MM:SS format.
type: string
headline:
description: Development headline.
type: string
description:
description: Development description.
type: string
url:
description: URL.
type: string
type: object
PressRelease:
example:
majorDevelopment:
- symbol: symbol
datetime: datetime
description: description
headline: headline
url: url
- symbol: symbol
datetime: datetime
description: description
headline: headline
url: url
symbol: symbol
properties:
symbol:
description: Company symbol.
type: string
majorDevelopment:
description: Array of major developments.
items:
$ref: '#/components/schemas/Development'
type: array
type: object
CompanyNewsStatistics:
example:
weeklyAverage: 1.4658129
articlesInLastWeek: 0
buzz: 6.0274563
properties:
articlesInLastWeek:
description: ""
format: int64
type: integer
buzz:
description: ""
format: float
type: number
weeklyAverage:
description: ""
format: float
type: number
type: object
Sentiment:
example:
bearishPercent: 7.0614014
bullishPercent: 9.301444
properties:
bearishPercent:
description: ""
format: float
type: number
bullishPercent:
description: ""
format: float
type: number
type: object
NewsSentiment:
example:
sentiment:
bearishPercent: 7.0614014
bullishPercent: 9.301444
symbol: symbol
sectorAverageBullishPercent: 5.637377
sectorAverageNewsScore: 2.302136
buzz:
weeklyAverage: 1.4658129
articlesInLastWeek: 0
buzz: 6.0274563
companyNewsScore: 5.962134
properties:
buzz:
$ref: '#/components/schemas/CompanyNewsStatistics'
companyNewsScore:
description: News score.
format: float
type: number
sectorAverageBullishPercent:
description: Sector average bullish percent.
format: float
type: number
sectorAverageNewsScore:
description: Sectore average score.
format: float
type: number
sentiment:
$ref: '#/components/schemas/Sentiment'
symbol:
description: Requested symbol.
type: string
type: object
MetricSeriesMap:
type: object
MetricMap:
type: object
BasicFinancials:
example:
symbol: symbol
metricType: metricType
metric: '{}'
series: '{}'
properties:
symbol:
description: Symbol of the company.
type: string
metricType:
description: Metric type.
type: string
series:
type: object
metric:
type: object
type: object
OwnershipInfo:
example:
filingDate: 2000-01-23
change: 6
name: name
share: 0
properties:
name:
description: Investor's name.
type: string
share:
description: Number of shares held by the investor.
format: int64
type: integer
change:
description: Number of share changed (net buy or sell) from the last period.
format: int64
type: integer
filingDate:
description: Filing date.
format: date
type: string
type: object
Ownership:
example:
symbol: symbol
ownership:
- filingDate: 2000-01-23
change: 6
name: name
share: 0
- filingDate: 2000-01-23
change: 6
name: name
share: 0
properties:
symbol:
description: Symbol of the company.
type: string
ownership:
description: Array of investors with detailed information about their holdings.
items:
$ref: '#/components/schemas/OwnershipInfo'
type: array
type: object
FundOwnershipInfo:
example:
filingDate: 2000-01-23
portfolioPercent: 1.4658129
change: 6
name: name
share: 0
properties:
name:
description: Investor's name.
type: string
share:
description: Number of shares held by the investor.
format: int64
type: integer
change:
description: Number of share changed (net buy or sell) from the last period.
format: int64
type: integer
filingDate:
description: Filing date.
format: date
type: string
portfolioPercent:
description: Percent of the fund's portfolio comprised of the company's
share.
format: float
type: number
type: object
FundOwnership:
example:
symbol: symbol
ownership:
- filingDate: 2000-01-23
portfolioPercent: 1.4658129
change: 6
name: name
share: 0
- filingDate: 2000-01-23
portfolioPercent: 1.4658129
change: 6
name: name
share: 0
properties:
symbol:
description: Symbol of the company.
type: string
ownership:
description: Array of investors with detailed information about their holdings.
items:
$ref: '#/components/schemas/FundOwnershipInfo'
type: array
type: object
Transactions:
example:
filingDate: 2000-01-23
change: 6
name: name
transactionPrice: 1.4658129
share: 0
transactionCode: transactionCode
transactionDate: 2000-01-23
properties:
name:
description: Insider's name.
type: string
share:
description: Number of shares held after the transaction.
format: int64
type: integer
change:
description: Number of share changed from the last period. A positive value
suggests a BUY transaction. A negative value suggests a SELL
transaction.
format: int64
type: integer
filingDate:
description: Filing date.
format: date
type: string
transactionDate:
description: Transaction date.
format: date
type: string
transactionPrice:
description: Average transaction price.
format: float
type: number
transactionCode:
description: Transaction code. A list of codes and their meanings can be
found here.
type: string
type: object
InsiderTransactions:
example:
symbol: symbol
data:
- filingDate: 2000-01-23
change: 6
name: name
transactionPrice: 1.4658129
share: 0
transactionCode: transactionCode
transactionDate: 2000-01-23
- filingDate: 2000-01-23
change: 6
name: name
transactionPrice: 1.4658129
share: 0
transactionCode: transactionCode
transactionDate: 2000-01-23
properties:
symbol:
description: Symbol of the company.
type: string
data:
description: Array of insider transactions.
items:
$ref: '#/components/schemas/Transactions'
type: array
type: object
FinancialMap:
type: object
FinancialStatements:
example:
symbol: symbol
financials:
- null
- null
properties:
symbol:
description: Symbol of the company.
type: string
financials:
description: An array of map of key, value pairs containing the data for
each period.
items:
$ref: '#/components/schemas/FinancialMap'
type: array
type: object
ReportDataMap:
type: object
Report:
example:
symbol: symbol
cik: cik
form: form
accessNumber: accessNumber
year: 0
endDate: endDate
report: '{}'
filedDate: filedDate
acceptedDate: acceptedDate
startDate: startDate
quarter: 6
properties:
accessNumber:
description: Access number.
type: string
symbol:
description: Symbol.
type: string
cik:
description: CIK.
type: string
year:
description: Year.
format: int64
type: integer
quarter:
description: Quarter.
format: int64
type: integer
form:
description: Form type.
type: string
startDate:
description: Period start date %Y-%m-%d %H:%M:%S.
type: string
endDate:
description: Period end date %Y-%m-%d %H:%M:%S.
type: string
filedDate:
description: Filed date %Y-%m-%d %H:%M:%S.
type: string
acceptedDate:
description: Accepted date %Y-%m-%d %H:%M:%S.
type: string
report:
type: object
type: object
FinancialsAsReported:
example:
symbol: symbol
cik: cik
data:
- symbol: symbol
cik: cik
form: form
accessNumber: accessNumber
year: 0
endDate: endDate
report: '{}'
filedDate: filedDate
acceptedDate: acceptedDate
startDate: startDate
quarter: 6
- symbol: symbol
cik: cik
form: form
accessNumber: accessNumber
year: 0
endDate: endDate
report: '{}'
filedDate: filedDate
acceptedDate: acceptedDate
startDate: startDate
quarter: 6
properties:
symbol:
description: Symbol
type: string
cik:
description: CIK
type: string
data:
description: Array of filings.
items:
$ref: '#/components/schemas/Report'
type: array
type: object
BreakdownItemMap:
type: object
BreakdownItem:
example:
accessNumber: accessNumber
breakdown: '{}'
properties:
accessNumber:
description: Access number of the report from which the data is sourced.
type: string
breakdown:
type: object
type: object
RevenueBreakdown:
example:
symbol: symbol
cik: cik
data:
- accessNumber: accessNumber
breakdown: '{}'
- accessNumber: accessNumber
breakdown: '{}'
properties:
symbol:
description: Symbol
type: string
cik:
description: CIK
type: string
data:
description: Array of revenue breakdown over multiple periods.
items:
$ref: '#/components/schemas/BreakdownItem'
type: array
type: object
Filing:
example:
symbol: symbol
cik: cik
form: form
accessNumber: accessNumber
reportUrl: reportUrl
filedDate: filedDate
acceptedDate: acceptedDate
filingUrl: filingUrl
properties:
accessNumber:
description: Access number.
type: string
symbol:
description: Symbol.
type: string
cik:
description: CIK.
type: string
form:
description: Form type.
type: string
filedDate:
description: Filed date %Y-%m-%d %H:%M:%S.
type: string
acceptedDate:
description: Accepted date %Y-%m-%d %H:%M:%S.
type: string
reportUrl:
description: Report's URL.
type: string
filingUrl:
description: Filing's URL.
type: string
type: object
InternationalFiling:
example:
symbol: symbol
country: country
companyName: companyName
description: description
language: language
category: category
title: title
filedDate: filedDate
url: url
properties:
symbol:
description: Symbol.
type: string
companyName:
description: Company name.
type: string
filedDate:
description: Filed date %Y-%m-%d %H:%M:%S.
type: string
category:
description: Category.
type: string
title:
description: Document's title.
type: string
description:
description: Document's description.
type: string
url:
description: Url.
type: string
language:
description: Language.
type: string
country:
description: Country.
type: string
type: object
FilingSentiment:
example:
modal-strong: 9.301444
negative: 0.8008282
constraining: 2.302136
modal-weak: 7.0614014
modal-moderate: 3.6160767
positive: 6.0274563
uncertainty: 5.637377
polarity: 1.4658129
litigious: 5.962134
properties:
negative:
description: '% of negative words in the filing.'
format: float
type: number
positive:
description: '% of positive words in the filing.'
format: float
type: number
polarity:
description: '% of polarity words in the filing.'
format: float
type: number
litigious:
description: '% of litigious words in the filing.'
format: float
type: number
uncertainty:
description: '% of uncertainty words in the filing.'
format: float
type: number
constraining:
description: '% of constraining words in the filing.'
format: float
type: number
modal-weak:
description: '% of modal-weak words in the filing.'
format: float
type: number
modal-strong:
description: '% of modal-strong words in the filing.'
format: float
type: number
modal-moderate:
description: '% of modal-moderate words in the filing.'
format: float
type: number
type: object
SECSentimentAnalysis:
example:
symbol: symbol
sentiment:
modal-strong: 9.301444
negative: 0.8008282
constraining: 2.302136
modal-weak: 7.0614014
modal-moderate: 3.6160767
positive: 6.0274563
uncertainty: 5.637377
polarity: 1.4658129
litigious: 5.962134
cik: cik
accessNumber: accessNumber
properties:
accessNumber:
description: Access number.
type: string
symbol:
description: Symbol.
type: string
cik:
description: CIK.
type: string
sentiment:
$ref: '#/components/schemas/FilingSentiment'
type: object
SimilarityIndex:
example:
symbol: symbol
cik: cik
similarity:
- symbol: symbol
cik: cik
form: form
accessNumber: accessNumber
reportUrl: reportUrl
filedDate: filedDate
acceptedDate: acceptedDate
filingUrl: filingUrl
- symbol: symbol
cik: cik
form: form
accessNumber: accessNumber
reportUrl: reportUrl
filedDate: filedDate
acceptedDate: acceptedDate
filingUrl: filingUrl
properties:
symbol:
description: Symbol.
type: string
cik:
description: CIK.
type: string
similarity:
description: Array of filings with its cosine similarity compared to the
same report of the previous year.
items:
$ref: '#/components/schemas/Filing'
type: array
type: object
IPOEvent:
example:
date: 2000-01-23
symbol: symbol
price: price
numberOfShares: 0.8008282
totalSharesValue: 6.0274563
name: name
exchange: exchange
status: status
properties:
symbol:
description: Symbol.
type: string
date:
description: IPO date.
format: date
type: string
exchange:
description: Exchange.
type: string
name:
description: Company's name.
type: string
status:
description: 'IPO status. Can take 1 of the following values: expected,priced,withdrawn,filed'
type: string
price:
description: Projected price or price range.
type: string
numberOfShares:
description: Number of shares offered during the IPO.
format: float
type: number
totalSharesValue:
description: Total shares value.
format: float
type: number
type: object
IPOCalendar:
example:
ipoCalendar:
- date: 2000-01-23
symbol: symbol
price: price
numberOfShares: 0.8008282
totalSharesValue: 6.0274563
name: name
exchange: exchange
status: status
- date: 2000-01-23
symbol: symbol
price: price
numberOfShares: 0.8008282
totalSharesValue: 6.0274563
name: name
exchange: exchange
status: status
properties:
ipoCalendar:
description: Array of IPO events.
items:
$ref: '#/components/schemas/IPOEvent'
type: array
type: object
Dividends:
example:
date: 2000-01-23
symbol: symbol
amount: 0.8008282
declarationDate: 2000-01-23
adjustedAmount: 6.0274563
recordDate: 2000-01-23
currency: currency
payDate: 2000-01-23
properties:
symbol:
description: Symbol.
type: string
date:
description: Ex-Dividend date.
format: date
type: string
amount:
description: Amount in local currency.
format: float
type: number
adjustedAmount:
description: Adjusted dividend.
format: float
type: number
payDate:
description: Pay date.
format: date
type: string
recordDate:
description: Record date.
format: date
type: string
declarationDate:
description: Declaration date.
format: date
type: string
currency:
description: Currency.
type: string
type: object
Dividends2Info:
example:
amount: 0.8008282
exDate: 2000-01-23
properties:
exDate:
description: Ex-Dividend date.
format: date
type: string
amount:
description: Amount in local currency.
format: float
type: number
type: object
RecommendationTrend:
example:
symbol: symbol
period: period
buy: 0
sell: 1
strongSell: 5
strongBuy: 5
hold: 6
properties:
symbol:
description: Company symbol.
type: string
buy:
description: Number of recommendations that fall into the Buy category
format: int64
type: integer
hold:
description: Number of recommendations that fall into the Hold category
format: int64
type: integer
period:
description: Updated period
type: string
sell:
description: Number of recommendations that fall into the Sell category
format: int64
type: integer
strongBuy:
description: Number of recommendations that fall into the Strong Buy category
format: int64
type: integer
strongSell:
description: Number of recommendations that fall into the Strong Sell category
format: int64
type: integer
type: object
PriceTarget:
example:
targetLow: 6.0274563
symbol: symbol
lastUpdated: lastUpdated
targetHigh: 0.8008282
targetMean: 1.4658129
targetMedian: 5.962134
properties:
symbol:
description: Company symbol.
type: string
targetHigh:
description: Highes analysts' target.
format: float
type: number
targetLow:
description: Lowest analysts' target.
format: float
type: number
targetMean:
description: Mean of all analysts' targets.
format: float
type: number
targetMedian:
description: Median of all analysts' targets.
format: float
type: number
lastUpdated:
description: Updated time of the data
type: string
type: object
UpgradeDowngrade:
example:
symbol: symbol
gradeTime: 0
fromGrade: fromGrade
toGrade: toGrade
action: action
company: company
properties:
symbol:
description: Company symbol.
type: string
gradeTime:
description: Upgrade/downgrade time in UNIX timestamp.
format: int64
type: integer
fromGrade:
description: From grade.
type: string
toGrade:
description: To grade.
type: string
company:
description: Company/analyst who did the upgrade/downgrade.
type: string
action:
description: 'Action can take any of the following values: up(upgrade),
down(downgrade), main(maintains), init(initiate), reit(reiterate).'
type: string
type: object
RevenueEstimatesInfo:
example:
revenueLow: 1.4658129
period: 2000-01-23
numberAnalysts: 5
revenueHigh: 6.0274563
revenueAvg: 0.8008282
properties:
revenueAvg:
description: Average revenue estimates including Finnhub's proprietary estimates.
format: float
type: number
revenueHigh:
description: Highest estimate.
format: float
type: number
revenueLow:
description: Lowest estimate.
format: float
type: number
numberAnalysts:
description: Number of Analysts.
format: int64
type: integer
period:
description: Period.
format: date
type: string
type: object
RevenueEstimates:
example:
symbol: symbol
data:
- revenueLow: 1.4658129
period: 2000-01-23
numberAnalysts: 5
revenueHigh: 6.0274563
revenueAvg: 0.8008282
- revenueLow: 1.4658129
period: 2000-01-23
numberAnalysts: 5
revenueHigh: 6.0274563
revenueAvg: 0.8008282
freq: freq
properties:
data:
description: List of estimates
items:
$ref: '#/components/schemas/RevenueEstimatesInfo'
type: array
freq:
description: 'Frequency: annual or quarterly.'
type: string
symbol:
description: Company symbol.
type: string
type: object
EarningsEstimatesInfo:
example:
epsHigh: 6.0274563
period: 2000-01-23
epsAvg: 0.8008282
epsLow: 1.4658129
numberAnalysts: 5
properties:
epsAvg:
description: Average EPS estimates including Finnhub's proprietary estimates.
format: float
type: number
epsHigh:
description: Highest estimate.
format: float
type: number
epsLow:
description: Lowest estimate.
format: float
type: number
numberAnalysts:
description: Number of Analysts.
format: int64
type: integer
period:
description: Period.
format: date
type: string
type: object
EarningsEstimates:
example:
symbol: symbol
data:
- epsHigh: 6.0274563
period: 2000-01-23
epsAvg: 0.8008282
epsLow: 1.4658129
numberAnalysts: 5
- epsHigh: 6.0274563
period: 2000-01-23
epsAvg: 0.8008282
epsLow: 1.4658129
numberAnalysts: 5
freq: freq
properties:
data:
description: List of estimates
items:
$ref: '#/components/schemas/EarningsEstimatesInfo'
type: array
freq:
description: 'Frequency: annual or quarterly.'
type: string
symbol:
description: Company symbol.
type: string
type: object
EarningResult:
example:
actual: 0.8008282
surprise: 1.4658129
symbol: symbol
period: 2000-01-23
surprisePercent: 5.962134
estimate: 6.0274563
properties:
actual:
description: Actual earning result.
format: float
type: number
estimate:
description: Estimated earning.
format: float
type: number
surprise:
description: Surprise - The difference between actual and estimate.
format: float
type: number
surprisePercent:
description: Surprise percent.
format: float
type: number
period:
description: Reported period.
format: date
type: string
symbol:
description: Company symbol.
type: string
type: object
EarningRelease:
example:
date: 2000-01-23
symbol: symbol
epsActual: 5.962134
hour: hour
epsEstimate: 1.4658129
revenueEstimate: 5.637377
revenueActual: 2.302136
year: 0
quarter: 6
properties:
symbol:
description: Symbol.
type: string
date:
description: Date.
format: date
type: string
hour:
description: Indicates whether the earnings is announced before market open(bmo),
after market close(amc), or during market hour(dmh).
type: string
year:
description: Earnings year.
format: int64
type: integer
quarter:
description: Earnings quarter.
format: int64
type: integer
epsEstimate:
description: EPS estimate.
format: float
type: number
epsActual:
description: EPS actual.
format: float
type: number
revenueEstimate:
description: Revenue estimate including Finnhub's proprietary estimates.
format: float
type: number
revenueActual:
description: Revenue actual.
format: float
type: number
type: object
EarningsCalendar:
example:
earningsCalendar:
- date: 2000-01-23
symbol: symbol
epsActual: 5.962134
hour: hour
epsEstimate: 1.4658129
revenueEstimate: 5.637377
revenueActual: 2.302136
year: 0
quarter: 6
- date: 2000-01-23
symbol: symbol
epsActual: 5.962134
hour: hour
epsEstimate: 1.4658129
revenueEstimate: 5.637377
revenueActual: 2.302136
year: 0
quarter: 6
properties:
earningsCalendar:
description: Array of earnings release.
items:
$ref: '#/components/schemas/EarningRelease'
type: array
type: object
Quote:
example:
c: 5.962134
pc: 5.637377
d: 2.302136
h: 6.0274563
l: 1.4658129
dp: 7.0614014
o: 0.8008282
properties:
o:
description: Open price of the day
format: float
type: number
h:
description: High price of the day
format: float
type: number
l:
description: Low price of the day
format: float
type: number
c:
description: Current price
format: float
type: number
pc:
description: Previous close price
format: float
type: number
d:
description: Change
format: float
type: number
dp:
description: Percent change
format: float
type: number
type: object
StockCandles:
example:
c:
- 5.962134
- 5.962134
s: s
t:
- 2
- 2
v:
- 5.637377
- 5.637377
h:
- 6.0274563
- 6.0274563
l:
- 1.4658129
- 1.4658129
o:
- 0.8008282
- 0.8008282
properties:
o:
description: List of open prices for returned candles.
items:
format: float
type: number
type: array
h:
description: List of high prices for returned candles.
items:
format: float
type: number
type: array
l:
description: List of low prices for returned candles.
items:
format: float
type: number
type: array
c:
description: List of close prices for returned candles.
items:
format: float
type: number
type: array
v:
description: List of volume data for returned candles.
items:
format: float
type: number
type: array
t:
description: List of timestamp for returned candles.
items:
format: int64
type: integer
type: array
s:
description: Status of the response. This field can either be ok or no_data.
type: string
type: object
TickData:
example:
p:
- 5.637377
- 5.637377
total: 1
s: s
c:
- - c
- c
- - c
- c
t:
- 2
- 2
v:
- 5.962134
- 5.962134
count: 6
x:
- x
- x
skip: 0
properties:
s:
description: Symbol.
type: string
skip:
description: Number of ticks skipped.
format: int64
type: integer
count:
description: Number of ticks returned. If count < limit,
all data for that date has been returned.
format: int64
type: integer
total:
description: Total number of ticks for that date.
format: int64
type: integer
v:
description: List of volume data.
items:
format: float
type: number
type: array
p:
description: List of price data.
items:
format: float
type: number
type: array
t:
description: List of timestamp in UNIX ms.
items:
format: int64
type: integer
type: array
x:
description: List of venues/exchanges. A list of exchange codes can be found
here
items:
type: string
type: array
c:
description: List of trade conditions. A comprehensive list of trade conditions
code can be found here
items:
items:
type: string
type: array
type: array
type: object
HistoricalNBBO:
example:
a:
- 5.637377
- 5.637377
total: 1
b:
- 7.0614014
- 7.0614014
s: s
c:
- - c
- c
- - c
- c
bv:
- 2.302136
- 2.302136
t:
- 9
- 9
av:
- 5.962134
- 5.962134
bx:
- bx
- bx
ax:
- ax
- ax
count: 6
skip: 0
properties:
s:
description: Symbol.
type: string
skip:
description: Number of ticks skipped.
format: int64
type: integer
count:
description: Number of ticks returned. If count < limit,
all data for that date has been returned.
format: int64
type: integer
total:
description: Total number of ticks for that date.
format: int64
type: integer
av:
description: List of Ask volume data.
items:
format: float
type: number
type: array
a:
description: List of Ask price data.
items:
format: float
type: number
type: array
ax:
description: List of venues/exchanges - Ask price. A list of exchange codes
can be found here
items:
type: string
type: array
bv:
description: List of Bid volume data.
items:
format: float
type: number
type: array
b:
description: List of Bid price data.
items:
format: float
type: number
type: array
bx:
description: List of venues/exchanges - Bid price. A list of exchange codes
can be found here
items:
type: string
type: array
t:
description: List of timestamp in UNIX ms.
items:
format: int64
type: integer
type: array
c:
description: List of quote conditions. A comprehensive list of quote conditions
code can be found here
items:
items:
type: string
type: array
type: array
type: object
LastBid-Ask:
example:
a: 6.0274563
b: 0.8008282
bv: 1.4658129
t: 5
av: 5.962134
properties:
b:
description: Bid price.
format: float
type: number
a:
description: Ask price.
format: float
type: number
bv:
description: Bid volume.
format: float
type: number
av:
description: Ask volume.
format: float
type: number
t:
description: Reference UNIX timestamp in ms.
format: int64
type: integer
type: object
Split:
example:
date: 2000-01-23
symbol: symbol
fromFactor: 0.8008282
toFactor: 6.0274563
properties:
symbol:
description: Symbol.
type: string
date:
description: Split date.
format: date
type: string
fromFactor:
description: From factor.
format: float
type: number
toFactor:
description: To factor.
format: float
type: number
type: object
Dividends2:
example:
symbol: symbol
data:
- amount: 0.8008282
exDate: 2000-01-23
- amount: 0.8008282
exDate: 2000-01-23
properties:
symbol:
description: Symbol
type: string
data:
description: ""
items:
$ref: '#/components/schemas/Dividends2Info'
type: array
type: object
IndicesConstituents:
example:
symbol: symbol
constituents:
- constituents
- constituents
properties:
symbol:
description: Index's symbol.
type: string
constituents:
description: Array of constituents.
items:
type: string
type: array
type: object
IndexHistoricalConstituent:
example:
date: 2000-01-23
symbol: symbol
action: action
properties:
symbol:
description: Symbol
type: string
action:
description: add or remove.
type: string
date:
description: Date of joining or leaving the index.
format: date
type: string
type: object
IndicesHistoricalConstituents:
example:
historicalConstituents:
- date: 2000-01-23
symbol: symbol
action: action
- date: 2000-01-23
symbol: symbol
action: action
symbol: symbol
properties:
symbol:
description: Index's symbol.
type: string
historicalConstituents:
description: Array of historical constituents.
items:
$ref: '#/components/schemas/IndexHistoricalConstituent'
type: array
type: object
ETFProfileData:
example:
nav: 6.0274563
website: website
cusip: cusip
priceToEarnings: 5.962134
avgVolume: 2.302136
description: description
assetClass: assetClass
etfCompany: etfCompany
inceptionDate: 2000-01-23
expenseRatio: 1.4658129
name: name
aum: 0.8008282
domicile: domicile
trackingIndex: trackingIndex
priceToBook: 5.637377
investmentSegment: investmentSegment
navCurrency: navCurrency
isin: isin
properties:
name:
description: Name
type: string
assetClass:
description: Asset Class.
type: string
investmentSegment:
description: Investment Segment.
type: string
aum:
description: AUM.
format: float
type: number
nav:
description: NAV.
format: float
type: number
navCurrency:
description: NAV currency.
type: string
expenseRatio:
description: Expense ratio.
format: float
type: number
trackingIndex:
description: Tracking Index.
type: string
etfCompany:
description: ETF issuer.
type: string
domicile:
description: ETF domicile.
type: string
inceptionDate:
description: Inception date.
format: date
type: string
website:
description: ETF's website.
type: string
isin:
description: ISIN.
type: string
cusip:
description: CUSIP.
type: string
priceToEarnings:
description: P/E.
format: float
type: number
priceToBook:
description: P/B.
format: float
type: number
avgVolume:
description: 30-day average volume.
format: float
type: number
description:
description: ETF's description.
type: string
type: object
ETFsProfile:
example:
symbol: symbol
profile:
nav: 6.0274563
website: website
cusip: cusip
priceToEarnings: 5.962134
avgVolume: 2.302136
description: description
assetClass: assetClass
etfCompany: etfCompany
inceptionDate: 2000-01-23
expenseRatio: 1.4658129
name: name
aum: 0.8008282
domicile: domicile
trackingIndex: trackingIndex
priceToBook: 5.637377
investmentSegment: investmentSegment
navCurrency: navCurrency
isin: isin
properties:
symbol:
description: Symbol.
type: string
profile:
$ref: '#/components/schemas/ETFProfileData'
type: object
ETFHoldingsData:
example:
symbol: symbol
cusip: cusip
name: name
share: 6.0274563
percent: 1.4658129
value: 5.962134
isin: isin
properties:
symbol:
description: Symbol description
type: string
name:
description: Security name
type: string
isin:
description: ISIN.
type: string
cusip:
description: CUSIP.
type: string
share:
description: Number of shares owned by the ETF.
format: float
type: number
percent:
description: Portfolio's percent
format: float
type: number
value:
description: Market value
format: float
type: number
type: object
ETFsHoldings:
example:
symbol: symbol
atDate: 2000-01-23
holdings:
- symbol: symbol
cusip: cusip
name: name
share: 6.0274563
percent: 1.4658129
value: 5.962134
isin: isin
- symbol: symbol
cusip: cusip
name: name
share: 6.0274563
percent: 1.4658129
value: 5.962134
isin: isin
numberOfHoldings: 0
properties:
symbol:
description: ETF symbol.
type: string
atDate:
description: Holdings update date.
format: date
type: string
numberOfHoldings:
description: Number of holdings.
format: int64
type: integer
holdings:
description: Array of holdings.
items:
$ref: '#/components/schemas/ETFHoldingsData'
type: array
type: object
ETFSectorExposureData:
example:
exposure: 0.8008282
industry: industry
properties:
industry:
description: Industry
type: string
exposure:
description: Percent of exposure.
format: float
type: number
type: object
ETFsSectorExposure:
example:
symbol: symbol
sectorExposure:
- exposure: 0.8008282
industry: industry
- exposure: 0.8008282
industry: industry
properties:
symbol:
description: ETF symbol.
type: string
sectorExposure:
description: Array of industries and exposure levels.
items:
$ref: '#/components/schemas/ETFSectorExposureData'
type: array
type: object
ETFCountryExposureData:
example:
country: country
exposure: 0.8008282
properties:
country:
description: Country
type: string
exposure:
description: Percent of exposure.
format: float
type: number
type: object
ETFsCountryExposure:
example:
symbol: symbol
countryExposure:
- country: country
exposure: 0.8008282
- country: country
exposure: 0.8008282
properties:
symbol:
description: ETF symbol.
type: string
countryExposure:
description: Array of countries and and exposure levels.
items:
$ref: '#/components/schemas/ETFCountryExposureData'
type: array
type: object
MutualFundProfileData:
example:
cusip: cusip
manager: manager
iraMinInvestment: 7.0614014
totalNav: 0.8008282
deferredLoad: 5.962134
description: description
fee12b1: 5.637377
benchmark: benchmark
standardMinInvestment: 3.6160767
inceptionDate: 2000-01-23
frontLoad: 2.302136
expenseRatio: 6.0274563
name: name
category: category
turnover: 2.027123
investmentSegment: investmentSegment
fundFamily: fundFamily
beta: 1.4658129
isin: isin
status: status
maxRedemptionFee: 9.301444
properties:
name:
description: Name
type: string
category:
description: Fund's category.
type: string
investmentSegment:
description: Investment Segment.
type: string
totalNav:
description: NAV.
format: float
type: number
expenseRatio:
description: Expense ratio.
format: float
type: number
benchmark:
description: Index benchmark.
type: string
inceptionDate:
description: Inception date.
format: date
type: string
description:
description: Fund's description.
type: string
fundFamily:
description: Fund Family.
type: string
manager:
description: Fund's managers.
type: string
status:
description: Status.
type: string
beta:
description: Beta.
format: float
type: number
deferredLoad:
description: Deferred load.
format: float
type: number
fee12b1:
description: 12B-1 fee.
format: float
type: number
frontLoad:
description: Front Load.
format: float
type: number
iraMinInvestment:
description: IRA minimum investment.
format: float
type: number
isin:
description: ISIN.
type: string
cusip:
description: CUSIP.
type: string
maxRedemptionFee:
description: Max redemption fee.
format: float
type: number
standardMinInvestment:
description: Minimum investment for standard accounts.
format: float
type: number
turnover:
description: Turnover.
format: float
type: number
type: object
MutualFundProfile:
example:
symbol: symbol
profile:
cusip: cusip
manager: manager
iraMinInvestment: 7.0614014
totalNav: 0.8008282
deferredLoad: 5.962134
description: description
fee12b1: 5.637377
benchmark: benchmark
standardMinInvestment: 3.6160767
inceptionDate: 2000-01-23
frontLoad: 2.302136
expenseRatio: 6.0274563
name: name
category: category
turnover: 2.027123
investmentSegment: investmentSegment
fundFamily: fundFamily
beta: 1.4658129
isin: isin
status: status
maxRedemptionFee: 9.301444
properties:
symbol:
description: Symbol.
type: string
profile:
$ref: '#/components/schemas/MutualFundProfileData'
type: object
MutualFundHoldingsData:
example:
symbol: symbol
cusip: cusip
name: name
share: 6.0274563
percent: 1.4658129
value: 5.962134
isin: isin
properties:
symbol:
description: Symbol description
type: string
name:
description: Security name
type: string
isin:
description: ISIN.
type: string
cusip:
description: CUSIP.
type: string
share:
description: Number of shares.
format: float
type: number
percent:
description: Portfolio's percent
format: float
type: number
value:
description: Market value
format: float
type: number
type: object
MutualFundHoldings:
example:
symbol: symbol
atDate: 2000-01-23
holdings:
- symbol: symbol
cusip: cusip
name: name
share: 6.0274563
percent: 1.4658129
value: 5.962134
isin: isin
- symbol: symbol
cusip: cusip
name: name
share: 6.0274563
percent: 1.4658129
value: 5.962134
isin: isin
numberOfHoldings: 0
properties:
symbol:
description: Symbol.
type: string
atDate:
description: Holdings update date.
format: date
type: string
numberOfHoldings:
description: Number of holdings.
format: int64
type: integer
holdings:
description: Array of holdings.
items:
$ref: '#/components/schemas/MutualFundHoldingsData'
type: array
type: object
MutualFundSectorExposureData:
example:
exposure: 0.8008282
sector: sector
properties:
sector:
description: Sector
type: string
exposure:
description: Percent of exposure.
format: float
type: number
type: object
MutualFundSectorExposure:
example:
symbol: symbol
sectorExposure:
- exposure: 0.8008282
sector: sector
- exposure: 0.8008282
sector: sector
properties:
symbol:
description: Mutual symbol.
type: string
sectorExposure:
description: Array of sector and exposure levels.
items:
$ref: '#/components/schemas/MutualFundSectorExposureData'
type: array
type: object
MutualFundCountryExposureData:
example:
country: country
exposure: 0.8008282
properties:
country:
description: Country
type: string
exposure:
description: Percent of exposure.
format: float
type: number
type: object
MutualFundCountryExposure:
example:
symbol: symbol
countryExposure:
- country: country
exposure: 0.8008282
- country: country
exposure: 0.8008282
properties:
symbol:
description: Symbol.
type: string
countryExposure:
description: Array of countries and and exposure levels.
items:
$ref: '#/components/schemas/MutualFundCountryExposureData'
type: array
type: object
ForexSymbol:
example:
displaySymbol: displaySymbol
symbol: symbol
description: description
properties:
description:
description: Symbol description
type: string
displaySymbol:
description: Display symbol name.
type: string
symbol:
description: Unique symbol used to identify this symbol used in /forex/candle
endpoint.
type: string
type: object
ForexCandles:
example:
c:
- 5.962134
- 5.962134
s: s
t:
- 2.302136
- 2.302136
v:
- 5.637377
- 5.637377
h:
- 6.0274563
- 6.0274563
l:
- 1.4658129
- 1.4658129
o:
- 0.8008282
- 0.8008282
properties:
o:
description: List of open prices for returned candles.
items:
format: float
type: number
type: array
h:
description: List of high prices for returned candles.
items:
format: float
type: number
type: array
l:
description: List of low prices for returned candles.
items:
format: float
type: number
type: array
c:
description: List of close prices for returned candles.
items:
format: float
type: number
type: array
v:
description: List of volume data for returned candles.
items:
format: float
type: number
type: array
t:
description: List of timestamp for returned candles.
items:
format: float
type: number
type: array
s:
description: Status of the response. This field can either be ok or no_data.
type: string
type: object
ForexRate:
type: object
Forexrates:
example:
quote: '{}'
base: base
properties:
base:
description: Base currency.
type: string
quote:
type: object
type: object
CryptoSymbol:
example:
displaySymbol: displaySymbol
symbol: symbol
description: description
properties:
description:
description: Symbol description
type: string
displaySymbol:
description: Display symbol name.
type: string
symbol:
description: Unique symbol used to identify this symbol used in /crypto/candle
endpoint.
type: string
type: object
CryptoCandles:
example:
c:
- 5.962134
- 5.962134
s: s
t:
- 2
- 2
v:
- 5.637377
- 5.637377
h:
- 6.0274563
- 6.0274563
l:
- 1.4658129
- 1.4658129
o:
- 0.8008282
- 0.8008282
properties:
o:
description: List of open prices for returned candles.
items:
format: float
type: number
type: array
h:
description: List of high prices for returned candles.
items:
format: float
type: number
type: array
l:
description: List of low prices for returned candles.
items:
format: float
type: number
type: array
c:
description: List of close prices for returned candles.
items:
format: float
type: number
type: array
v:
description: List of volume data for returned candles.
items:
format: float
type: number
type: array
t:
description: List of timestamp for returned candles.
items:
format: int64
type: integer
type: array
s:
description: Status of the response. This field can either be ok or no_data.
type: string
type: object
ScanPattern:
type: object
PatternRecognition:
example:
points:
- null
- null
properties:
points:
description: Array of patterns.
items:
$ref: '#/components/schemas/ScanPattern'
type: array
type: object
SupportResistance:
example:
levels:
- 0.8008282
- 0.8008282
properties:
levels:
description: Array of support and resistance levels.
items:
format: float
type: number
type: array
type: object
Indicator:
example:
buy: 0
sell: 1
neutral: 6
properties:
buy:
description: Number of buy signals
format: int64
type: integer
neutral:
description: Number of neutral signals
format: int64
type: integer
sell:
description: Number of sell signals
format: int64
type: integer
type: object
TechnicalAnalysis:
example:
count:
buy: 0
sell: 1
neutral: 6
signal: signal
properties:
count:
$ref: '#/components/schemas/Indicator'
signal:
description: Aggregate Signal
type: string
type: object
Trend:
example:
trending: true
adx: 5.962134
properties:
adx:
description: ADX reading
format: float
type: number
trending:
description: Whether market is trending or going sideway
type: boolean
type: object
AggregateIndicators:
example:
trend:
trending: true
adx: 5.962134
technicalAnalysis:
count:
buy: 0
sell: 1
neutral: 6
signal: signal
properties:
technicalAnalysis:
$ref: '#/components/schemas/TechnicalAnalysis'
trend:
$ref: '#/components/schemas/Trend'
type: object
TechnicalIndicator:
type: object
IndicatorFields:
type: object
StockTranscripts:
example:
year: 0
id: id
time: time
title: title
quarter: 6
properties:
id:
description: Transcript's ID used to get the full
transcript.
type: string
title:
description: Title.
type: string
time:
description: Time of the event.
type: string
year:
description: Year of earnings result in the case of earnings call transcript.
format: int64
type: integer
quarter:
description: Quarter of earnings result in the case of earnings call transcript.
format: int64
type: integer
type: object
EarningsCallTranscriptsList:
example:
symbol: symbol
transcripts:
- year: 0
id: id
time: time
title: title
quarter: 6
- year: 0
id: id
time: time
title: title
quarter: 6
properties:
symbol:
description: Company symbol.
type: string
transcripts:
description: Array of transcripts' metadata
items:
$ref: '#/components/schemas/StockTranscripts'
type: array
type: object
TranscriptContent:
example:
speech:
- speech
- speech
session: session
name: name
properties:
name:
description: Speaker's name
type: string
speech:
description: Speaker's speech
items:
type: string
type: array
session:
description: Earnings calls section (management discussion or Q&A)
type: string
type: object
TranscriptParticipant:
example:
role: role
name: name
description: description
properties:
name:
description: Participant's name
type: string
description:
description: Participant's description
type: string
role:
description: Whether the speak is a company's executive or an analyst
type: string
type: object
EarningsCallTranscripts:
example:
symbol: symbol
transcript:
- speech:
- speech
- speech
session: session
name: name
- speech:
- speech
- speech
session: session
name: name
year: 0
audio: audio
id: id
time: time
title: title
participant:
- role: role
name: name
description: description
- role: role
name: name
description: description
quarter: 6
properties:
symbol:
description: Company symbol.
type: string
transcript:
description: Transcript content.
items:
$ref: '#/components/schemas/TranscriptContent'
type: array
participant:
description: Participant list
items:
$ref: '#/components/schemas/TranscriptParticipant'
type: array
audio:
description: Audio link.
type: string
id:
description: Transcript's ID.
type: string
title:
description: Title.
type: string
time:
description: Time of the event.
type: string
year:
description: Year of earnings result in the case of earnings call transcript.
format: int64
type: integer
quarter:
description: Quarter of earnings result in the case of earnings call transcript.
format: int64
type: integer
type: object
RedditSentimentContent:
example:
positiveMention: 6
atTime: atTime
score: 2.302136
positiveScore: 5.962134
negativeMention: 1
negativeScore: 5.637377
mention: 0
properties:
mention:
description: Number of mentions
format: int64
type: integer
positiveMention:
description: Number of positive mentions
format: int64
type: integer
negativeMention:
description: Number of negative mentions
format: int64
type: integer
positiveScore:
description: Positive score. Range 0-1
format: float
type: number
negativeScore:
description: Negative score. Range 0-1
format: float
type: number
score:
description: 'Final score. Range: -1 to 1 with 1 is very positive and -1
is very negative'
format: float
type: number
atTime:
description: Period.
type: string
type: object
TwitterSentimentContent:
example:
positiveMention: 9
atTime: atTime
score: 7.386282
positiveScore: 2.027123
negativeMention: 3
negativeScore: 4.145608
mention: 7
properties:
mention:
description: Number of mentions
format: int64
type: integer
positiveMention:
description: Number of positive mentions
format: int64
type: integer
negativeMention:
description: Number of negative mentions
format: int64
type: integer
positiveScore:
description: Positive score. Range 0-1
format: float
type: number
negativeScore:
description: Negative score. Range 0-1
format: float
type: number
score:
description: 'Final score. Range: -1 to 1 with 1 is very positive and -1
is very negative'
format: float
type: number
atTime:
description: Period.
type: string
type: object
SocialSentiment:
example:
symbol: symbol
twitter:
- positiveMention: 9
atTime: atTime
score: 7.386282
positiveScore: 2.027123
negativeMention: 3
negativeScore: 4.145608
mention: 7
- positiveMention: 9
atTime: atTime
score: 7.386282
positiveScore: 2.027123
negativeMention: 3
negativeScore: 4.145608
mention: 7
reddit:
- positiveMention: 6
atTime: atTime
score: 2.302136
positiveScore: 5.962134
negativeMention: 1
negativeScore: 5.637377
mention: 0
- positiveMention: 6
atTime: atTime
score: 2.302136
positiveScore: 5.962134
negativeMention: 1
negativeScore: 5.637377
mention: 0
properties:
symbol:
description: Company symbol.
type: string
reddit:
description: Reddit sentiment.
items:
$ref: '#/components/schemas/RedditSentimentContent'
type: array
twitter:
description: Twitter sentiment.
items:
$ref: '#/components/schemas/TwitterSentimentContent'
type: array
type: object
InvestmentThemePortfolio:
example:
symbol: symbol
properties:
symbol:
description: Symbol
type: string
type: object
InvestmentThemes:
example:
data:
- symbol: symbol
- symbol: symbol
theme: theme
properties:
theme:
description: Investment theme
type: string
data:
description: Investment theme portfolio.
items:
$ref: '#/components/schemas/InvestmentThemePortfolio'
type: array
type: object
KeyCustomersSuppliers:
example:
symbol: symbol
supplier: true
name: name
customer: true
properties:
symbol:
description: Symbol
type: string
name:
description: Name
type: string
customer:
description: Whether the company is a customer.
type: boolean
supplier:
description: Whether the company is a supplier
type: boolean
type: object
SupplyChainRelationships:
example:
symbol: symbol
data:
- symbol: symbol
supplier: true
name: name
customer: true
- symbol: symbol
supplier: true
name: name
customer: true
properties:
symbol:
description: symbol
type: string
data:
description: Key customers and suppliers.
items:
$ref: '#/components/schemas/KeyCustomersSuppliers'
type: array
type: object
CovidInfo:
example:
death: 6.0274563
state: state
updated: updated
case: 0.8008282
properties:
state:
description: State.
type: string
case:
description: Number of confirmed cases.
format: float
type: number
death:
description: Number of confirmed deaths.
format: float
type: number
updated:
description: Updated time.
type: string
type: object
FDAComitteeMeeting:
example:
fromDate: fromDate
toDate: toDate
eventDescription: eventDescription
url: url
properties:
fromDate:
description: Start time of the event in EST.
type: string
toDate:
description: End time of the event in EST.
type: string
eventDescription:
description: Event's description.
type: string
url:
description: URL.
type: string
type: object
CountryMetadata:
example:
country: country
code3: code3
code2: code2
codeNo: codeNo
currency: currency
currencyCode: currencyCode
properties:
country:
description: Country name
type: string
code2:
description: Alpha 2 code
type: string
code3:
description: Alpha 3 code
type: string
codeNo:
description: UN code
type: string
currency:
description: Currency name
type: string
currencyCode:
description: Currency code
type: string
type: object
Economic event:
example:
actual: 0.8008282
country: country
unit: unit
prev: 6.0274563
impact: impact
estimate: 1.4658129
time: time
event: event
properties:
actual:
description: Actual release
format: float
type: number
prev:
description: Previous release
format: float
type: number
country:
description: Country
type: string
unit:
description: Unit
type: string
estimate:
description: Estimate
format: float
type: number
event:
description: Event
type: string
impact:
description: Impact level
type: string
time:
description: Release time
type: string
type: object
EconomicCalendar:
example:
economicCalendar:
- actual: 0.8008282
country: country
unit: unit
prev: 6.0274563
impact: impact
estimate: 1.4658129
time: time
event: event
- actual: 0.8008282
country: country
unit: unit
prev: 6.0274563
impact: impact
estimate: 1.4658129
time: time
event: event
properties:
economicCalendar:
description: Array of economic events.
items:
$ref: '#/components/schemas/Economic event'
type: array
type: object
EconomicCode:
example:
country: country
unit: unit
code: code
name: name
properties:
code:
description: Finnhub economic code used to get historical data
type: string
country:
description: Country
type: string
name:
description: Indicator name
type: string
unit:
description: Unit
type: string
type: object
EconomicDataInfo:
example:
date: date
value: 0.8008282
properties:
date:
description: Date of the reading
type: string
value:
description: Value
format: float
type: number
type: object
EconomicData:
example:
code: code
data:
- date: date
value: 0.8008282
- date: date
value: 0.8008282
properties:
data:
description: Array of economic data for requested code.
items:
$ref: '#/components/schemas/EconomicDataInfo'
type: array
code:
description: Finnhub economic code
type: string
type: object
securitySchemes:
api_key:
in: query
name: token
type: apiKey
x-original-swagger-version: "2.0"