Finance Tracker
Finance Tracker · GPT-Aktionen
Finnhub API
GET /searchSymbol LookupSearch for best-matching symbols based on your query. You can input anything from symbol, security's name to ISIN and Cusip.
GET /stock/symbolStock SymbolList supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>.
GET /stock/market-statusMarket StatusGet current market status for global exchanges (whether exchanges are open or close).
GET /stock/market-holidayMarket HolidayGet a list of holidays for global exchanges.
GET /stock/profileCompany ProfileGet general information of a company. You can query by symbol, ISIN or CUSIP
GET /stock/profile2Company Profile 2Get general information of a company. You can query by symbol, ISIN or CUSIP. This is the free version of <a href="#company-profile">Company Profile</a>.
GET /stock/executiveCompany ExecutiveGet a list of company's executives and members of the Board.
GET /newsMarket NewsGet latest market news.
GET /company-newsCompany NewsList latest company news by symbol. This endpoint is only available for North American companies.
GET /press-releasesMajor Press Releases<p>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.</p>
GET /news-sentimentNews SentimentGet company's news sentiment and statistics. This endpoint is only available for US companies.
GET /stock/peersPeersGet company peers. Return a list of peers operating in the same country and sector/industry.
GET /stock/metricBasic FinancialsGet company basic financials such as margin, P/E ratio, 52-week high/low etc.
GET /stock/price-metricPrice MetricsGet company price performance statistics such as 52-week high/low, YTD return and much more.
GET /ca/symbol-changeSymbol ChangeGet a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
GET /ca/isin-changeISIN ChangeGet a list of ISIN changes for EU-listed securities. Limit to 2000 events at a time.
GET /institutional/profileInstitutional ProfileGet a list of well-known institutional investors. Currently support 60+ profiles.
GET /institutional/portfolioInstitutional PortfolioGet the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time. You can get a list of supported CIK <a href="/api/v1/institutional/list?token=" target="_blank">here</a>.
GET /institutional/ownershipInstitutional OwnershipGet a list institutional investors' positions for a particular stock overtime. Data from 13-F filings. Limit to 1 year of data at a time.
GET /stock/ownershipOwnershipGet 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, 13G, UK Share Register, SEDI and other international markets.
GET /stock/fund-ownershipFund OwnershipGet 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, 13G, UK Share Register, SEDI and equivalent filings for other international markets.
GET /stock/insider-transactionsInsider TransactionsCompany insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, UK, Canada, Australia, India, and all major EU markets. Limit to 100 transactions per API call.
GET /stock/insider-sentimentInsider SentimentGet insider sentiment data for US companies calculated using method discussed https://medium.com/@stock-api/finnhub-insiders-sentiment-analysis-cc43f9f64b3a. The MSPR ranges from -100 for the most negative to 100 for the most positive which can signal price changes in the coming 30-90 days.
GET /stock/financialsFinancial Statements<p>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 <a href="#filings">SEC Filings</a> and <a href="#international-filings">International Filings</a> endpoints.
GET /stock/financials-reportedFinancials As ReportedGet financials as reported. This data is available for bulk download on <a href="https://www.kaggle.com/finnhub/reported-financials" target="_blank">Kaggle SEC Financials database</a>.
GET /stock/revenue-breakdownRevenue BreakdownGet revenue breakdown by product. This dataset is only available for US companies which disclose their revenue breakdown in the annual or quarterly reports.
GET /stock/filingsSEC FilingsList company's filing. Limit to 250 documents at a time. This data is available for bulk download on <a href="https://www.kaggle.com/finnhub/sec-filings" target="_blank">Kaggle SEC Filings database</a>.
GET /stock/filings-sentimentSEC Sentiment AnalysisGet 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.
GET /stock/similarity-indexSimilarity Index<p>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.</p>
GET /calendar/ipoIPO CalendarGet recent and upcoming IPO.
GET /sector/metricsSector MetricsGet ratios for different sectors and regions/indices.
GET /stock/dividendDividendsGet dividends data for common stocks going back 30 years.
GET /stock/recommendationRecommendation TrendsGet latest analyst recommendation trends for a company.
GET /stock/price-targetPrice TargetGet latest price target consensus.
GET /stock/upgrade-downgradeStock Upgrade/DowngradeGet latest stock upgrade and downgrade.
GET /stock/revenue-estimateRevenue EstimatesGet company's revenue estimates.
GET /stock/ebitda-estimateEBITDA EstimatesGet company's ebitda estimates.
GET /stock/ebit-estimateEBIT EstimatesGet company's ebit estimates.
GET /stock/eps-estimateEarnings EstimatesGet company's EPS estimates.
GET /stock/earningsEarnings SurprisesGet company historical quarterly earnings surprise going back to 2000.
GET /calendar/earningsEarnings CalendarGet 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.
GET /quoteQuote<p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time updates.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed.
GET /stock/candleStock Candles<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted. Only 1 month of intraday will be returned at a time. If you need more historical intraday data, please use the from and to params iteratively to request more data.</p>
GET /stock/tickTick Data<p>Get historical tick data for global exchanges.
GET /stock/bboHistorical NBBO<p>Get historical best bid and offer for US stocks, LSE, TSX, Euronext and Deutsche Borse.</p><p>For US market, this endpoint only serves historical NBBO from the beginning of 2020.
GET /stock/bidaskLast Bid-AskGet last bid/ask data for US stocks.
GET /stock/splitSplitsGet splits data for stocks.
GET /stock/dividend2Dividends 2 (Basic)Get global dividends data.
GET /index/constituentsIndices ConstituentsGet a list of index's constituents. A list of supported indices for this endpoint can be found <a href="/api/v1/index/list?token=" target="_blank">here</a>.
GET /index/historical-constituentsIndices Historical ConstituentsGet full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC</code>, <code>^NDX</code>, <code>^DJI</code>
GET /etf/profileETFs ProfileGet ETF profile information. This endpoint has global coverage. A list of supported ETFs can be found <a href="/api/v1/etf/list?token=" target="_blank">here</a>.
GET /etf/holdingsETFs HoldingsGet full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings. A list of supported ETFs can be found <a href="/api/v1/etf/list?token=" target="_blank">here</a>.
GET /etf/sectorETFs Sector ExposureGet ETF sector exposure data.
GET /etf/countryETFs Country ExposureGet ETF country exposure data.
GET /mutual-fund/profileMutual Funds ProfileGet mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href="/api/v1/mutual-fund/list?token=" target="_blank">here</a>.
GET /mutual-fund/holdingsMutual Funds HoldingsGet full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href="/api/v1/mutual-fund/list?token=" target="_blank">here</a>.
GET /mutual-fund/sectorMutual Funds Sector ExposureGet Mutual Funds sector exposure data.
GET /mutual-fund/countryMutual Funds Country ExposureGet Mutual Funds country exposure data.
GET /mutual-fund/eetMutual Funds EETGet EET data for EU funds. For PAIs data, please see the EET PAI endpoint.
GET /mutual-fund/eet-paiMutual Funds EET PAIGet EET PAI data for EU funds.
GET /forex/exchangeForex ExchangesList supported forex exchanges
GET /forex/symbolForex SymbolList supported forex symbols.
GET /forex/candleForex CandlesGet candlestick data for forex symbols.
GET /forex/ratesForex ratesGet rates for all forex pairs. Ideal for currency conversion
GET /crypto/exchangeCrypto ExchangesList supported crypto exchanges
GET /crypto/symbolCrypto SymbolList supported crypto symbols by exchange
GET /crypto/profileCrypto ProfileGet crypto's profile.
GET /crypto/candleCrypto CandlesGet candlestick data for crypto symbols.
GET /scan/patternPattern RecognitionRun pattern recognition algorithm on a symbol. Support double top/bottom, triple top/bottom, head and shoulders, triangle, wedge, channel, flag, and candlestick patterns.
GET /scan/support-resistanceSupport/ResistanceGet support and resistance levels for a symbol.
GET /scan/technical-indicatorAggregate IndicatorsGet aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v. A full list of indicators can be found <a href="https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing" target="_blank">here</a>.
GET /indicatorTechnical IndicatorsReturn technical indicator with price data. List of supported indicators can be found <a href="https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing" target="_blank">here</a>.
GET /stock/transcripts/listEarnings Call Transcripts ListList earnings call transcripts' metadata. This endpoint is available for US, UK, European, Australian and Canadian companies.
GET /stock/transcriptsEarnings Call Transcripts<p>Get earnings call transcripts, audio and participants' list. Data is available for US, UK, European, Australian and Canadian companies.<p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
GET /stock/social-sentimentSocial Sentiment<p>Get social sentiment for stocks on Reddit and Twitter.</p>
GET /stock/investment-themeInvestment Themes (Thematic Investing)<p>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.
GET /stock/supply-chainSupply Chain Relationships<p>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.</p>
GET /stock/esgCompany ESG Scores<p>This endpoint provides ESG scores and important indicators for 7000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p>
GET /stock/earnings-quality-scoreCompany Earnings Quality Score<p>This endpoint provides Earnings Quality Score for global companies.</p><p> Earnings quality refers to the extent to which current earnings predict future earnings. "High-quality" earnings are expected to persist, while "low-quality" earnings do not.
GET /covid19/usCOVID-19Get 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 <a href="https://rapidapi.com/Finnhub/api/finnhub-real-time-covid-19" target="_blank" rel="nofollow">here</a>
GET /fda-advisory-committee-calendarFDA Committee Meeting CalendarFDA'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.
GET /stock/uspto-patentUSPTO PatentsList USPTO patents for companies. Limit to 250 records per API call.
GET /stock/visa-applicationH1-B Visa ApplicationGet a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.
GET /stock/lobbyingSenate LobbyingGet a list of reported lobbying activities in the Senate and the House.
GET /stock/usa-spendingUSA SpendingGet a list of government's spending activities from USASpending dataset for public companies. This dataset can help you identify companies that win big government contracts which is extremely important for industries such as Defense, Aerospace, and Education.
GET /stock/congressional-tradingCongressional TradingGet stock trades data disclosed by members of congress.
GET /bond/profileBond ProfileGet general information of a bond. You can query by FIGI, ISIN or CUSIP. A list of supported bonds can be found <a href="/api/v1/bond/list?token=" target="_blank">here</a>.
GET /bond/priceBond price dataGet bond's price data. The following datasets are supported: Exchange, Segment, Delay, US Government Bonds, Government Bonds, End-of-day, FINRA Trace, BTDS: US Corporate Bonds, Delayed 4h, FINRA Trace, 144A Bonds, Delayed 4h
GET /bond/tickBond Tick DataGet trade-level data for bonds. The following datasets are supported: Exchange, Segment, Delay, FINRA Trace, BTDS: US Corporate Bonds, Delayed 4h, FINRA Trace, 144A Bonds, Delayed 4h.
GET /bond/yield-curveBond Yield CurveGet yield curve data for Treasury bonds.
GET /countryCountry MetadataList all countries and metadata.
GET /calendar/economicEconomic Calendar<p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
GET /economic/codeEconomic CodeList codes of supported economic data.
GET /economicEconomic DataGet economic data.
GET /stock/international-filingsInternational FilingsList filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage.
POST /global-filings/searchGlobal Filings Search<p>Search for best-matched filings across global companies' filings, transcripts and press releases. You can filter by anything from symbol, ISIN to form type, and document sources.</p><p>This endpoint will return a list of documents that match your search criteria.
POST /global-filings/search-in-filingSearch In Filing<p>Get a list of excerpts and highlight positions within a document using your query.</p>
GET /global-filings/filterSearch Filter<p>Get available values for each filter in search body.</p>
GET /global-filings/downloadDownload Filings<p>Download filings using document ids.</p>
Ursprüngliches API-Schema
{
"openapi": "3.0.1",
"info": {
"title": "Finnhub API",
"license": {
"name": "Apache-2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://finnhub.io/api/v1"
}
],
"paths": {
"/search": {
"get": {
"tags": [
"Default"
],
"summary": "Symbol Lookup",
"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": [
{
"name": "q",
"in": "query",
"description": "Query text can be symbol, name, isin, or cusip.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SymbolLookup"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/symbol": {
"get": {
"tags": [
"Default"
],
"summary": "Stock Symbol",
"description": "List supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>.",
"operationId": "stock-symbols",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange you want to get the list of symbols from. List of exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mic",
"in": "query",
"description": "Filter by MIC code.",
"schema": {
"type": "string"
}
},
{
"name": "securityType",
"in": "query",
"description": "Filter by security type used by OpenFigi standard.",
"schema": {
"type": "string"
}
},
{
"name": "currency",
"in": "query",
"description": "Filter by currency.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockSymbol"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/market-status": {
"get": {
"tags": [
"Default"
],
"summary": "Market Status",
"description": "Get current market status for global exchanges (whether exchanges are open or close).",
"operationId": "market-status",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange code.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarketStatus"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/market-holiday": {
"get": {
"tags": [
"Default"
],
"summary": "Market Holiday",
"description": "Get a list of holidays for global exchanges.",
"operationId": "market-holiday",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange code.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarketHoliday"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Company Profile",
"description": "Get general information of a company. You can query by symbol, ISIN or CUSIP",
"operationId": "company-profile_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL e.g.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ISIN",
"schema": {
"type": "string"
}
},
{
"name": "cusip",
"in": "query",
"description": "CUSIP",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/profile2": {
"get": {
"tags": [
"Default"
],
"summary": "Company Profile 2",
"description": "Get general information of a company. You can query by symbol, ISIN or CUSIP. This is the free version of <a href=\"#company-profile\">Company Profile</a>.",
"operationId": "company-profile2",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL e.g.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ISIN",
"schema": {
"type": "string"
}
},
{
"name": "cusip",
"in": "query",
"description": "CUSIP",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyProfile2"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/executive": {
"get": {
"tags": [
"Default"
],
"summary": "Company Executive",
"description": "Get a list of company's executives and members of the Board.",
"operationId": "company-executive_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyExecutive"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/news": {
"get": {
"tags": [
"Default"
],
"summary": "Market News",
"description": "Get latest market news.",
"operationId": "market-news",
"parameters": [
{
"name": "category",
"in": "query",
"description": "This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "minId",
"in": "query",
"description": "Use this field to get only news after this ID. Default to 0",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MarketNews"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/company-news": {
"get": {
"tags": [
"Default"
],
"summary": "Company News",
"description": "List latest company news by symbol. This endpoint is only available for North American companies.",
"operationId": "company-news",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyNews"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/press-releases": {
"get": {
"tags": [
"Default"
],
"summary": "Major Press Releases",
"description": "<p>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.</p>",
"operationId": "press-releases_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From time: 2020-01-01.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To time: 2020-01-05.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PressRelease"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/news-sentiment": {
"get": {
"tags": [
"Default"
],
"summary": "News Sentiment",
"description": "Get company's news sentiment and statistics. This endpoint is only available for US companies.",
"operationId": "news-sentiment_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsSentiment"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/peers": {
"get": {
"tags": [
"Default"
],
"summary": "Peers",
"description": "Get company peers. Return a list of peers operating in the same country and sector/industry.",
"operationId": "company-peers",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "grouping",
"in": "query",
"description": "Specify the grouping criteria for choosing peers.Supporter values: <code>sector</code>, <code>industry</code>, <code>subIndustry</code>. Default to <code>subIndustry</code>.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/metric": {
"get": {
"tags": [
"Default"
],
"summary": "Basic Financials",
"description": "Get company basic financials such as margin, P/E ratio, 52-week high/low etc.",
"operationId": "company-basic-financials",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "metric",
"in": "query",
"description": "Metric type. Can be 1 of the following values <code>all</code>",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BasicFinancials"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/price-metric": {
"get": {
"tags": [
"Default"
],
"summary": "Price Metrics",
"description": "Get company price performance statistics such as 52-week high/low, YTD return and much more.",
"operationId": "price-metrics_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Get data on a specific date in the past. The data is available weekly so your date will be automatically adjusted to the last day of that week.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PriceMetrics"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/ca/symbol-change": {
"get": {
"tags": [
"Default"
],
"summary": "Symbol Change",
"description": "Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.",
"operationId": "symbol-change_premium",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SymbolChange"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/ca/isin-change": {
"get": {
"tags": [
"Default"
],
"summary": "ISIN Change",
"description": "Get a list of ISIN changes for EU-listed securities. Limit to 2000 events at a time.",
"operationId": "isin-change_premium",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IsinChange"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/institutional/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Institutional Profile",
"description": "Get a list of well-known institutional investors. Currently support 60+ profiles.",
"operationId": "institutional-profile_premium",
"parameters": [
{
"name": "cik",
"in": "query",
"description": "Filter by CIK. Leave blank to get the full list.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstitutionalProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/institutional/portfolio": {
"get": {
"tags": [
"Default"
],
"summary": "Institutional Portfolio",
"description": "Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time. You can get a list of supported CIK <a href=\"/api/v1/institutional/list?token=\" target=\"_blank\">here</a>.",
"operationId": "institutional-portfolio_premium",
"parameters": [
{
"name": "cik",
"in": "query",
"description": "Fund's CIK.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstitutionalPortfolio"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/institutional/ownership": {
"get": {
"tags": [
"Default"
],
"summary": "Institutional Ownership",
"description": "Get a list institutional investors' positions for a particular stock overtime. Data from 13-F filings. Limit to 1 year of data at a time.",
"operationId": "institutional-ownership_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Filter by symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cusip",
"in": "query",
"description": "Filter by CUSIP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstitutionalOwnership"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/ownership": {
"get": {
"tags": [
"Default"
],
"summary": "Ownership",
"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, 13G, UK Share Register, SEDI and other international markets.",
"operationId": "ownership_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of results. Leave empty to get the full list.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ownership"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/fund-ownership": {
"get": {
"tags": [
"Default"
],
"summary": "Fund Ownership",
"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, 13G, UK Share Register, SEDI and equivalent filings for other international markets.",
"operationId": "fund-ownership_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of results. Leave empty to get the full list.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundOwnership"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/insider-transactions": {
"get": {
"tags": [
"Default"
],
"summary": "Insider Transactions",
"description": "Company insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, UK, Canada, Australia, India, and all major EU markets. Limit to 100 transactions per API call.",
"operationId": "insider-transactions",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL. Leave this param blank to get the latest transactions.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsiderTransactions"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/insider-sentiment": {
"get": {
"tags": [
"Default"
],
"summary": "Insider Sentiment",
"description": "Get insider sentiment data for US companies calculated using method discussed https://medium.com/@stock-api/finnhub-insiders-sentiment-analysis-cc43f9f64b3a. The MSPR ranges from -100 for the most negative to 100 for the most positive which can signal price changes in the coming 30-90 days.",
"operationId": "insider-sentiment",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsiderSentiments"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/financials": {
"get": {
"tags": [
"Default"
],
"summary": "Financial Statements",
"description": "<p>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 <a href=\"#filings\">SEC Filings</a> and <a href=\"#international-filings\">International Filings</a> endpoints.",
"operationId": "financials_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "statement",
"in": "query",
"description": "Statement can take 1 of these values <code>bs, ic, cf</code> for Balance Sheet, Income Statement, Cash Flow respectively.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Frequency can take 1 of these values <code>annual, quarterly, ttm, ytd</code>. TTM (Trailing Twelve Months) option is available for Income Statement and Cash Flow. YTD (Year To Date) option is only available for Cash Flow.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialStatements"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/financials-reported": {
"get": {
"tags": [
"Default"
],
"summary": "Financials As Reported",
"description": "Get financials as reported. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/reported-financials\" target=\"_blank\">Kaggle SEC Financials database</a>.",
"operationId": "financials-reported",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"schema": {
"type": "string"
}
},
{
"name": "cik",
"in": "query",
"description": "CIK.",
"schema": {
"type": "string"
}
},
{
"name": "accessNumber",
"in": "query",
"description": "Access number of a specific report you want to retrieve financials from.",
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>. Filter for endDate.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>. Filter for endDate.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialsAsReported"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/revenue-breakdown": {
"get": {
"tags": [
"Default"
],
"summary": "Revenue Breakdown",
"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_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"schema": {
"type": "string"
}
},
{
"name": "cik",
"in": "query",
"description": "CIK.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevenueBreakdown"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/filings": {
"get": {
"tags": [
"Default"
],
"summary": "SEC Filings",
"description": "List company's filing. Limit to 250 documents at a time. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/sec-filings\" target=\"_blank\">Kaggle SEC Filings database</a>.",
"operationId": "filings",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol. Leave <code>symbol</code>,<code>cik</code> and <code>accessNumber</code> empty to list latest filings.",
"schema": {
"type": "string"
}
},
{
"name": "cik",
"in": "query",
"description": "CIK.",
"schema": {
"type": "string"
}
},
{
"name": "accessNumber",
"in": "query",
"description": "Access number of a specific report you want to retrieve data from.",
"schema": {
"type": "string"
}
},
{
"name": "form",
"in": "query",
"description": "Filter by form. You can use this value <code>NT 10-K</code> to find non-timely filings for a company.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Filing"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/filings-sentiment": {
"get": {
"tags": [
"Default"
],
"summary": "SEC Sentiment Analysis",
"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.",
"operationId": "filings-sentiment_premium",
"parameters": [
{
"name": "accessNumber",
"in": "query",
"description": "Access number of a specific report you want to retrieve data from.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SECSentimentAnalysis"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/similarity-index": {
"get": {
"tags": [
"Default"
],
"summary": "Similarity Index",
"description": "<p>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.</p>",
"operationId": "similarity-index_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol. Required if cik is empty",
"schema": {
"type": "string"
}
},
{
"name": "cik",
"in": "query",
"description": "CIK. Required if symbol is empty",
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "<code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimilarityIndex"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/calendar/ipo": {
"get": {
"tags": [
"Default"
],
"summary": "IPO Calendar",
"description": "Get recent and upcoming IPO.",
"operationId": "ipo-calendar",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPOCalendar"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/sector/metrics": {
"get": {
"tags": [
"Default"
],
"summary": "Sector Metrics",
"description": "Get ratios for different sectors and regions/indices.",
"operationId": "sector-metric_premium",
"parameters": [
{
"name": "region",
"in": "query",
"description": "Region. A list of supported values for this field can be found <a href=\"https://docs.google.com/spreadsheets/d/1afedyv7yWJ-z7pMjaAZK-f6ENY3mI3EBCk95QffpoHw/edit?usp=sharing\" target=\"_blank\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectorMetric"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/dividend": {
"get": {
"tags": [
"Default"
],
"summary": "Dividends",
"description": "Get dividends data for common stocks going back 30 years.",
"operationId": "stock-dividends_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "YYYY-MM-DD.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "YYYY-MM-DD.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dividends"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/recommendation": {
"get": {
"tags": [
"Default"
],
"summary": "Recommendation Trends",
"description": "Get latest analyst recommendation trends for a company.",
"operationId": "recommendation-trends",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecommendationTrend"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/price-target": {
"get": {
"tags": [
"Default"
],
"summary": "Price Target",
"description": "Get latest price target consensus.",
"operationId": "price-target_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PriceTarget"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/upgrade-downgrade": {
"get": {
"tags": [
"Default"
],
"summary": "Stock Upgrade/Downgrade",
"description": "Get latest stock upgrade and downgrade.",
"operationId": "upgrade-downgrade_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL. If left blank, the API will return latest stock upgrades/downgrades.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date: 2000-03-15.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpgradeDowngrade"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/revenue-estimate": {
"get": {
"tags": [
"Default"
],
"summary": "Revenue Estimates",
"description": "Get company's revenue estimates.",
"operationId": "company-revenue-estimates_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevenueEstimates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/ebitda-estimate": {
"get": {
"tags": [
"Default"
],
"summary": "EBITDA Estimates",
"description": "Get company's ebitda estimates.",
"operationId": "company-ebitda-estimates_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EbitdaEstimates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/ebit-estimate": {
"get": {
"tags": [
"Default"
],
"summary": "EBIT Estimates",
"description": "Get company's ebit estimates.",
"operationId": "company-ebit-estimates_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EbitEstimates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/eps-estimate": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Estimates",
"description": "Get company's EPS estimates.",
"operationId": "company-eps-estimates_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsEstimates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/earnings": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Surprises",
"description": "Get company historical quarterly earnings surprise going back to 2000.",
"operationId": "company-earnings",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of period returned. Leave blank to get the full history.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EarningResult"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/calendar/earnings": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Calendar",
"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.",
"operationId": "earnings-calendar",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "symbol",
"in": "query",
"description": "Filter by symbol: AAPL.",
"schema": {
"type": "string"
}
},
{
"name": "international",
"in": "query",
"description": "Set to <code>true</code> to include international markets. Default value is <code>false</code>",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCalendar"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/quote": {
"get": {
"tags": [
"Default"
],
"summary": "Quote",
"description": "<p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time updates.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed.",
"operationId": "quote",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Quote"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/candle": {
"get": {
"tags": [
"Default"
],
"summary": "Stock Candles",
"description": "<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted. Only 1 month of intraday will be returned at a time. If you need more historical intraday data, please use the from and to params iteratively to request more data.</p>",
"operationId": "stock-candles",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockCandles"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/tick": {
"get": {
"tags": [
"Default"
],
"summary": "Tick Data",
"description": "<p>Get historical tick data for global exchanges.",
"operationId": "stock-tick_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Date: 2020-04-02.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of ticks returned. Maximum value: <code>25000</code>",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of ticks to skip. Use this parameter to loop through the entire data.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TickData"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/bbo": {
"get": {
"tags": [
"Default"
],
"summary": "Historical NBBO",
"description": "<p>Get historical best bid and offer for US stocks, LSE, TSX, Euronext and Deutsche Borse.</p><p>For US market, this endpoint only serves historical NBBO from the beginning of 2020.",
"operationId": "stock-nbbo_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Date: 2020-04-02.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of ticks returned. Maximum value: <code>25000</code>",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of ticks to skip. Use this parameter to loop through the entire data.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoricalNBBO"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/bidask": {
"get": {
"tags": [
"Default"
],
"summary": "Last Bid-Ask",
"description": "Get last bid/ask data for US stocks.",
"operationId": "stock-bidask_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LastBid-Ask"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/split": {
"get": {
"tags": [
"Default"
],
"summary": "Splits",
"description": "Get splits data for stocks.",
"operationId": "stock-splits_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "YYYY-MM-DD.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "YYYY-MM-DD.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Split"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/dividend2": {
"get": {
"tags": [
"Default"
],
"summary": "Dividends 2 (Basic)",
"description": "Get global dividends data.",
"operationId": "stock-basic-dividends_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dividends2"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/index/constituents": {
"get": {
"tags": [
"Default"
],
"summary": "Indices Constituents",
"description": "Get a list of index's constituents. A list of supported indices for this endpoint can be found <a href=\"/api/v1/index/list?token=\" target=\"_blank\">here</a>.",
"operationId": "indices-constituents_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "symbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndicesConstituents"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/index/historical-constituents": {
"get": {
"tags": [
"Default"
],
"summary": "Indices Historical Constituents",
"description": "Get full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC</code>, <code>^NDX</code>, <code>^DJI</code>",
"operationId": "indices-historical-constituents_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "symbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndicesHistoricalConstituents"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/etf/profile": {
"get": {
"tags": [
"Default"
],
"summary": "ETFs Profile",
"description": "Get ETF profile information. This endpoint has global coverage. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.",
"operationId": "etfs-profile_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "ETF symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ETF isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETFsProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/etf/holdings": {
"get": {
"tags": [
"Default"
],
"summary": "ETFs Holdings",
"description": "Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.",
"operationId": "etfs-holdings_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "ETF symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ETF isin.",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"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.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "date",
"in": "query",
"description": "Query holdings by date. You can use either this param or <code>skip</code> param, not both.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETFsHoldings"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/etf/sector": {
"get": {
"tags": [
"Default"
],
"summary": "ETFs Sector Exposure",
"description": "Get ETF sector exposure data.",
"operationId": "etfs-sector-exposure_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "ETF symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ETF isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETFsSectorExposure"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/etf/country": {
"get": {
"tags": [
"Default"
],
"summary": "ETFs Country Exposure",
"description": "Get ETF country exposure data.",
"operationId": "etfs-country-exposure_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "ETF symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ETF isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETFsCountryExposure"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds Profile",
"description": "Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.",
"operationId": "mutual-fund-profile_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Fund's symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "Fund's isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/holdings": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds Holdings",
"description": "Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.",
"operationId": "mutual-fund-holdings_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Fund's symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "Fund's isin.",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"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.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundHoldings"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/sector": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds Sector Exposure",
"description": "Get Mutual Funds sector exposure data.",
"operationId": "mutual-fund-sector-exposure_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Mutual Fund symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "Fund's isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundSectorExposure"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/country": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds Country Exposure",
"description": "Get Mutual Funds country exposure data.",
"operationId": "mutual-fund-country-exposure_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "Fund's isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundCountryExposure"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/eet": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds EET",
"description": "Get EET data for EU funds. For PAIs data, please see the EET PAI endpoint.",
"operationId": "mutual-fund-eet_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundEet"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/eet-pai": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds EET PAI",
"description": "Get EET PAI data for EU funds.",
"operationId": "mutual-fund-eet-pai_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundEetPai"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/forex/exchange": {
"get": {
"tags": [
"Default"
],
"summary": "Forex Exchanges",
"description": "List supported forex exchanges",
"operationId": "forex-exchanges",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/forex/symbol": {
"get": {
"tags": [
"Default"
],
"summary": "Forex Symbol",
"description": "List supported forex symbols.",
"operationId": "forex-symbols",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange you want to get the list of symbols from.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForexSymbol"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/forex/candle": {
"get": {
"tags": [
"Default"
],
"summary": "Forex Candles",
"description": "Get candlestick data for forex symbols.",
"operationId": "forex-candles_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Use symbol returned in <code>/forex/symbol</code> endpoint for this field.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForexCandles"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/forex/rates": {
"get": {
"tags": [
"Default"
],
"summary": "Forex rates",
"description": "Get rates for all forex pairs. Ideal for currency conversion",
"operationId": "forex-rates_premium",
"parameters": [
{
"name": "base",
"in": "query",
"description": "Base currency. Default to EUR.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Date. Leave blank to get the latest data.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forexrates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/crypto/exchange": {
"get": {
"tags": [
"Default"
],
"summary": "Crypto Exchanges",
"description": "List supported crypto exchanges",
"operationId": "crypto-exchanges",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/crypto/symbol": {
"get": {
"tags": [
"Default"
],
"summary": "Crypto Symbol",
"description": "List supported crypto symbols by exchange",
"operationId": "crypto-symbols",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange you want to get the list of symbols from.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CryptoSymbol"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/crypto/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Crypto Profile",
"description": "Get crypto's profile.",
"operationId": "crypto-profile_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Crypto symbol such as BTC or ETH.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CryptoProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/crypto/candle": {
"get": {
"tags": [
"Default"
],
"summary": "Crypto Candles",
"description": "Get candlestick data for crypto symbols.",
"operationId": "crypto-candles",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Use symbol returned in <code>/crypto/symbol</code> endpoint for this field.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CryptoCandles"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/scan/pattern": {
"get": {
"tags": [
"Default"
],
"summary": "Pattern Recognition",
"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_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatternRecognition"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/scan/support-resistance": {
"get": {
"tags": [
"Default"
],
"summary": "Support/Resistance",
"description": "Get support and resistance levels for a symbol.",
"operationId": "support-resistance_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupportResistance"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/scan/technical-indicator": {
"get": {
"tags": [
"Default"
],
"summary": "Aggregate Indicators",
"description": "Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v. A full list of indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing\" target=\"_blank\">here</a>.",
"operationId": "aggregate-indicator_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "symbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateIndicators"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/indicator": {
"get": {
"tags": [
"Default"
],
"summary": "Technical Indicators",
"description": "Return technical indicator with price data. List of supported indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.",
"operationId": "technical-indicator",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "symbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "indicator",
"in": "query",
"description": "Indicator name. Full list can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Check out <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">this page</a> to see which indicators and params are supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndicatorFields"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TechnicalIndicator"
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "indicator_fields"
}
},
"/stock/transcripts/list": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Call Transcripts List",
"description": "List earnings call transcripts' metadata. This endpoint is available for US, UK, European, Australian and Canadian companies.",
"operationId": "transcripts-list_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol: AAPL. Leave empty to list the latest transcripts",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTranscriptsList"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/transcripts": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Call Transcripts",
"description": "<p>Get earnings call transcripts, audio and participants' list. Data is available for US, UK, European, Australian and Canadian companies.<p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>",
"operationId": "transcripts_premium",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTranscripts"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/social-sentiment": {
"get": {
"tags": [
"Default"
],
"summary": "Social Sentiment",
"description": "<p>Get social sentiment for stocks on Reddit and Twitter.</p>",
"operationId": "social-sentiment_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocialSentiment"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/investment-theme": {
"get": {
"tags": [
"Default"
],
"summary": "Investment Themes (Thematic Investing)",
"description": "<p>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.",
"operationId": "investment-themes_premium",
"parameters": [
{
"name": "theme",
"in": "query",
"description": "Investment theme. A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentThemes"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/supply-chain": {
"get": {
"tags": [
"Default"
],
"summary": "Supply Chain Relationships",
"description": "<p>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.</p>",
"operationId": "supply-chain-relationships_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplyChainRelationships"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/esg": {
"get": {
"tags": [
"Default"
],
"summary": "Company ESG Scores",
"description": "<p>This endpoint provides ESG scores and important indicators for 7000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p>",
"operationId": "company-esg-score_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyESG"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/earnings-quality-score": {
"get": {
"tags": [
"Default"
],
"summary": "Company Earnings Quality Score",
"description": "<p>This endpoint provides Earnings Quality Score for global companies.</p><p> Earnings quality refers to the extent to which current earnings predict future earnings. \"High-quality\" earnings are expected to persist, while \"low-quality\" earnings do not.",
"operationId": "company-earnings-quality-score_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Frequency. Currently support <code>annual</code> and <code>quarterly</code>",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyEarningsQualityScore"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/covid19/us": {
"get": {
"tags": [
"Default"
],
"summary": "COVID-19",
"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 <a href=\"https://rapidapi.com/Finnhub/api/finnhub-real-time-covid-19\" target=\"_blank\" rel=\"nofollow\">here</a>",
"operationId": "covid-19",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovidInfo"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/fda-advisory-committee-calendar": {
"get": {
"tags": [
"Default"
],
"summary": "FDA Committee Meeting Calendar",
"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.",
"operationId": "fda-committee-meeting-calendar",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FDAComitteeMeeting"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/uspto-patent": {
"get": {
"tags": [
"Default"
],
"summary": "USPTO Patents",
"description": "List USPTO patents for companies. Limit to 250 records per API call.",
"operationId": "stock-uspto-patent",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsptoPatentResult"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/visa-application": {
"get": {
"tags": [
"Default"
],
"summary": "H1-B Visa Application",
"description": "Get a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.",
"operationId": "stock-visa-application",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VisaApplicationResult"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/lobbying": {
"get": {
"tags": [
"Default"
],
"summary": "Senate Lobbying",
"description": "Get a list of reported lobbying activities in the Senate and the House.",
"operationId": "stock-lobbying",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LobbyingResult"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/usa-spending": {
"get": {
"tags": [
"Default"
],
"summary": "USA Spending",
"description": "Get a list of government's spending activities from USASpending dataset for public companies. This dataset can help you identify companies that win big government contracts which is extremely important for industries such as Defense, Aerospace, and Education.",
"operationId": "stock-usa-spending",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsaSpendingResult"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/congressional-trading": {
"get": {
"tags": [
"Default"
],
"summary": "Congressional Trading",
"description": "Get stock trades data disclosed by members of congress.",
"operationId": "congressional-trading_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CongressionalTrading"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bond/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Bond Profile",
"description": "Get general information of a bond. You can query by FIGI, ISIN or CUSIP. A list of supported bonds can be found <a href=\"/api/v1/bond/list?token=\" target=\"_blank\">here</a>.",
"operationId": "bond-profile_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN",
"schema": {
"type": "string"
}
},
{
"name": "cusip",
"in": "query",
"description": "CUSIP",
"schema": {
"type": "string"
}
},
{
"name": "figi",
"in": "query",
"description": "FIGI",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BondProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bond/price": {
"get": {
"tags": [
"Default"
],
"summary": "Bond price data",
"description": "Get bond's price data. The following datasets are supported: Exchange, Segment, Delay, US Government Bonds, Government Bonds, End-of-day, FINRA Trace, BTDS: US Corporate Bonds, Delayed 4h, FINRA Trace, 144A Bonds, Delayed 4h",
"operationId": "bond-price_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BondCandles"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bond/tick": {
"get": {
"tags": [
"Default"
],
"summary": "Bond Tick Data",
"description": "Get trade-level data for bonds. The following datasets are supported: Exchange, Segment, Delay, FINRA Trace, BTDS: US Corporate Bonds, Delayed 4h, FINRA Trace, 144A Bonds, Delayed 4h.",
"operationId": "bond-tick_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Date: 2020-04-02.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of ticks returned. Maximum value: <code>25000</code>",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of ticks to skip. Use this parameter to loop through the entire data.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "exchange",
"in": "query",
"description": "Currently support the following values: <code>trace</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BondTickData"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bond/yield-curve": {
"get": {
"tags": [
"Default"
],
"summary": "Bond Yield Curve",
"description": "Get yield curve data for Treasury bonds.",
"operationId": "bond-yield-curve_premium",
"parameters": [
{
"name": "code",
"in": "query",
"description": "Bond's code. You can find the list of supported code <a href=\"https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing\" target=\"_blank\" rel=\"noopener\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BondYieldCurve"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/country": {
"get": {
"tags": [
"Default"
],
"summary": "Country Metadata",
"description": "List all countries and metadata.",
"operationId": "country",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryMetadata"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/calendar/economic": {
"get": {
"tags": [
"Default"
],
"summary": "Economic Calendar",
"description": "<p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>",
"operationId": "economic-calendar_premium",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EconomicCalendar"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/economic/code": {
"get": {
"tags": [
"Default"
],
"summary": "Economic Code",
"description": "List codes of supported economic data.",
"operationId": "economic-code_premium",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EconomicCode"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/economic": {
"get": {
"tags": [
"Default"
],
"summary": "Economic Data",
"description": "Get economic data.",
"operationId": "economic-data_premium",
"parameters": [
{
"name": "code",
"in": "query",
"description": "Economic code.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EconomicData"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/international-filings": {
"get": {
"tags": [
"Default"
],
"summary": "International Filings",
"description": "List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage.",
"operationId": "international-filings_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol. Leave empty to list latest filings.",
"schema": {
"type": "string"
}
},
{
"name": "country",
"in": "query",
"description": "Filter by country using country's 2-letter code.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InternationalFiling"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/global-filings/search": {
"post": {
"tags": [
"Default"
],
"summary": "Global Filings Search",
"description": "<p>Search for best-matched filings across global companies' filings, transcripts and press releases. You can filter by anything from symbol, ISIN to form type, and document sources.</p><p>This endpoint will return a list of documents that match your search criteria.",
"operationId": "global-filings-search_premium",
"requestBody": {
"description": "Search body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchBody"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "search"
}
},
"/global-filings/search-in-filing": {
"post": {
"tags": [
"Default"
],
"summary": "Search In Filing",
"description": "<p>Get a list of excerpts and highlight positions within a document using your query.</p>",
"operationId": "search-in-filing_premium",
"requestBody": {
"description": "Search body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InFilingSearchBody"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InFilingResponse"
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "search"
}
},
"/global-filings/filter": {
"get": {
"tags": [
"Default"
],
"summary": "Search Filter",
"description": "<p>Get available values for each filter in search body.</p>",
"operationId": "global-filings-search-filter_premium",
"parameters": [
{
"name": "field",
"in": "query",
"description": "Field to get available filters. Available filters are \"countries\", \"exchanges\", \"exhibits\", \"forms\", \"gics\", \"naics\", \"caps\", \"acts\", and \"sort\".",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Get available forms for each source.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchFilter"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/global-filings/download": {
"get": {
"tags": [
"Default"
],
"summary": "Download Filings",
"description": "<p>Download filings using document ids.</p>",
"operationId": "global-filings-download_premium",
"parameters": [
{
"name": "documentId",
"in": "query",
"description": "Document's id. Note that this is different from filingId as 1 filing can contain multiple documents.",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"api_key": []
}
]
}
}
},
"components": {
"schemas": {
"SearchBody": {
"required": [
"query"
],
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Search query"
},
"isins": {
"type": "string",
"description": "List of isin to search, comma separated (Max: 50)."
},
"cusips": {
"type": "string",
"description": "List of cusip to search, comma separated (Max: 50)."
},
"ciks": {
"type": "string",
"description": "List of SEC Center Index Key to search, comma separated (Max: 50)."
},
"sedarIds": {
"type": "string",
"description": "List of SEDAR issuer number to search, comma separated (Max: 50)."
},
"chIds": {
"type": "string",
"description": "List of Companies House number to search, comma separated (Max: 50)."
},
"symbols": {
"type": "string",
"description": "List of symbols to search, comma separated (Max: 50)."
},
"sedols": {
"type": "string",
"description": "List of sedols to search, comma separated (Max: 50)."
},
"sources": {
"type": "string",
"description": "List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"forms": {
"type": "string",
"description": "List of forms to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"gics": {
"type": "string",
"description": "List of gics to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"naics": {
"type": "string",
"description": "List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"exhibits": {
"type": "string",
"description": "List of exhibits to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"exchanges": {
"type": "string",
"description": "List of exchanges to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"countries": {
"type": "string",
"description": "List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"acts": {
"type": "string",
"description": "List of SEC's exchanges act to search, comma separated. Look at <code>/filter</code> endpoint to see all available values."
},
"caps": {
"type": "string",
"description": "List of market capitalization to search, comma separated. Look at <code>/filter</code> endpoint to see all available values."
},
"fromDate": {
"type": "string",
"description": "Search from date in format: YYYY-MM-DD, default from the last 2 years"
},
"toDate": {
"type": "string",
"description": "Search to date in format: YYYY-MM-DD, default to today"
},
"page": {
"type": "string",
"description": "Use for pagination, default to page 1"
},
"sort": {
"type": "string",
"description": "Sort result by, default: sortMostRecent. Look at <code>/filter</code> endpoint to see all available values."
},
"highlighted": {
"type": "boolean",
"description": "Enable highlight in returned filings. If enabled, only return 10 results each time"
}
}
},
"InFilingSearchBody": {
"required": [
"filingId",
"query"
],
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Search query"
},
"filingId": {
"type": "string",
"description": "Filing Id to search"
}
}
},
"SearchResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Total filing matched your search criteria."
},
"took": {
"type": "integer",
"description": "Time took to execute your search query on our server, value in ms."
},
"page": {
"type": "integer",
"description": "Current search page"
},
"filings": {
"type": "array",
"description": "Filing match your search criteria.",
"items": {
"$ref": "#/components/schemas/FilingResponse"
}
}
}
},
"FilingResponse": {
"type": "object",
"properties": {
"filingId": {
"type": "string",
"description": "Filing Id in Alpharesearch platform"
},
"title": {
"type": "string",
"description": "Filing title"
},
"filerId": {
"type": "string",
"description": "Id of the entity submitted the filing"
},
"symbol": {
"type": "object",
"description": "List of symbol associate with this filing"
},
"name": {
"type": "string",
"description": "Filer name"
},
"acceptanceDate": {
"type": "string",
"description": "Date the filing is submitted."
},
"filedDate": {
"type": "string",
"description": "Date the filing is make available to the public"
},
"reportDate": {
"type": "string",
"description": "Date as which the filing is reported"
},
"form": {
"type": "string",
"description": "Filing Form"
},
"amend": {
"type": "boolean",
"description": "Amendment"
},
"source": {
"type": "string",
"description": "Filing Source"
},
"pageCount": {
"type": "integer",
"description": "Estimate number of page when printing"
},
"documentCount": {
"type": "integer",
"description": "Number of document in this filing"
}
}
},
"InFilingResponse": {
"type": "object",
"properties": {
"filingId": {
"type": "string",
"description": "Filing Id in Alpharesearch platform"
},
"title": {
"type": "string",
"description": "Filing title"
},
"filerId": {
"type": "string",
"description": "Id of the entity submitted the filing"
},
"symbol": {
"type": "object",
"description": "List of symbol associate with this filing"
},
"name": {
"type": "string",
"description": "Filer name"
},
"acceptanceDate": {
"type": "string",
"description": "Date the filing is submitted."
},
"filedDate": {
"type": "string",
"description": "Date the filing is make available to the public"
},
"reportDate": {
"type": "string",
"description": "Date as which the filing is reported"
},
"form": {
"type": "string",
"description": "Filing Form"
},
"amend": {
"type": "boolean",
"description": "Amendment"
},
"source": {
"type": "string",
"description": "Filing Source"
},
"pageCount": {
"type": "integer",
"description": "Estimate number of page when printing"
},
"documentCount": {
"type": "integer",
"description": "Number of document in this filing"
},
"documents": {
"type": "array",
"description": "Document for this filing.",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
}
},
"DocumentResponse": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "AlphaResearch internal document id."
},
"title": {
"type": "string",
"description": "Title for this document."
},
"hits": {
"type": "string",
"description": "Number of hit in this document"
},
"url": {
"type": "string",
"description": "Link to render this document"
},
"format": {
"type": "string",
"description": "Format of this document (can be html or pdf)"
},
"excerpts": {
"type": "array",
"description": "Highlighted excerpts for this document",
"items": {
"$ref": "#/components/schemas/ExcerptResponse"
}
}
}
},
"ExcerptResponse": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "Highlighted content"
},
"snippetId": {
"type": "string",
"description": "Location of the content in the rendered document"
},
"startOffset": {
"type": "string",
"description": "Start offset of highlighted content"
},
"endOffset": {
"type": "string",
"description": "End offset of highlighted content"
}
}
},
"SearchFilter": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Filter id, use with respective field in search query body."
},
"name": {
"type": "string",
"description": "Display name."
}
}
},
"StockSymbol": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Symbol description"
},
"displaySymbol": {
"type": "string",
"description": "Display symbol name."
},
"symbol": {
"type": "string",
"description": "Unique symbol used to identify this symbol used in <code>/stock/candle</code> endpoint."
},
"type": {
"type": "string",
"description": "Security type."
},
"mic": {
"type": "string",
"description": "Primary exchange's MIC."
},
"figi": {
"type": "string",
"description": "FIGI identifier."
},
"shareClassFIGI": {
"type": "string",
"description": "Global Share Class FIGI."
},
"currency": {
"type": "string",
"description": "Price's currency. This might be different from the reporting currency of fundamental data."
},
"symbol2": {
"type": "string",
"description": "Alternative ticker for exchanges with multiple tickers for 1 stock such as BSE."
},
"isin": {
"type": "string",
"description": "ISIN. This field is only available for EU stocks and selected Asian markets. Entitlement from Finnhub is required to access this field."
}
}
},
"SymbolLookup": {
"type": "object",
"properties": {
"result": {
"type": "array",
"description": "Array of search results.",
"items": {
"$ref": "#/components/schemas/SymbolLookupInfo"
}
},
"count": {
"type": "integer",
"description": "Number of results.",
"format": "int64"
}
}
},
"SymbolLookupInfo": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Symbol description"
},
"displaySymbol": {
"type": "string",
"description": "Display symbol name."
},
"symbol": {
"type": "string",
"description": "Unique symbol used to identify this symbol used in <code>/stock/candle</code> endpoint."
},
"type": {
"type": "string",
"description": "Security type."
}
}
},
"InstitutionalPortfolio": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Investor's name."
},
"cik": {
"type": "string",
"description": "CIK."
},
"data": {
"type": "array",
"description": "Array of positions.",
"items": {
"$ref": "#/components/schemas/InstitutionalPortfolioGroup"
}
}
}
},
"MarketStatus": {
"type": "object",
"properties": {
"exchange": {
"type": "string",
"description": "Exchange."
},
"timezone": {
"type": "string",
"description": "Timezone."
},
"session": {
"type": "string",
"description": "Market session."
},
"holiday": {
"type": "string",
"description": "Holiday event."
},
"isOpen": {
"type": "boolean",
"description": "Whether the market is open at the moment."
},
"t": {
"type": "integer",
"description": "Current timestamp.",
"format": "int64"
}
}
},
"MarketHolidayData": {
"type": "object",
"properties": {
"eventName": {
"type": "string",
"description": "Holiday's name."
},
"atDate": {
"type": "string",
"description": "Date."
},
"tradingHour": {
"type": "string",
"description": "Trading hours for this day if the market is partially closed only."
}
}
},
"MarketHoliday": {
"type": "object",
"properties": {
"timezone": {
"type": "string",
"description": "Timezone."
},
"exchange": {
"type": "string",
"description": "Exchange."
},
"data": {
"type": "array",
"description": "Array of holidays.",
"items": {
"$ref": "#/components/schemas/MarketHolidayData"
}
}
}
},
"CompanyProfile": {
"type": "object",
"properties": {
"alias": {
"type": "array",
"description": "Company name alias.",
"items": {
"type": "string"
}
},
"address": {
"type": "string",
"description": "Address of company's headquarter."
},
"city": {
"type": "string",
"description": "City of company's headquarter."
},
"country": {
"type": "string",
"description": "Country of company's headquarter."
},
"currency": {
"type": "string",
"description": "Currency used in company filings and financials."
},
"estimateCurrency": {
"type": "string",
"description": "Currency used in Estimates data."
},
"marketCapCurrency": {
"type": "string",
"description": "Currency used in market capitalization."
},
"cusip": {
"type": "string",
"description": "CUSIP number."
},
"sedol": {
"type": "string",
"description": "Sedol number."
},
"description": {
"type": "string",
"description": "Company business summary."
},
"exchange": {
"type": "string",
"description": "Listed exchange."
},
"ggroup": {
"type": "string",
"description": "Industry group."
},
"gind": {
"type": "string",
"description": "Industry."
},
"gsector": {
"type": "string",
"description": "Sector."
},
"gsubind": {
"type": "string",
"description": "Sub-industry."
},
"isin": {
"type": "string",
"description": "ISIN number."
},
"lei": {
"type": "string",
"description": "LEI number."
},
"naicsNationalIndustry": {
"type": "string",
"description": "NAICS national industry."
},
"naics": {
"type": "string",
"description": "NAICS industry."
},
"naicsSector": {
"type": "string",
"description": "NAICS sector."
},
"naicsSubsector": {
"type": "string",
"description": "NAICS subsector."
},
"name": {
"type": "string",
"description": "Company name."
},
"phone": {
"type": "string",
"description": "Company phone number."
},
"state": {
"type": "string",
"description": "State of company's headquarter."
},
"ticker": {
"type": "string",
"description": "Company symbol/ticker as used on the listed exchange."
},
"weburl": {
"type": "string",
"description": "Company website."
},
"ipo": {
"type": "string",
"description": "IPO date.",
"format": "date"
},
"marketCapitalization": {
"type": "number",
"description": "Market Capitalization.",
"format": "float"
},
"shareOutstanding": {
"type": "number",
"description": "Number of oustanding shares.",
"format": "float"
},
"employeeTotal": {
"type": "number",
"description": "Number of employee.",
"format": "float"
},
"logo": {
"type": "string",
"description": "Logo image."
},
"finnhubIndustry": {
"type": "string",
"description": "Finnhub industry classification."
}
}
},
"CompanyProfile2": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country of company's headquarter."
},
"currency": {
"type": "string",
"description": "Currency used in company filings."
},
"exchange": {
"type": "string",
"description": "Listed exchange."
},
"name": {
"type": "string",
"description": "Company name."
},
"ticker": {
"type": "string",
"description": "Company symbol/ticker as used on the listed exchange."
},
"ipo": {
"type": "string",
"description": "IPO date.",
"format": "date"
},
"marketCapitalization": {
"type": "number",
"description": "Market Capitalization.",
"format": "float"
},
"shareOutstanding": {
"type": "number",
"description": "Number of oustanding shares.",
"format": "float"
},
"logo": {
"type": "string",
"description": "Logo image."
},
"phone": {
"type": "string",
"description": "Company phone number."
},
"weburl": {
"type": "string",
"description": "Company website."
},
"finnhubIndustry": {
"type": "string",
"description": "Finnhub industry classification."
}
}
},
"Company": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Executive name"
},
"age": {
"type": "integer",
"description": "Age",
"format": "int64"
},
"title": {
"type": "string",
"description": "Title"
},
"since": {
"type": "string",
"description": "Year first appointed as executive/director of the company"
},
"sex": {
"type": "string",
"description": "Sex"
},
"compensation": {
"type": "integer",
"description": "Total compensation",
"format": "int64"
},
"currency": {
"type": "string",
"description": "Compensation currency"
}
}
},
"CompanyExecutive": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"executive": {
"type": "array",
"description": "Array of company's executives and members of the Board.",
"items": {
"$ref": "#/components/schemas/Company"
}
}
}
},
"MarketNews": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "News category."
},
"datetime": {
"type": "integer",
"description": "Published time in UNIX timestamp.",
"format": "int64"
},
"headline": {
"type": "string",
"description": "News headline."
},
"id": {
"type": "integer",
"description": "News ID. This value can be used for <code>minId</code> params to get the latest news only.",
"format": "int64"
},
"image": {
"type": "string",
"description": "Thumbnail image URL."
},
"related": {
"type": "string",
"description": "Related stocks and companies mentioned in the article."
},
"source": {
"type": "string",
"description": "News source."
},
"summary": {
"type": "string",
"description": "News summary."
},
"url": {
"type": "string",
"description": "URL of the original article."
}
}
},
"CompanyNews": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "News category."
},
"datetime": {
"type": "integer",
"description": "Published time in UNIX timestamp.",
"format": "int64"
},
"headline": {
"type": "string",
"description": "News headline."
},
"id": {
"type": "integer",
"description": "News ID. This value can be used for <code>minId</code> params to get the latest news only.",
"format": "int64"
},
"image": {
"type": "string",
"description": "Thumbnail image URL."
},
"related": {
"type": "string",
"description": "Related stocks and companies mentioned in the article."
},
"source": {
"type": "string",
"description": "News source."
},
"summary": {
"type": "string",
"description": "News summary."
},
"url": {
"type": "string",
"description": "URL of the original article."
}
}
},
"Development": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"datetime": {
"type": "string",
"description": "Published time in <code>YYYY-MM-DD HH:MM:SS</code> format."
},
"headline": {
"type": "string",
"description": "Development headline."
},
"description": {
"type": "string",
"description": "Development description."
},
"url": {
"type": "string",
"description": "URL."
}
}
},
"PressRelease": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"majorDevelopment": {
"type": "array",
"description": "Array of major developments.",
"items": {
"$ref": "#/components/schemas/Development"
}
}
}
},
"CompanyNewsStatistics": {
"type": "object",
"properties": {
"articlesInLastWeek": {
"type": "integer",
"description": "",
"format": "int64"
},
"buzz": {
"type": "number",
"description": "",
"format": "float"
},
"weeklyAverage": {
"type": "number",
"description": "",
"format": "float"
}
}
},
"Sentiment": {
"type": "object",
"properties": {
"bearishPercent": {
"type": "number",
"description": "",
"format": "float"
},
"bullishPercent": {
"type": "number",
"description": "",
"format": "float"
}
}
},
"NewsSentiment": {
"type": "object",
"properties": {
"buzz": {
"$ref": "#/components/schemas/CompanyNewsStatistics"
},
"companyNewsScore": {
"type": "number",
"description": "News score.",
"format": "float"
},
"sectorAverageBullishPercent": {
"type": "number",
"description": "Sector average bullish percent.",
"format": "float"
},
"sectorAverageNewsScore": {
"type": "number",
"description": "Sectore average score.",
"format": "float"
},
"sentiment": {
"$ref": "#/components/schemas/Sentiment"
},
"symbol": {
"type": "string",
"description": "Requested symbol."
}
}
},
"MetricSeriesMap": {
"type": "object",
"properties": {}
},
"MetricMap": {
"type": "object",
"properties": {}
},
"PriceMetricMap": {
"type": "object",
"properties": {}
},
"BasicFinancials": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"metricType": {
"type": "string",
"description": "Metric type."
},
"series": {
"$ref": "#/components/schemas/MetricSeriesMap"
},
"metric": {
"$ref": "#/components/schemas/MetricMap"
}
}
},
"PriceMetrics": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"atDate": {
"type": "string",
"description": "Data date."
},
"data": {
"$ref": "#/components/schemas/PriceMetricMap"
}
}
},
"CongressionalTransaction": {
"type": "object",
"properties": {
"amountFrom": {
"type": "number",
"description": "Transaction amount from.",
"format": "float"
},
"amountTo": {
"type": "number",
"description": "Transaction amount to.",
"format": "float"
},
"assetName": {
"type": "string",
"description": "Asset name."
},
"filingDate": {
"type": "string",
"description": "Filing date."
},
"name": {
"type": "string",
"description": "Name of the representative."
},
"ownerType": {
"type": "string",
"description": "Owner Type."
},
"position": {
"type": "string",
"description": "Position."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"transactionDate": {
"type": "string",
"description": "Transaction date."
},
"transactionType": {
"type": "string",
"description": "Transaction type <code>Sale</code> or <code>Purchase</code>."
}
}
},
"CongressionalTrading": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"data": {
"type": "array",
"description": "Array of stock trades.",
"items": {
"$ref": "#/components/schemas/CongressionalTransaction"
}
}
}
},
"IsinChangeInfo": {
"type": "object",
"properties": {
"atDate": {
"type": "string",
"description": "Event's date."
},
"oldIsin": {
"type": "string",
"description": "Old ISIN."
},
"newIsin": {
"type": "string",
"description": "New ISIN."
}
}
},
"IsinChange": {
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "From date."
},
"toDate": {
"type": "string",
"description": "To date."
},
"data": {
"type": "array",
"description": "Array of ISIN change events.",
"items": {
"$ref": "#/components/schemas/IsinChangeInfo"
}
}
}
},
"SymbolChangeInfo": {
"type": "object",
"properties": {
"atDate": {
"type": "string",
"description": "Event's date."
},
"oldSymbol": {
"type": "string",
"description": "Old symbol."
},
"newSymbol": {
"type": "string",
"description": "New symbol."
}
}
},
"SymbolChange": {
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "From date."
},
"toDate": {
"type": "string",
"description": "To date."
},
"data": {
"type": "array",
"description": "Array of symbol change events.",
"items": {
"$ref": "#/components/schemas/SymbolChangeInfo"
}
}
}
},
"InstitutionalPortfolioInfo": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"name": {
"type": "string",
"description": "Position's name."
},
"putCall": {
"type": "string",
"description": "<code>put</code> or <code>call</code> for options."
},
"change": {
"type": "number",
"description": "Number of shares change.",
"format": "float"
},
"noVoting": {
"type": "number",
"description": "Number of shares with no voting rights.",
"format": "float"
},
"percentage": {
"type": "number",
"description": "Percentage of portfolio.",
"format": "float"
},
"share": {
"type": "number",
"description": "Number of shares.",
"format": "float"
},
"sharedVoting": {
"type": "number",
"description": "Number of shares with shared voting rights.",
"format": "float"
},
"soleVoting": {
"type": "number",
"description": "Number of shares with sole voting rights.",
"format": "float"
},
"value": {
"type": "number",
"description": "Position value.",
"format": "float"
}
}
},
"InstitutionalPortfolioGroup": {
"type": "object",
"properties": {
"reportDate": {
"type": "string",
"description": "Report date."
},
"filingDate": {
"type": "string",
"description": "Filing date."
},
"portfolio": {
"type": "array",
"description": "Array of positions.",
"items": {
"$ref": "#/components/schemas/InstitutionalPortfolioInfo"
}
}
}
},
"InstitutionalOwnershipInfo": {
"type": "object",
"properties": {
"cik": {
"type": "string",
"description": "Investor's company CIK."
},
"name": {
"type": "string",
"description": "Firm's name."
},
"putCall": {
"type": "string",
"description": "<code>put</code> or <code>call</code> for options."
},
"change": {
"type": "number",
"description": "Number of shares change.",
"format": "float"
},
"noVoting": {
"type": "number",
"description": "Number of shares with no voting rights.",
"format": "float"
},
"percentage": {
"type": "number",
"description": "Percentage of portfolio.",
"format": "float"
},
"share": {
"type": "number",
"description": "News score.",
"format": "float"
},
"sharedVoting": {
"type": "number",
"description": "Number of shares with shared voting rights.",
"format": "float"
},
"soleVoting": {
"type": "number",
"description": "Number of shares with sole voting rights.",
"format": "float"
},
"value": {
"type": "number",
"description": "Position value.",
"format": "float"
}
}
},
"InstitutionalOwnershipGroup": {
"type": "object",
"properties": {
"reportDate": {
"type": "string",
"description": "Report date."
},
"ownership": {
"type": "array",
"description": "Array of institutional investors.",
"items": {
"$ref": "#/components/schemas/InstitutionalOwnershipInfo"
}
}
}
},
"InstitutionalOwnership": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"cusip": {
"type": "string",
"description": "Cusip."
},
"data": {
"type": "array",
"description": "Array of institutional investors.",
"items": {
"$ref": "#/components/schemas/InstitutionalOwnershipGroup"
}
}
}
},
"InstitutionalProfileInfo": {
"type": "object",
"properties": {
"cik": {
"type": "string",
"description": "Investor's company CIK."
},
"firmType": {
"type": "string",
"description": "Firm type."
},
"manager": {
"type": "string",
"description": "Manager."
},
"philosophy": {
"type": "string",
"description": "Investing philosophy."
},
"profile": {
"type": "string",
"description": "Profile info."
},
"profileImg": {
"type": "string",
"description": "Profile image."
}
}
},
"InstitutionalProfile": {
"type": "object",
"properties": {
"cik": {
"type": "string",
"description": "CIK."
},
"data": {
"type": "array",
"description": "Array of investors.",
"items": {
"$ref": "#/components/schemas/InstitutionalProfileInfo"
}
}
}
},
"OwnershipInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Investor's name."
},
"share": {
"type": "integer",
"description": "Number of shares held by the investor.",
"format": "int64"
},
"change": {
"type": "integer",
"description": "Number of share changed (net buy or sell) from the last period.",
"format": "int64"
},
"filingDate": {
"type": "string",
"description": "Filing date.",
"format": "date"
}
}
},
"Ownership": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"ownership": {
"type": "array",
"description": "Array of investors with detailed information about their holdings.",
"items": {
"$ref": "#/components/schemas/OwnershipInfo"
}
}
}
},
"FundOwnershipInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Investor's name."
},
"share": {
"type": "integer",
"description": "Number of shares held by the investor.",
"format": "int64"
},
"change": {
"type": "integer",
"description": "Number of share changed (net buy or sell) from the last period.",
"format": "int64"
},
"filingDate": {
"type": "string",
"description": "Filing date.",
"format": "date"
},
"portfolioPercent": {
"type": "number",
"description": "Percent of the fund's portfolio comprised of the company's share.",
"format": "float"
}
}
},
"FundOwnership": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"ownership": {
"type": "array",
"description": "Array of investors with detailed information about their holdings.",
"items": {
"$ref": "#/components/schemas/FundOwnershipInfo"
}
}
}
},
"Transactions": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"name": {
"type": "string",
"description": "Insider's name."
},
"share": {
"type": "integer",
"description": "Number of shares held after the transaction.",
"format": "int64"
},
"change": {
"type": "integer",
"description": "Number of share changed from the last period. A positive value suggests a <code>BUY</code> transaction. A negative value suggests a <code>SELL</code> transaction.",
"format": "int64"
},
"filingDate": {
"type": "string",
"description": "Filing date.",
"format": "date"
},
"transactionDate": {
"type": "string",
"description": "Transaction date.",
"format": "date"
},
"transactionPrice": {
"type": "number",
"description": "Average transaction price.",
"format": "float"
},
"transactionCode": {
"type": "string",
"description": "Transaction code. A list of codes and their meanings can be found <a href=\"https://www.sec.gov/about/forms/form4data.pdf\" target=\"_blank\" rel=\"noopener\">here</a>."
}
}
},
"InsiderTransactions": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"data": {
"type": "array",
"description": "Array of insider transactions.",
"items": {
"$ref": "#/components/schemas/Transactions"
}
}
}
},
"InsiderSentimentsData": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"year": {
"type": "integer",
"description": "Year.",
"format": "int64"
},
"month": {
"type": "integer",
"description": "Month.",
"format": "int64"
},
"change": {
"type": "integer",
"description": "Net buying/selling from all insiders' transactions.",
"format": "int64"
},
"mspr": {
"type": "number",
"description": "Monthly share purchase ratio.",
"format": "float"
}
}
},
"InsiderSentiments": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"data": {
"type": "array",
"description": "Array of sentiment data.",
"items": {
"$ref": "#/components/schemas/InsiderSentimentsData"
}
}
}
},
"FinancialMap": {
"type": "object",
"properties": {}
},
"FinancialStatements": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"financials": {
"type": "array",
"description": "An array of map of key, value pairs containing the data for each period.",
"items": {
"$ref": "#/components/schemas/FinancialMap"
}
}
}
},
"ReportDataMap": {
"type": "object",
"properties": {}
},
"Report": {
"type": "object",
"properties": {
"accessNumber": {
"type": "string",
"description": "Access number."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"cik": {
"type": "string",
"description": "CIK."
},
"year": {
"type": "integer",
"description": "Year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Quarter.",
"format": "int64"
},
"form": {
"type": "string",
"description": "Form type."
},
"startDate": {
"type": "string",
"description": "Period start date <code>%Y-%m-%d %H:%M:%S</code>."
},
"endDate": {
"type": "string",
"description": "Period end date <code>%Y-%m-%d %H:%M:%S</code>."
},
"filedDate": {
"type": "string",
"description": "Filed date <code>%Y-%m-%d %H:%M:%S</code>."
},
"acceptedDate": {
"type": "string",
"description": "Accepted date <code>%Y-%m-%d %H:%M:%S</code>."
},
"report": {
"$ref": "#/components/schemas/ReportDataMap"
}
}
},
"FinancialsAsReported": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"cik": {
"type": "string",
"description": "CIK"
},
"data": {
"type": "array",
"description": "Array of filings.",
"items": {
"$ref": "#/components/schemas/Report"
}
}
}
},
"BreakdownItemMap": {
"type": "object",
"properties": {}
},
"BreakdownItem": {
"type": "object",
"properties": {
"accessNumber": {
"type": "string",
"description": "Access number of the report from which the data is sourced."
},
"breakdown": {
"$ref": "#/components/schemas/BreakdownItemMap"
}
}
},
"RevenueBreakdown": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"cik": {
"type": "string",
"description": "CIK"
},
"data": {
"type": "array",
"description": "Array of revenue breakdown over multiple periods.",
"items": {
"$ref": "#/components/schemas/BreakdownItem"
}
}
}
},
"Filing": {
"type": "object",
"properties": {
"accessNumber": {
"type": "string",
"description": "Access number."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"cik": {
"type": "string",
"description": "CIK."
},
"form": {
"type": "string",
"description": "Form type."
},
"filedDate": {
"type": "string",
"description": "Filed date <code>%Y-%m-%d %H:%M:%S</code>."
},
"acceptedDate": {
"type": "string",
"description": "Accepted date <code>%Y-%m-%d %H:%M:%S</code>."
},
"reportUrl": {
"type": "string",
"description": "Report's URL."
},
"filingUrl": {
"type": "string",
"description": "Filing's URL."
}
}
},
"InternationalFiling": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"companyName": {
"type": "string",
"description": "Company name."
},
"filedDate": {
"type": "string",
"description": "Filed date <code>%Y-%m-%d %H:%M:%S</code>."
},
"category": {
"type": "string",
"description": "Category."
},
"title": {
"type": "string",
"description": "Document's title."
},
"description": {
"type": "string",
"description": "Document's description."
},
"url": {
"type": "string",
"description": "Url."
},
"language": {
"type": "string",
"description": "Language."
},
"country": {
"type": "string",
"description": "Country."
}
}
},
"FilingSentiment": {
"type": "object",
"properties": {
"negative": {
"type": "number",
"description": "% of negative words in the filing.",
"format": "float"
},
"positive": {
"type": "number",
"description": "% of positive words in the filing.",
"format": "float"
},
"polarity": {
"type": "number",
"description": "% of polarity words in the filing.",
"format": "float"
},
"litigious": {
"type": "number",
"description": "% of litigious words in the filing.",
"format": "float"
},
"uncertainty": {
"type": "number",
"description": "% of uncertainty words in the filing.",
"format": "float"
},
"constraining": {
"type": "number",
"description": "% of constraining words in the filing.",
"format": "float"
},
"modal-weak": {
"type": "number",
"description": "% of modal-weak words in the filing.",
"format": "float"
},
"modal-strong": {
"type": "number",
"description": "% of modal-strong words in the filing.",
"format": "float"
},
"modal-moderate": {
"type": "number",
"description": "% of modal-moderate words in the filing.",
"format": "float"
}
}
},
"SECSentimentAnalysis": {
"type": "object",
"properties": {
"accessNumber": {
"type": "string",
"description": "Access number."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"cik": {
"type": "string",
"description": "CIK."
},
"sentiment": {
"$ref": "#/components/schemas/FilingSentiment"
}
}
},
"SimilarityIndexInfo": {
"type": "object",
"properties": {
"cik": {
"type": "string",
"description": "CIK."
},
"item1": {
"type": "number",
"description": "Cosine similarity of Item 1 (Business). This number is only available for Annual reports.",
"format": "float"
},
"item1a": {
"type": "number",
"description": "Cosine similarity of Item 1A (Risk Factors). This number is available for both Annual and Quarterly reports.",
"format": "float"
},
"item2": {
"type": "number",
"description": "Cosine similarity of Item 2 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Quarterly reports.",
"format": "float"
},
"item7": {
"type": "number",
"description": "Cosine similarity of Item 7 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Annual reports.",
"format": "float"
},
"item7a": {
"type": "number",
"description": "Cosine similarity of Item 7A (Quantitative and Qualitative Disclosures About Market Risk). This number is only available for Annual reports.",
"format": "float"
},
"accessNumber": {
"type": "string",
"description": "Access number."
},
"form": {
"type": "string",
"description": "Form type."
},
"filedDate": {
"type": "string",
"description": "Filed date <code>%Y-%m-%d %H:%M:%S</code>."
},
"acceptedDate": {
"type": "string",
"description": "Accepted date <code>%Y-%m-%d %H:%M:%S</code>."
},
"reportUrl": {
"type": "string",
"description": "Report's URL."
},
"filingUrl": {
"type": "string",
"description": "Filing's URL."
}
}
},
"SimilarityIndex": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"cik": {
"type": "string",
"description": "CIK."
},
"similarity": {
"type": "array",
"description": "Array of filings with its cosine similarity compared to the same report of the previous year.",
"items": {
"$ref": "#/components/schemas/SimilarityIndexInfo"
}
}
}
},
"IPOEvent": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"date": {
"type": "string",
"description": "IPO date.",
"format": "date"
},
"exchange": {
"type": "string",
"description": "Exchange."
},
"name": {
"type": "string",
"description": "Company's name."
},
"status": {
"type": "string",
"description": "IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code>"
},
"price": {
"type": "string",
"description": "Projected price or price range."
},
"numberOfShares": {
"type": "number",
"description": "Number of shares offered during the IPO.",
"format": "float"
},
"totalSharesValue": {
"type": "number",
"description": "Total shares value.",
"format": "float"
}
}
},
"IPOCalendar": {
"type": "object",
"properties": {
"ipoCalendar": {
"type": "array",
"description": "Array of IPO events.",
"items": {
"$ref": "#/components/schemas/IPOEvent"
}
}
}
},
"Dividends": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"date": {
"type": "string",
"description": "Ex-Dividend date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "Amount in local currency.",
"format": "float"
},
"adjustedAmount": {
"type": "number",
"description": "Adjusted dividend.",
"format": "float"
},
"payDate": {
"type": "string",
"description": "Pay date.",
"format": "date"
},
"recordDate": {
"type": "string",
"description": "Record date.",
"format": "date"
},
"declarationDate": {
"type": "string",
"description": "Declaration date.",
"format": "date"
},
"currency": {
"type": "string",
"description": "Currency."
},
"freq": {
"type": "string",
"description": "<p>Dividend frequency. Can be 1 of the following values:</p><ul>\n<li><code>0: Annually</code></li>\n<li><code>1: Monthly</code></li>\n<li><code>2: Quarterly</code></li>\n<li><code>3: Semi-annually</code></li>\n<li><code>4: Other/Unknown</code></li>\n<li><code>5: Bimonthly</code></li>\n<li><code>6: Trimesterly</code></li>\n<li><code>7: Weekly</code></li>\n</ul>"
}
}
},
"Dividends2Info": {
"type": "object",
"properties": {
"exDate": {
"type": "string",
"description": "Ex-Dividend date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "Amount in local currency.",
"format": "float"
}
}
},
"RecommendationTrend": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"buy": {
"type": "integer",
"description": "Number of recommendations that fall into the Buy category",
"format": "int64"
},
"hold": {
"type": "integer",
"description": "Number of recommendations that fall into the Hold category",
"format": "int64"
},
"period": {
"type": "string",
"description": "Updated period"
},
"sell": {
"type": "integer",
"description": "Number of recommendations that fall into the Sell category",
"format": "int64"
},
"strongBuy": {
"type": "integer",
"description": "Number of recommendations that fall into the Strong Buy category",
"format": "int64"
},
"strongSell": {
"type": "integer",
"description": "Number of recommendations that fall into the Strong Sell category",
"format": "int64"
}
}
},
"PriceTarget": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"targetHigh": {
"type": "number",
"description": "Highes analysts' target.",
"format": "float"
},
"targetLow": {
"type": "number",
"description": "Lowest analysts' target.",
"format": "float"
},
"targetMean": {
"type": "number",
"description": "Mean of all analysts' targets.",
"format": "float"
},
"targetMedian": {
"type": "number",
"description": "Median of all analysts' targets.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"lastUpdated": {
"type": "string",
"description": "Updated time of the data"
}
}
},
"UpgradeDowngrade": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"gradeTime": {
"type": "integer",
"description": "Upgrade/downgrade time in UNIX timestamp.",
"format": "int64"
},
"fromGrade": {
"type": "string",
"description": "From grade."
},
"toGrade": {
"type": "string",
"description": "To grade."
},
"company": {
"type": "string",
"description": "Company/analyst who did the upgrade/downgrade."
},
"action": {
"type": "string",
"description": "Action can take any of the following values: <code>up(upgrade), down(downgrade), main(maintains), init(initiate), reit(reiterate)</code>."
}
}
},
"RevenueEstimatesInfo": {
"type": "object",
"properties": {
"revenueAvg": {
"type": "number",
"description": "Average revenue estimates including Finnhub's proprietary estimates.",
"format": "float"
},
"revenueHigh": {
"type": "number",
"description": "Highest estimate.",
"format": "float"
},
"revenueLow": {
"type": "number",
"description": "Lowest estimate.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period.",
"format": "date"
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"RevenueEstimates": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of estimates",
"items": {
"$ref": "#/components/schemas/RevenueEstimatesInfo"
}
},
"freq": {
"type": "string",
"description": "Frequency: annual or quarterly."
},
"symbol": {
"type": "string",
"description": "Company symbol."
}
}
},
"EbitdaEstimatesInfo": {
"type": "object",
"properties": {
"ebitdaAvg": {
"type": "number",
"description": "Average EBITDA estimates including Finnhub's proprietary estimates.",
"format": "float"
},
"ebitdaHigh": {
"type": "number",
"description": "Highest estimate.",
"format": "float"
},
"ebitdaLow": {
"type": "number",
"description": "Lowest estimate.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period.",
"format": "date"
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"EbitdaEstimates": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of estimates",
"items": {
"$ref": "#/components/schemas/EbitdaEstimatesInfo"
}
},
"freq": {
"type": "string",
"description": "Frequency: annual or quarterly."
},
"symbol": {
"type": "string",
"description": "Company symbol."
}
}
},
"EbitEstimatesInfo": {
"type": "object",
"properties": {
"ebitAvg": {
"type": "number",
"description": "Average EBIT estimates including Finnhub's proprietary estimates.",
"format": "float"
},
"ebitHigh": {
"type": "number",
"description": "Highest estimate.",
"format": "float"
},
"ebitLow": {
"type": "number",
"description": "Lowest estimate.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period.",
"format": "date"
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"EbitEstimates": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of estimates",
"items": {
"$ref": "#/components/schemas/EbitEstimatesInfo"
}
},
"freq": {
"type": "string",
"description": "Frequency: annual or quarterly."
},
"symbol": {
"type": "string",
"description": "Company symbol."
}
}
},
"EarningsEstimatesInfo": {
"type": "object",
"properties": {
"epsAvg": {
"type": "number",
"description": "Average EPS estimates including Finnhub's proprietary estimates.",
"format": "float"
},
"epsHigh": {
"type": "number",
"description": "Highest estimate.",
"format": "float"
},
"epsLow": {
"type": "number",
"description": "Lowest estimate.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period.",
"format": "date"
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"EarningsEstimates": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of estimates",
"items": {
"$ref": "#/components/schemas/EarningsEstimatesInfo"
}
},
"freq": {
"type": "string",
"description": "Frequency: annual or quarterly."
},
"symbol": {
"type": "string",
"description": "Company symbol."
}
}
},
"EarningResult": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"description": "Actual earning result.",
"format": "float"
},
"estimate": {
"type": "number",
"description": "Estimated earning.",
"format": "float"
},
"surprise": {
"type": "number",
"description": "Surprise - The difference between actual and estimate.",
"format": "float"
},
"surprisePercent": {
"type": "number",
"description": "Surprise percent.",
"format": "float"
},
"period": {
"type": "string",
"description": "Reported period.",
"format": "date"
},
"symbol": {
"type": "string",
"description": "Company symbol."
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"EarningRelease": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"date": {
"type": "string",
"description": "Date.",
"format": "date"
},
"hour": {
"type": "string",
"description": "Indicates whether the earnings is announced before market open(<code>bmo</code>), after market close(<code>amc</code>), or during market hour(<code>dmh</code>)."
},
"year": {
"type": "integer",
"description": "Earnings year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Earnings quarter.",
"format": "int64"
},
"epsEstimate": {
"type": "number",
"description": "EPS estimate.",
"format": "float"
},
"epsActual": {
"type": "number",
"description": "EPS actual.",
"format": "float"
},
"revenueEstimate": {
"type": "number",
"description": "Revenue estimate including Finnhub's proprietary estimates.",
"format": "float"
},
"revenueActual": {
"type": "number",
"description": "Revenue actual.",
"format": "float"
}
}
},
"EarningsCalendar": {
"type": "object",
"properties": {
"earningsCalendar": {
"type": "array",
"description": "Array of earnings release.",
"items": {
"$ref": "#/components/schemas/EarningRelease"
}
}
}
},
"Quote": {
"type": "object",
"properties": {
"o": {
"type": "number",
"description": "Open price of the day",
"format": "float"
},
"h": {
"type": "number",
"description": "High price of the day",
"format": "float"
},
"l": {
"type": "number",
"description": "Low price of the day",
"format": "float"
},
"c": {
"type": "number",
"description": "Current price",
"format": "float"
},
"pc": {
"type": "number",
"description": "Previous close price",
"format": "float"
},
"d": {
"type": "number",
"description": "Change",
"format": "float"
},
"dp": {
"type": "number",
"description": "Percent change",
"format": "float"
}
}
},
"StockCandles": {
"type": "object",
"properties": {
"o": {
"type": "array",
"description": "List of open prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"h": {
"type": "array",
"description": "List of high prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"l": {
"type": "array",
"description": "List of low prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"c": {
"type": "array",
"description": "List of close prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"v": {
"type": "array",
"description": "List of volume data for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp for returned candles.",
"items": {
"type": "integer",
"format": "int64"
}
},
"s": {
"type": "string",
"description": "Status of the response. This field can either be ok or no_data."
}
}
},
"TickData": {
"type": "object",
"properties": {
"s": {
"type": "string",
"description": "Symbol."
},
"skip": {
"type": "integer",
"description": "Number of ticks skipped.",
"format": "int64"
},
"count": {
"type": "integer",
"description": "Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned.",
"format": "int64"
},
"total": {
"type": "integer",
"description": "Total number of ticks for that date.",
"format": "int64"
},
"v": {
"type": "array",
"description": "List of volume data.",
"items": {
"type": "number",
"format": "float"
}
},
"p": {
"type": "array",
"description": "List of price data.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp in UNIX ms.",
"items": {
"type": "integer",
"format": "int64"
}
},
"x": {
"type": "array",
"description": "List of venues/exchanges. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"c": {
"type": "array",
"description": "List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1PUxiSWPHSODbaTaoL2Vef6DgU-yFtlRGZf19oBb9Hp0/edit?usp=sharing\">here</a>",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"BondTickData": {
"type": "object",
"properties": {
"skip": {
"type": "integer",
"description": "Number of ticks skipped.",
"format": "int64"
},
"count": {
"type": "integer",
"description": "Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned.",
"format": "int64"
},
"total": {
"type": "integer",
"description": "Total number of ticks for that date.",
"format": "int64"
},
"v": {
"type": "array",
"description": "List of volume data.",
"items": {
"type": "number",
"format": "float"
}
},
"p": {
"type": "array",
"description": "List of price data.",
"items": {
"type": "number",
"format": "float"
}
},
"y": {
"type": "array",
"description": "List of yield data.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp in UNIX ms.",
"items": {
"type": "integer",
"format": "int64"
}
},
"si": {
"type": "array",
"description": "List of values showing the side (Buy/sell) of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"cp": {
"type": "array",
"description": "List of values showing the counterparty of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"rp": {
"type": "array",
"description": "List of values showing the reporting party of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"ats": {
"type": "array",
"description": "ATS flag. Y or empty",
"items": {
"type": "string"
}
},
"c": {
"type": "array",
"description": "List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\">here</a>",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"HistoricalNBBO": {
"type": "object",
"properties": {
"s": {
"type": "string",
"description": "Symbol."
},
"skip": {
"type": "integer",
"description": "Number of ticks skipped.",
"format": "int64"
},
"count": {
"type": "integer",
"description": "Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned.",
"format": "int64"
},
"total": {
"type": "integer",
"description": "Total number of ticks for that date.",
"format": "int64"
},
"av": {
"type": "array",
"description": "List of Ask volume data.",
"items": {
"type": "number",
"format": "float"
}
},
"a": {
"type": "array",
"description": "List of Ask price data.",
"items": {
"type": "number",
"format": "float"
}
},
"ax": {
"type": "array",
"description": "List of venues/exchanges - Ask price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"bv": {
"type": "array",
"description": "List of Bid volume data.",
"items": {
"type": "number",
"format": "float"
}
},
"b": {
"type": "array",
"description": "List of Bid price data.",
"items": {
"type": "number",
"format": "float"
}
},
"bx": {
"type": "array",
"description": "List of venues/exchanges - Bid price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"t": {
"type": "array",
"description": "List of timestamp in UNIX ms.",
"items": {
"type": "integer",
"format": "int64"
}
},
"c": {
"type": "array",
"description": "List of quote conditions. A comprehensive list of quote conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1iiA6e7Osdtai0oPMOUzgAIKXCsay89dFDmsegz6OpEg/edit?usp=sharing\">here</a>",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"LastBid-Ask": {
"type": "object",
"properties": {
"b": {
"type": "number",
"description": "Bid price.",
"format": "float"
},
"a": {
"type": "number",
"description": "Ask price.",
"format": "float"
},
"bv": {
"type": "number",
"description": "Bid volume.",
"format": "float"
},
"av": {
"type": "number",
"description": "Ask volume.",
"format": "float"
},
"t": {
"type": "integer",
"description": "Reference UNIX timestamp in ms.",
"format": "int64"
}
}
},
"Split": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"date": {
"type": "string",
"description": "Split date.",
"format": "date"
},
"fromFactor": {
"type": "number",
"description": "From factor.",
"format": "float"
},
"toFactor": {
"type": "number",
"description": "To factor.",
"format": "float"
}
}
},
"Dividends2": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"data": {
"type": "array",
"description": "",
"items": {
"$ref": "#/components/schemas/Dividends2Info"
}
}
}
},
"IndicesConstituents": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Index's symbol."
},
"constituents": {
"type": "array",
"description": "Array of constituents.",
"items": {
"type": "string"
}
},
"constituentsBreakdown": {
"type": "array",
"description": "Array of constituents' details.",
"items": {
"$ref": "#/components/schemas/IndicesConstituentsBreakdown"
}
}
}
},
"IndicesConstituentsBreakdown": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"name": {
"type": "string",
"description": "Name."
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "Cusip."
},
"shareClassFIGI": {
"type": "string",
"description": "Global Share Class FIGI."
},
"weight": {
"type": "number",
"description": "Weight.",
"format": "float"
}
}
},
"IndexHistoricalConstituent": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"action": {
"type": "string",
"description": "<code>add</code> or <code>remove</code>."
},
"date": {
"type": "string",
"description": "Date of joining or leaving the index.",
"format": "date"
}
}
},
"IndicesHistoricalConstituents": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Index's symbol."
},
"historicalConstituents": {
"type": "array",
"description": "Array of historical constituents.",
"items": {
"$ref": "#/components/schemas/IndexHistoricalConstituent"
}
}
}
},
"ETFProfileData": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"assetClass": {
"type": "string",
"description": "Asset Class."
},
"investmentSegment": {
"type": "string",
"description": "Investment Segment."
},
"aum": {
"type": "number",
"description": "AUM.",
"format": "float"
},
"nav": {
"type": "number",
"description": "NAV.",
"format": "float"
},
"navCurrency": {
"type": "string",
"description": "NAV currency."
},
"expenseRatio": {
"type": "number",
"description": "Expense ratio. For non-US funds, this is the <a href=\"https://www.esma.europa.eu/sites/default/files/library/2015/11/09_1028_final_kid_ongoing_charges_methodology_for_publication_u_2_.pdf\" target=\"_blank\">KID ongoing charges<a/>.",
"format": "float"
},
"trackingIndex": {
"type": "string",
"description": "Tracking Index."
},
"etfCompany": {
"type": "string",
"description": "ETF issuer."
},
"domicile": {
"type": "string",
"description": "ETF domicile."
},
"inceptionDate": {
"type": "string",
"description": "Inception date.",
"format": "date"
},
"website": {
"type": "string",
"description": "ETF's website."
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"priceToEarnings": {
"type": "number",
"description": "P/E.",
"format": "float"
},
"priceToBook": {
"type": "number",
"description": "P/B.",
"format": "float"
},
"avgVolume": {
"type": "number",
"description": "30-day average volume.",
"format": "float"
},
"description": {
"type": "string",
"description": "ETF's description."
},
"isInverse": {
"type": "boolean",
"description": "Whether the ETF is inverse"
},
"isLeveraged": {
"type": "boolean",
"description": "Whether the ETF is leveraged"
},
"leverageFactor": {
"type": "number",
"description": "Leverage factor.",
"format": "float"
}
}
},
"ETFsProfile": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"profile": {
"$ref": "#/components/schemas/ETFProfileData"
}
}
},
"ETFHoldingsData": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol description"
},
"name": {
"type": "string",
"description": "Security name"
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"share": {
"type": "number",
"description": "Number of shares owned by the ETF.",
"format": "float"
},
"percent": {
"type": "number",
"description": "Portfolio's percent",
"format": "float"
},
"value": {
"type": "number",
"description": "Market value",
"format": "float"
},
"assetType": {
"type": "string",
"description": "Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty."
}
}
},
"ETFsHoldings": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "ETF symbol."
},
"atDate": {
"type": "string",
"description": "Holdings update date.",
"format": "date"
},
"numberOfHoldings": {
"type": "integer",
"description": "Number of holdings.",
"format": "int64"
},
"holdings": {
"type": "array",
"description": "Array of holdings.",
"items": {
"$ref": "#/components/schemas/ETFHoldingsData"
}
}
}
},
"ETFSectorExposureData": {
"type": "object",
"properties": {
"industry": {
"type": "string",
"description": "Industry"
},
"exposure": {
"type": "number",
"description": "Percent of exposure.",
"format": "float"
}
}
},
"ETFsSectorExposure": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "ETF symbol."
},
"sectorExposure": {
"type": "array",
"description": "Array of industries and exposure levels.",
"items": {
"$ref": "#/components/schemas/ETFSectorExposureData"
}
}
}
},
"ETFCountryExposureData": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country"
},
"exposure": {
"type": "number",
"description": "Percent of exposure.",
"format": "float"
}
}
},
"ETFsCountryExposure": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "ETF symbol."
},
"countryExposure": {
"type": "array",
"description": "Array of countries and and exposure levels.",
"items": {
"$ref": "#/components/schemas/ETFCountryExposureData"
}
}
}
},
"MutualFundProfileData": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"category": {
"type": "string",
"description": "Fund's category."
},
"investmentSegment": {
"type": "string",
"description": "Investment Segment."
},
"totalNav": {
"type": "number",
"description": "NAV.",
"format": "float"
},
"expenseRatio": {
"type": "number",
"description": "Expense ratio.",
"format": "float"
},
"benchmark": {
"type": "string",
"description": "Index benchmark."
},
"inceptionDate": {
"type": "string",
"description": "Inception date.",
"format": "date"
},
"description": {
"type": "string",
"description": "Fund's description."
},
"fundFamily": {
"type": "string",
"description": "Fund Family."
},
"fundCompany": {
"type": "string",
"description": "Fund Company."
},
"manager": {
"type": "string",
"description": "Fund's managers."
},
"status": {
"type": "string",
"description": "Status."
},
"beta": {
"type": "number",
"description": "Beta.",
"format": "float"
},
"deferredLoad": {
"type": "number",
"description": "Deferred load.",
"format": "float"
},
"fee12b1": {
"type": "number",
"description": "12B-1 fee.",
"format": "float"
},
"frontLoad": {
"type": "number",
"description": "Front Load.",
"format": "float"
},
"iraMinInvestment": {
"type": "number",
"description": "IRA minimum investment.",
"format": "float"
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"maxRedemptionFee": {
"type": "number",
"description": "Max redemption fee.",
"format": "float"
},
"standardMinInvestment": {
"type": "number",
"description": "Minimum investment for standard accounts.",
"format": "float"
},
"turnover": {
"type": "number",
"description": "Turnover.",
"format": "float"
},
"seriesId": {
"type": "string",
"description": "Fund's series ID. This field can be used to group multiple share classes into 1 unique fund."
},
"seriesName": {
"type": "string",
"description": "Fund's series name."
},
"classId": {
"type": "string",
"description": "Class ID."
},
"className": {
"type": "string",
"description": "Class name."
},
"sfdrClassification": {
"type": "string",
"description": "SFDR classification for EU funds. Under the new classifications, a fund's strategy will labeled under either Article 6, 8 or 9. Article 6 covers funds which do not integrate any kind of sustainability into the investment process. Article 8, also known as ‘environmental and socially promoting’, applies “… where a financial product promotes, among other characteristics, environmental or social characteristics, or a combination of those characteristics, provided that the companies in which the investments are made follow good governance practices.”. Article 9, also known as ‘products targeting sustainable investments’, covers products targeting bespoke sustainable investments and applies “… where a financial product has sustainable investment as its objective and an index has been designated as a reference benchmark.”"
},
"currency": {
"type": "string",
"description": "Fund's currency"
}
}
},
"MutualFundProfile": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"profile": {
"$ref": "#/components/schemas/MutualFundProfileData"
}
}
},
"MutualFundHoldingsData": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol description"
},
"name": {
"type": "string",
"description": "Security name"
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"share": {
"type": "number",
"description": "Number of shares.",
"format": "float"
},
"percent": {
"type": "number",
"description": "Portfolio's percent",
"format": "float"
},
"value": {
"type": "number",
"description": "Market value",
"format": "float"
},
"assetType": {
"type": "string",
"description": "Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty."
}
}
},
"MutualFundHoldings": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"atDate": {
"type": "string",
"description": "Holdings update date.",
"format": "date"
},
"numberOfHoldings": {
"type": "integer",
"description": "Number of holdings.",
"format": "int64"
},
"holdings": {
"type": "array",
"description": "Array of holdings.",
"items": {
"$ref": "#/components/schemas/MutualFundHoldingsData"
}
}
}
},
"MutualFundSectorExposureData": {
"type": "object",
"properties": {
"sector": {
"type": "string",
"description": "Sector"
},
"exposure": {
"type": "number",
"description": "Percent of exposure.",
"format": "float"
}
}
},
"MutualFundSectorExposure": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Mutual symbol."
},
"sectorExposure": {
"type": "array",
"description": "Array of sector and exposure levels.",
"items": {
"$ref": "#/components/schemas/MutualFundSectorExposureData"
}
}
}
},
"MutualFundCountryExposureData": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country"
},
"exposure": {
"type": "number",
"description": "Percent of exposure.",
"format": "float"
}
}
},
"MutualFundCountryExposure": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"countryExposure": {
"type": "array",
"description": "Array of countries and and exposure levels.",
"items": {
"$ref": "#/components/schemas/MutualFundCountryExposureData"
}
}
}
},
"MutualFundEetData": {
"type": "object",
"properties": {}
},
"MutualFundEet": {
"type": "object",
"properties": {
"isin": {
"type": "string",
"description": "ISIN."
},
"data": {
"$ref": "#/components/schemas/MutualFundEetData"
}
}
},
"MutualFundEetPaiData": {
"type": "object",
"properties": {}
},
"MutualFundEetPai": {
"type": "object",
"properties": {
"isin": {
"type": "string",
"description": "ISIN."
},
"data": {
"$ref": "#/components/schemas/MutualFundEetPaiData"
}
}
},
"ForexSymbol": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Symbol description"
},
"displaySymbol": {
"type": "string",
"description": "Display symbol name."
},
"symbol": {
"type": "string",
"description": "Unique symbol used to identify this symbol used in <code>/forex/candle</code> endpoint."
}
}
},
"ForexCandles": {
"type": "object",
"properties": {
"o": {
"type": "array",
"description": "List of open prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"h": {
"type": "array",
"description": "List of high prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"l": {
"type": "array",
"description": "List of low prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"c": {
"type": "array",
"description": "List of close prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"v": {
"type": "array",
"description": "List of volume data for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"s": {
"type": "string",
"description": "Status of the response. This field can either be ok or no_data."
}
}
},
"ForexRate": {
"type": "object",
"properties": {}
},
"Forexrates": {
"type": "object",
"properties": {
"base": {
"type": "string",
"description": "Base currency."
},
"quote": {
"$ref": "#/components/schemas/ForexRate"
}
}
},
"CryptoSymbol": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Symbol description"
},
"displaySymbol": {
"type": "string",
"description": "Display symbol name."
},
"symbol": {
"type": "string",
"description": "Unique symbol used to identify this symbol used in <code>/crypto/candle</code> endpoint."
}
}
},
"CryptoProfile": {
"type": "object",
"properties": {
"longName": {
"type": "string",
"description": "Long name."
},
"name": {
"type": "string",
"description": "Name."
},
"description": {
"type": "string",
"description": "Description."
},
"website": {
"type": "string",
"description": "Project's website."
},
"marketCap": {
"type": "number",
"description": "Market capitalization.",
"format": "float"
},
"totalSupply": {
"type": "number",
"description": "Total supply.",
"format": "float"
},
"maxSupply": {
"type": "number",
"description": "Max supply.",
"format": "float"
},
"circulatingSupply": {
"type": "number",
"description": "Circulating supply.",
"format": "float"
},
"logo": {
"type": "string",
"description": "Logo image."
},
"launchDate": {
"type": "string",
"description": "Launch date."
},
"proofType": {
"type": "string",
"description": "Proof type."
}
}
},
"CryptoCandles": {
"type": "object",
"properties": {
"o": {
"type": "array",
"description": "List of open prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"h": {
"type": "array",
"description": "List of high prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"l": {
"type": "array",
"description": "List of low prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"c": {
"type": "array",
"description": "List of close prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"v": {
"type": "array",
"description": "List of volume data for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp for returned candles.",
"items": {
"type": "integer",
"format": "int64"
}
},
"s": {
"type": "string",
"description": "Status of the response. This field can either be ok or no_data."
}
}
},
"ScanPattern": {
"type": "object",
"properties": {}
},
"PatternRecognition": {
"type": "object",
"properties": {
"points": {
"type": "array",
"description": "Array of patterns.",
"items": {
"$ref": "#/components/schemas/ScanPattern"
}
}
}
},
"SupportResistance": {
"type": "object",
"properties": {
"levels": {
"type": "array",
"description": "Array of support and resistance levels.",
"items": {
"type": "number",
"format": "float"
}
}
}
},
"Indicator": {
"type": "object",
"properties": {
"buy": {
"type": "integer",
"description": "Number of buy signals",
"format": "int64"
},
"neutral": {
"type": "integer",
"description": "Number of neutral signals",
"format": "int64"
},
"sell": {
"type": "integer",
"description": "Number of sell signals",
"format": "int64"
}
}
},
"TechnicalAnalysis": {
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Indicator"
},
"signal": {
"type": "string",
"description": "Aggregate Signal"
}
}
},
"Trend": {
"type": "object",
"properties": {
"adx": {
"type": "number",
"description": "ADX reading",
"format": "float"
},
"trending": {
"type": "boolean",
"description": "Whether market is trending or going sideway"
}
}
},
"AggregateIndicators": {
"type": "object",
"properties": {
"technicalAnalysis": {
"$ref": "#/components/schemas/TechnicalAnalysis"
},
"trend": {
"$ref": "#/components/schemas/Trend"
}
}
},
"TechnicalIndicator": {
"type": "object",
"properties": {}
},
"IndicatorFields": {
"type": "object",
"properties": {}
},
"StockTranscripts": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Transcript's ID used to get the <a href=\"#transcripts\">full transcript</a>."
},
"title": {
"type": "string",
"description": "Title."
},
"time": {
"type": "string",
"description": "Time of the event."
},
"year": {
"type": "integer",
"description": "Year of earnings result in the case of earnings call transcript.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Quarter of earnings result in the case of earnings call transcript.",
"format": "int64"
}
}
},
"EarningsCallTranscriptsList": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"transcripts": {
"type": "array",
"description": "Array of transcripts' metadata",
"items": {
"$ref": "#/components/schemas/StockTranscripts"
}
}
}
},
"TranscriptContent": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Speaker's name"
},
"speech": {
"type": "array",
"description": "Speaker's speech",
"items": {
"type": "string"
}
},
"session": {
"type": "string",
"description": "Earnings calls section (management discussion or Q&A)"
}
}
},
"TranscriptParticipant": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Participant's name"
},
"description": {
"type": "string",
"description": "Participant's description"
},
"role": {
"type": "string",
"description": "Whether the speak is a company's executive or an analyst"
}
}
},
"EarningsCallTranscripts": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"transcript": {
"type": "array",
"description": "Transcript content.",
"items": {
"$ref": "#/components/schemas/TranscriptContent"
}
},
"participant": {
"type": "array",
"description": "Participant list",
"items": {
"$ref": "#/components/schemas/TranscriptParticipant"
}
},
"audio": {
"type": "string",
"description": "Audio link."
},
"id": {
"type": "string",
"description": "Transcript's ID."
},
"title": {
"type": "string",
"description": "Title."
},
"time": {
"type": "string",
"description": "Time of the event."
},
"year": {
"type": "integer",
"description": "Year of earnings result in the case of earnings call transcript.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Quarter of earnings result in the case of earnings call transcript.",
"format": "int64"
}
}
},
"SentimentContent": {
"type": "object",
"properties": {
"mention": {
"type": "integer",
"description": "Number of mentions",
"format": "int64"
},
"positiveMention": {
"type": "integer",
"description": "Number of positive mentions",
"format": "int64"
},
"negativeMention": {
"type": "integer",
"description": "Number of negative mentions",
"format": "int64"
},
"positiveScore": {
"type": "number",
"description": "Positive score. Range 0-1",
"format": "float"
},
"negativeScore": {
"type": "number",
"description": "Negative score. Range 0-1",
"format": "float"
},
"score": {
"type": "number",
"description": "Final score. Range: -1 to 1 with 1 is very positive and -1 is very negative",
"format": "float"
},
"atTime": {
"type": "string",
"description": "Period."
}
}
},
"SocialSentiment": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"data": {
"type": "array",
"description": "Sentiment data.",
"items": {
"$ref": "#/components/schemas/SentimentContent"
}
}
}
},
"InvestmentThemePortfolio": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
}
}
},
"InvestmentThemes": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"description": "Investment theme"
},
"data": {
"type": "array",
"description": "Investment theme portfolio.",
"items": {
"$ref": "#/components/schemas/InvestmentThemePortfolio"
}
}
}
},
"SectorMetric": {
"type": "object",
"properties": {
"region": {
"type": "string",
"description": "Region."
},
"data": {
"type": "array",
"description": "Metrics for each sector.",
"items": {
"$ref": "#/components/schemas/SectorMetricData"
}
}
}
},
"SectorMetricData": {
"type": "object",
"properties": {
"sector": {
"type": "string",
"description": "Sector"
},
"metrics": {
"type": "object",
"properties": {},
"description": "Metrics data in key-value format. <code>a</code> and <code>m</code> fields are for average and median respectively."
}
}
},
"KeyCustomersSuppliers": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"name": {
"type": "string",
"description": "Name"
},
"country": {
"type": "string",
"description": "Country"
},
"industry": {
"type": "string",
"description": "Industry"
},
"customer": {
"type": "boolean",
"description": "Whether the company is a customer."
},
"supplier": {
"type": "boolean",
"description": "Whether the company is a supplier"
},
"oneMonthCorrelation": {
"type": "number",
"description": "1-month price correlation",
"format": "float"
},
"oneYearCorrelation": {
"type": "number",
"description": "1-year price correlation",
"format": "float"
},
"sixMonthCorrelation": {
"type": "number",
"description": "6-month price correlation",
"format": "float"
},
"threeMonthCorrelation": {
"type": "number",
"description": "3-month price correlation",
"format": "float"
},
"twoWeekCorrelation": {
"type": "number",
"description": "2-week price correlation",
"format": "float"
},
"twoYearCorrelation": {
"type": "number",
"description": "2-year price correlation",
"format": "float"
}
}
},
"SupplyChainRelationships": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "symbol"
},
"data": {
"type": "array",
"description": "Key customers and suppliers.",
"items": {
"$ref": "#/components/schemas/KeyCustomersSuppliers"
}
}
}
},
"CompanyESG": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "symbol"
},
"totalESGScore": {
"type": "number",
"description": "Total ESG Score",
"format": "float"
},
"environmentScore": {
"type": "number",
"description": "Environment Score",
"format": "float"
},
"governanceScore": {
"type": "number",
"description": "Governance Score",
"format": "float"
},
"socialScore": {
"type": "number",
"description": "Social Score",
"format": "float"
},
"data": {
"$ref": "#/components/schemas/CompanyESGMap"
}
}
},
"CompanyESGMap": {
"type": "object",
"properties": {}
},
"CompanyEarningsQualityScore": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"freq": {
"type": "string",
"description": "Frequency"
},
"data": {
"type": "array",
"description": "Array of earnings quality score.",
"items": {
"$ref": "#/components/schemas/CompanyEarningsQualityScoreData"
}
}
}
},
"CompanyEarningsQualityScoreData": {
"type": "object",
"properties": {
"period": {
"type": "string",
"description": "Period"
},
"growth": {
"type": "number",
"description": "Growth Score",
"format": "float"
},
"profitability": {
"type": "number",
"description": "Profitability Score",
"format": "float"
},
"cashGenerationCapitalAllocation": {
"type": "number",
"description": "Cash Generation and Capital Allocation",
"format": "float"
},
"leverage": {
"type": "number",
"description": "Leverage Score",
"format": "float"
},
"score": {
"type": "number",
"description": "Total Score",
"format": "float"
},
"letterScore": {
"type": "string",
"description": "Letter Score"
}
}
},
"CovidInfo": {
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "State."
},
"case": {
"type": "number",
"description": "Number of confirmed cases.",
"format": "float"
},
"death": {
"type": "number",
"description": "Number of confirmed deaths.",
"format": "float"
},
"updated": {
"type": "string",
"description": "Updated time."
}
}
},
"FDAComitteeMeeting": {
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "Start time of the event in EST."
},
"toDate": {
"type": "string",
"description": "End time of the event in EST."
},
"eventDescription": {
"type": "string",
"description": "Event's description."
},
"url": {
"type": "string",
"description": "URL."
}
}
},
"CountryMetadata": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country name"
},
"code2": {
"type": "string",
"description": "Alpha 2 code"
},
"code3": {
"type": "string",
"description": "Alpha 3 code"
},
"codeNo": {
"type": "string",
"description": "UN code"
},
"currency": {
"type": "string",
"description": "Currency name"
},
"currencyCode": {
"type": "string",
"description": "Currency code"
},
"region": {
"type": "string",
"description": "Region"
},
"subRegion": {
"type": "string",
"description": "Sub-Region"
},
"rating": {
"type": "string",
"description": "Moody's credit risk rating."
},
"defaultSpread": {
"type": "number",
"description": "Default spread",
"format": "float"
},
"countryRiskPremium": {
"type": "number",
"description": "Country risk premium",
"format": "float"
},
"equityRiskPremium": {
"type": "number",
"description": "Equity risk premium",
"format": "float"
}
}
},
"Economic event": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"description": "Actual release",
"format": "float"
},
"prev": {
"type": "number",
"description": "Previous release",
"format": "float"
},
"country": {
"type": "string",
"description": "Country"
},
"unit": {
"type": "string",
"description": "Unit"
},
"estimate": {
"type": "number",
"description": "Estimate",
"format": "float"
},
"event": {
"type": "string",
"description": "Event"
},
"impact": {
"type": "string",
"description": "Impact level"
},
"time": {
"type": "string",
"description": "Release time"
}
}
},
"EconomicCalendar": {
"type": "object",
"properties": {
"economicCalendar": {
"type": "array",
"description": "Array of economic events.",
"items": {
"$ref": "#/components/schemas/Economic event"
}
}
}
},
"EconomicCode": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Finnhub economic code used to get historical data"
},
"country": {
"type": "string",
"description": "Country"
},
"name": {
"type": "string",
"description": "Indicator name"
},
"unit": {
"type": "string",
"description": "Unit"
}
}
},
"EconomicDataInfo": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Date of the reading"
},
"value": {
"type": "number",
"description": "Value",
"format": "float"
}
}
},
"EconomicData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Array of economic data for requested code.",
"items": {
"$ref": "#/components/schemas/EconomicDataInfo"
}
},
"code": {
"type": "string",
"description": "Finnhub economic code"
}
}
},
"BondYieldCurveInfo": {
"type": "object",
"properties": {
"d": {
"type": "string",
"description": "Date of the reading"
},
"v": {
"type": "number",
"description": "Value",
"format": "float"
}
}
},
"BondYieldCurve": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Array of data.",
"items": {
"$ref": "#/components/schemas/BondYieldCurveInfo"
}
},
"code": {
"type": "string",
"description": "Bond's code"
}
}
},
"UsptoPatentResult": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"data": {
"type": "array",
"description": "Array of patents.",
"items": {
"$ref": "#/components/schemas/UsptoPatent"
}
}
}
},
"UsptoPatent": {
"type": "object",
"properties": {
"applicationNumber": {
"type": "string",
"description": "Application Number."
},
"companyFilingName": {
"type": "array",
"description": "Array of companies' name on the patent.",
"items": {
"type": "string"
}
},
"filingDate": {
"type": "string",
"description": "Filing date."
},
"description": {
"type": "string",
"description": "Description."
},
"filingStatus": {
"type": "string",
"description": "Filing status."
},
"patentNumber": {
"type": "string",
"description": "Patent number."
},
"publicationDate": {
"type": "string",
"description": "Publication date."
},
"patentType": {
"type": "string",
"description": "Patent's type."
},
"url": {
"type": "string",
"description": "URL of the original article."
}
}
},
"VisaApplicationResult": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"data": {
"type": "array",
"description": "Array of H1b and Permanent visa applications.",
"items": {
"$ref": "#/components/schemas/VisaApplication"
}
}
}
},
"LobbyingResult": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"data": {
"type": "array",
"description": "Array of lobbying activities.",
"items": {
"$ref": "#/components/schemas/LobbyingData"
}
}
}
},
"UsaSpendingResult": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"data": {
"type": "array",
"description": "Array of government's spending data points.",
"items": {
"$ref": "#/components/schemas/UsaSpending"
}
}
}
},
"UsaSpending": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"recipientName": {
"type": "string",
"description": "Company's name."
},
"recipientParentName": {
"type": "string",
"description": "Company's name."
},
"awardDescription": {
"type": "string",
"description": "Description."
},
"country": {
"type": "string",
"description": "Recipient's country."
},
"actionDate": {
"type": "string",
"description": "Period."
},
"totalValue": {
"type": "number",
"description": "Income reported by lobbying firms.",
"format": "float"
},
"performanceStartDate": {
"type": "string",
"description": "Performance start date."
},
"performanceEndDate": {
"type": "string",
"description": "Performance end date."
},
"awardingAgencyName": {
"type": "string",
"description": "Award agency."
},
"awardingSubAgencyName": {
"type": "string",
"description": "Award sub-agency."
},
"awardingOfficeName": {
"type": "string",
"description": "Award office name."
},
"performanceCountry": {
"type": "string",
"description": "Performance country."
},
"performanceCity": {
"type": "string",
"description": "Performance city."
},
"performanceCounty": {
"type": "string",
"description": "Performance county."
},
"performanceState": {
"type": "string",
"description": "Performance state."
},
"performanceZipCode": {
"type": "string",
"description": "Performance zip code."
},
"performanceCongressionalDistrict": {
"type": "string",
"description": "Performance congressional district."
},
"naicsCode": {
"type": "string",
"description": "NAICS code."
},
"permalink": {
"type": "string",
"description": "Permalink."
}
}
},
"LobbyingData": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"name": {
"type": "string",
"description": "Company's name."
},
"description": {
"type": "string",
"description": "Description."
},
"country": {
"type": "string",
"description": "Country."
},
"year": {
"type": "integer",
"description": "Year.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period."
},
"income": {
"type": "number",
"description": "Income reported by lobbying firms.",
"format": "float"
},
"expenses": {
"type": "number",
"description": "Expenses reported by the company.",
"format": "float"
},
"documentUrl": {
"type": "string",
"description": "Document's URL."
},
"postedName": {
"type": "string",
"description": "Posted name."
},
"date": {
"type": "string",
"description": "Date."
},
"clientId": {
"type": "string",
"description": "Client ID."
},
"registrantId": {
"type": "string",
"description": "Registrant ID."
},
"senateId": {
"type": "string",
"description": "Senate ID."
},
"houseregistrantId": {
"type": "string",
"description": "House registrant ID."
}
}
},
"BondProfile": {
"type": "object",
"properties": {
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "Cusip."
},
"figi": {
"type": "string",
"description": "FIGI."
},
"coupon": {
"type": "number",
"description": "Coupon.",
"format": "float"
},
"maturityDate": {
"type": "string",
"description": "Period."
},
"offeringPrice": {
"type": "number",
"description": "Offering price.",
"format": "float"
},
"issueDate": {
"type": "string",
"description": "Issue date."
},
"bondType": {
"type": "string",
"description": "Bond type."
},
"debtType": {
"type": "string",
"description": "Bond type."
},
"industryGroup": {
"type": "string",
"description": "Industry."
},
"industrySubGroup": {
"type": "string",
"description": "Sub-Industry."
},
"asset": {
"type": "string",
"description": "Asset."
},
"assetType": {
"type": "string",
"description": "Asset."
},
"datedDate": {
"type": "string",
"description": "Dated date."
},
"firstCouponDate": {
"type": "string",
"description": "First coupon date."
},
"originalOffering": {
"type": "number",
"description": "Offering amount.",
"format": "float"
},
"amountOutstanding": {
"type": "number",
"description": "Outstanding amount.",
"format": "float"
},
"paymentFrequency": {
"type": "string",
"description": "Payment frequency."
},
"securityLevel": {
"type": "string",
"description": "Security level."
},
"callable": {
"type": "boolean",
"description": "Callable."
},
"couponType": {
"type": "string",
"description": "Coupon type."
}
}
},
"BondCandles": {
"type": "object",
"properties": {
"c": {
"type": "array",
"description": "List of close prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp for returned candles.",
"items": {
"type": "integer",
"format": "int64"
}
},
"s": {
"type": "string",
"description": "Status of the response. This field can either be ok or no_data."
}
}
},
"VisaApplication": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"description": "Year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Quarter.",
"format": "int64"
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"caseNumber": {
"type": "string",
"description": "Case number."
},
"caseStatus": {
"type": "string",
"description": "Case status."
},
"receivedDate": {
"type": "string",
"description": "Received date."
},
"visaClass": {
"type": "string",
"description": "Visa class."
},
"jobTitle": {
"type": "string",
"description": "Job Title."
},
"socCode": {
"type": "string",
"description": "SOC Code. A list of SOC code can be found <a href=\"https://www.bls.gov/oes/current/oes_stru.htm\" target=\"_blank\">here</a>."
},
"fullTimePosition": {
"type": "string",
"description": "Full-time position flag."
},
"beginDate": {
"type": "string",
"description": "Job's start date."
},
"endDate": {
"type": "string",
"description": "Job's end date."
},
"employerName": {
"type": "string",
"description": "Company's name."
},
"worksiteAddress": {
"type": "string",
"description": "Worksite address."
},
"worksiteCity": {
"type": "string",
"description": "Worksite city."
},
"worksiteCounty": {
"type": "string",
"description": "Worksite county."
},
"worksiteState": {
"type": "string",
"description": "Worksite state."
},
"worksitePostalCode": {
"type": "string",
"description": "Worksite postal code."
},
"wageRangeFrom": {
"type": "number",
"description": "Wage range from.",
"format": "float"
},
"wageRangeTo": {
"type": "number",
"description": "Wage range to.",
"format": "float"
},
"wageUnitOfPay": {
"type": "string",
"description": "Wage unit of pay."
},
"wageLevel": {
"type": "string",
"description": "Wage level."
},
"h1bDependent": {
"type": "string",
"description": "H1B dependent flag."
}
}
}
},
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "token",
"in": "query"
}
}
},
"x-original-swagger-version": "2.0"
}TwelveData API
GET /time_seriesTime SeriesThis API call returns meta and time series for the requested instrument. Metaobject consists of general information about the requested symbol. Time series is the array of objects ordered by time descending with Open, High, Low, Close prices. Non-currency instruments also include volume information.
Ursprüngliches API-Schema
{
"openapi": "3.0.1",
"info": {
"title": "TwelveData API",
"license": {
"name": "MIT license",
"url": "https://www.mit.edu/~amini/LICENSE.md"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.twelvedata.com"
}
],
"paths": {
"/time_series": {
"get": {
"tags": [
"Free"
],
"summary": "Time Series",
"description": "This API call returns meta and time series for the requested instrument. Metaobject consists of general information about the requested symbol. Time series is the array of objects ordered by time descending with Open, High, Low, Close prices. Non-currency instruments also include volume information.",
"operationId": "time-series",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol ticker of the instrument e.g. AAPL, EUR/USD, ETH/BTC",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interval",
"in": "query",
"description": "Interval between two consecutive points in time series. Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 1day, 1week, 1month",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "exchange",
"in": "query",
"description": "Exchange where instrument is traded",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "mic_code",
"in": "query",
"description": "Market Identifier Code (MIC) under ISO 10383 standard",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
}
},
"components": {
"schemas": {
"TimeSeries": {
"type": "object",
"properties": {
"datetime": {
"type": "string",
"description": "earliest datetime, the format depends on interval"
},
"unix_time": {
"type": "integer",
"description": "datetime converted to UNIX timestamp"
}
}
}
},
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "apikey",
"in": "query"
}
}
}
}Finnhub API
GET /searchSymbol LookupSearch for best-matching symbols based on your query. You can input anything from symbol, security's name to ISIN and Cusip.
GET /stock/symbolStock SymbolList supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>.
GET /stock/market-statusMarket StatusGet current market status for global exchanges (whether exchanges are open or close).
GET /stock/market-holidayMarket HolidayGet a list of holidays for global exchanges.
GET /stock/profileCompany ProfileGet general information of a company. You can query by symbol, ISIN or CUSIP
GET /stock/profile2Company Profile 2Get general information of a company. You can query by symbol, ISIN or CUSIP. This is the free version of <a href="#company-profile">Company Profile</a>.
GET /stock/executiveCompany ExecutiveGet a list of company's executives and members of the Board.
GET /newsMarket NewsGet latest market news.
GET /company-newsCompany NewsList latest company news by symbol. This endpoint is only available for North American companies.
GET /press-releasesMajor Press Releases<p>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.</p>
GET /news-sentimentNews SentimentGet company's news sentiment and statistics. This endpoint is only available for US companies.
GET /stock/peersPeersGet company peers. Return a list of peers operating in the same country and sector/industry.
GET /stock/metricBasic FinancialsGet company basic financials such as margin, P/E ratio, 52-week high/low etc.
GET /stock/price-metricPrice MetricsGet company price performance statistics such as 52-week high/low, YTD return and much more.
GET /ca/symbol-changeSymbol ChangeGet a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
GET /ca/isin-changeISIN ChangeGet a list of ISIN changes for EU-listed securities. Limit to 2000 events at a time.
GET /institutional/profileInstitutional ProfileGet a list of well-known institutional investors. Currently support 60+ profiles.
GET /institutional/portfolioInstitutional PortfolioGet the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time. You can get a list of supported CIK <a href="/api/v1/institutional/list?token=" target="_blank">here</a>.
GET /institutional/ownershipInstitutional OwnershipGet a list institutional investors' positions for a particular stock overtime. Data from 13-F filings. Limit to 1 year of data at a time.
GET /stock/ownershipOwnershipGet 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, 13G, UK Share Register, SEDI and other international markets.
GET /stock/fund-ownershipFund OwnershipGet 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, 13G, UK Share Register, SEDI and equivalent filings for other international markets.
GET /stock/insider-transactionsInsider TransactionsCompany insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, UK, Canada, Australia, India, and all major EU markets. Limit to 100 transactions per API call.
GET /stock/insider-sentimentInsider SentimentGet insider sentiment data for US companies calculated using method discussed https://medium.com/@stock-api/finnhub-insiders-sentiment-analysis-cc43f9f64b3a. The MSPR ranges from -100 for the most negative to 100 for the most positive which can signal price changes in the coming 30-90 days.
GET /stock/financialsFinancial Statements<p>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 <a href="#filings">SEC Filings</a> and <a href="#international-filings">International Filings</a> endpoints.
GET /stock/financials-reportedFinancials As ReportedGet financials as reported. This data is available for bulk download on <a href="https://www.kaggle.com/finnhub/reported-financials" target="_blank">Kaggle SEC Financials database</a>.
GET /stock/revenue-breakdownRevenue BreakdownGet revenue breakdown by product. This dataset is only available for US companies which disclose their revenue breakdown in the annual or quarterly reports.
GET /stock/filingsSEC FilingsList company's filing. Limit to 250 documents at a time. This data is available for bulk download on <a href="https://www.kaggle.com/finnhub/sec-filings" target="_blank">Kaggle SEC Filings database</a>.
GET /stock/filings-sentimentSEC Sentiment AnalysisGet 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.
GET /stock/similarity-indexSimilarity Index<p>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.</p>
GET /calendar/ipoIPO CalendarGet recent and upcoming IPO.
GET /sector/metricsSector MetricsGet ratios for different sectors and regions/indices.
GET /stock/dividendDividendsGet dividends data for common stocks going back 30 years.
GET /stock/recommendationRecommendation TrendsGet latest analyst recommendation trends for a company.
GET /stock/price-targetPrice TargetGet latest price target consensus.
GET /stock/upgrade-downgradeStock Upgrade/DowngradeGet latest stock upgrade and downgrade.
GET /stock/revenue-estimateRevenue EstimatesGet company's revenue estimates.
GET /stock/ebitda-estimateEBITDA EstimatesGet company's ebitda estimates.
GET /stock/ebit-estimateEBIT EstimatesGet company's ebit estimates.
GET /stock/eps-estimateEarnings EstimatesGet company's EPS estimates.
GET /stock/earningsEarnings SurprisesGet company historical quarterly earnings surprise going back to 2000.
GET /calendar/earningsEarnings CalendarGet 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.
GET /quoteQuote<p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time updates.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed.
GET /stock/candleStock Candles<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted. Only 1 month of intraday will be returned at a time. If you need more historical intraday data, please use the from and to params iteratively to request more data.</p>
GET /stock/tickTick Data<p>Get historical tick data for global exchanges.
GET /stock/bboHistorical NBBO<p>Get historical best bid and offer for US stocks, LSE, TSX, Euronext and Deutsche Borse.</p><p>For US market, this endpoint only serves historical NBBO from the beginning of 2020.
GET /stock/bidaskLast Bid-AskGet last bid/ask data for US stocks.
GET /stock/splitSplitsGet splits data for stocks.
GET /stock/dividend2Dividends 2 (Basic)Get global dividends data.
GET /index/constituentsIndices ConstituentsGet a list of index's constituents. A list of supported indices for this endpoint can be found <a href="/api/v1/index/list?token=" target="_blank">here</a>.
GET /index/historical-constituentsIndices Historical ConstituentsGet full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC</code>, <code>^NDX</code>, <code>^DJI</code>
GET /etf/profileETFs ProfileGet ETF profile information. This endpoint has global coverage. A list of supported ETFs can be found <a href="/api/v1/etf/list?token=" target="_blank">here</a>.
GET /etf/holdingsETFs HoldingsGet full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings. A list of supported ETFs can be found <a href="/api/v1/etf/list?token=" target="_blank">here</a>.
GET /etf/sectorETFs Sector ExposureGet ETF sector exposure data.
GET /etf/countryETFs Country ExposureGet ETF country exposure data.
GET /mutual-fund/profileMutual Funds ProfileGet mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href="/api/v1/mutual-fund/list?token=" target="_blank">here</a>.
GET /mutual-fund/holdingsMutual Funds HoldingsGet full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href="/api/v1/mutual-fund/list?token=" target="_blank">here</a>.
GET /mutual-fund/sectorMutual Funds Sector ExposureGet Mutual Funds sector exposure data.
GET /mutual-fund/countryMutual Funds Country ExposureGet Mutual Funds country exposure data.
GET /mutual-fund/eetMutual Funds EETGet EET data for EU funds. For PAIs data, please see the EET PAI endpoint.
GET /mutual-fund/eet-paiMutual Funds EET PAIGet EET PAI data for EU funds.
GET /forex/exchangeForex ExchangesList supported forex exchanges
GET /forex/symbolForex SymbolList supported forex symbols.
GET /forex/candleForex CandlesGet candlestick data for forex symbols.
GET /forex/ratesForex ratesGet rates for all forex pairs. Ideal for currency conversion
GET /crypto/exchangeCrypto ExchangesList supported crypto exchanges
GET /crypto/symbolCrypto SymbolList supported crypto symbols by exchange
GET /crypto/profileCrypto ProfileGet crypto's profile.
GET /crypto/candleCrypto CandlesGet candlestick data for crypto symbols.
GET /scan/patternPattern RecognitionRun pattern recognition algorithm on a symbol. Support double top/bottom, triple top/bottom, head and shoulders, triangle, wedge, channel, flag, and candlestick patterns.
GET /scan/support-resistanceSupport/ResistanceGet support and resistance levels for a symbol.
GET /scan/technical-indicatorAggregate IndicatorsGet aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v. A full list of indicators can be found <a href="https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing" target="_blank">here</a>.
GET /indicatorTechnical IndicatorsReturn technical indicator with price data. List of supported indicators can be found <a href="https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing" target="_blank">here</a>.
GET /stock/transcripts/listEarnings Call Transcripts ListList earnings call transcripts' metadata. This endpoint is available for US, UK, European, Australian and Canadian companies.
GET /stock/transcriptsEarnings Call Transcripts<p>Get earnings call transcripts, audio and participants' list. Data is available for US, UK, European, Australian and Canadian companies.<p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
GET /stock/social-sentimentSocial Sentiment<p>Get social sentiment for stocks on Reddit and Twitter.</p>
GET /stock/investment-themeInvestment Themes (Thematic Investing)<p>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.
GET /stock/supply-chainSupply Chain Relationships<p>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.</p>
GET /stock/esgCompany ESG Scores<p>This endpoint provides ESG scores and important indicators for 7000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p>
GET /stock/earnings-quality-scoreCompany Earnings Quality Score<p>This endpoint provides Earnings Quality Score for global companies.</p><p> Earnings quality refers to the extent to which current earnings predict future earnings. "High-quality" earnings are expected to persist, while "low-quality" earnings do not.
GET /covid19/usCOVID-19Get 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 <a href="https://rapidapi.com/Finnhub/api/finnhub-real-time-covid-19" target="_blank" rel="nofollow">here</a>
GET /fda-advisory-committee-calendarFDA Committee Meeting CalendarFDA'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.
GET /stock/uspto-patentUSPTO PatentsList USPTO patents for companies. Limit to 250 records per API call.
GET /stock/visa-applicationH1-B Visa ApplicationGet a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.
GET /stock/lobbyingSenate LobbyingGet a list of reported lobbying activities in the Senate and the House.
GET /stock/usa-spendingUSA SpendingGet a list of government's spending activities from USASpending dataset for public companies. This dataset can help you identify companies that win big government contracts which is extremely important for industries such as Defense, Aerospace, and Education.
GET /stock/congressional-tradingCongressional TradingGet stock trades data disclosed by members of congress.
GET /bond/profileBond ProfileGet general information of a bond. You can query by FIGI, ISIN or CUSIP. A list of supported bonds can be found <a href="/api/v1/bond/list?token=" target="_blank">here</a>.
GET /bond/priceBond price dataGet bond's price data. The following datasets are supported: Exchange, Segment, Delay, US Government Bonds, Government Bonds, End-of-day, FINRA Trace, BTDS: US Corporate Bonds, Delayed 4h, FINRA Trace, 144A Bonds, Delayed 4h
GET /bond/tickBond Tick DataGet trade-level data for bonds. The following datasets are supported: Exchange, Segment, Delay, FINRA Trace, BTDS: US Corporate Bonds, Delayed 4h, FINRA Trace, 144A Bonds, Delayed 4h.
GET /bond/yield-curveBond Yield CurveGet yield curve data for Treasury bonds.
GET /countryCountry MetadataList all countries and metadata.
GET /calendar/economicEconomic Calendar<p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
GET /economic/codeEconomic CodeList codes of supported economic data.
GET /economicEconomic DataGet economic data.
GET /stock/international-filingsInternational FilingsList filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage.
POST /global-filings/searchGlobal Filings Search<p>Search for best-matched filings across global companies' filings, transcripts and press releases. You can filter by anything from symbol, ISIN to form type, and document sources.</p><p>This endpoint will return a list of documents that match your search criteria.
POST /global-filings/search-in-filingSearch In Filing<p>Get a list of excerpts and highlight positions within a document using your query.</p>
GET /global-filings/filterSearch Filter<p>Get available values for each filter in search body.</p>
GET /global-filings/downloadDownload Filings<p>Download filings using document ids.</p>
Ursprüngliches API-Schema
{
"openapi": "3.0.1",
"info": {
"title": "Finnhub API",
"license": {
"name": "Apache-2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://finnhub.io/api/v1"
}
],
"paths": {
"/search": {
"get": {
"tags": [
"Default"
],
"summary": "Symbol Lookup",
"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": [
{
"name": "q",
"in": "query",
"description": "Query text can be symbol, name, isin, or cusip.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SymbolLookup"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/symbol": {
"get": {
"tags": [
"Default"
],
"summary": "Stock Symbol",
"description": "List supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>.",
"operationId": "stock-symbols",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange you want to get the list of symbols from. List of exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mic",
"in": "query",
"description": "Filter by MIC code.",
"schema": {
"type": "string"
}
},
{
"name": "securityType",
"in": "query",
"description": "Filter by security type used by OpenFigi standard.",
"schema": {
"type": "string"
}
},
{
"name": "currency",
"in": "query",
"description": "Filter by currency.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockSymbol"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/market-status": {
"get": {
"tags": [
"Default"
],
"summary": "Market Status",
"description": "Get current market status for global exchanges (whether exchanges are open or close).",
"operationId": "market-status",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange code.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarketStatus"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/market-holiday": {
"get": {
"tags": [
"Default"
],
"summary": "Market Holiday",
"description": "Get a list of holidays for global exchanges.",
"operationId": "market-holiday",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange code.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarketHoliday"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Company Profile",
"description": "Get general information of a company. You can query by symbol, ISIN or CUSIP",
"operationId": "company-profile_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL e.g.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ISIN",
"schema": {
"type": "string"
}
},
{
"name": "cusip",
"in": "query",
"description": "CUSIP",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/profile2": {
"get": {
"tags": [
"Default"
],
"summary": "Company Profile 2",
"description": "Get general information of a company. You can query by symbol, ISIN or CUSIP. This is the free version of <a href=\"#company-profile\">Company Profile</a>.",
"operationId": "company-profile2",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL e.g.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ISIN",
"schema": {
"type": "string"
}
},
{
"name": "cusip",
"in": "query",
"description": "CUSIP",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyProfile2"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/executive": {
"get": {
"tags": [
"Default"
],
"summary": "Company Executive",
"description": "Get a list of company's executives and members of the Board.",
"operationId": "company-executive_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyExecutive"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/news": {
"get": {
"tags": [
"Default"
],
"summary": "Market News",
"description": "Get latest market news.",
"operationId": "market-news",
"parameters": [
{
"name": "category",
"in": "query",
"description": "This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "minId",
"in": "query",
"description": "Use this field to get only news after this ID. Default to 0",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MarketNews"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/company-news": {
"get": {
"tags": [
"Default"
],
"summary": "Company News",
"description": "List latest company news by symbol. This endpoint is only available for North American companies.",
"operationId": "company-news",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyNews"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/press-releases": {
"get": {
"tags": [
"Default"
],
"summary": "Major Press Releases",
"description": "<p>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.</p>",
"operationId": "press-releases_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From time: 2020-01-01.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To time: 2020-01-05.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PressRelease"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/news-sentiment": {
"get": {
"tags": [
"Default"
],
"summary": "News Sentiment",
"description": "Get company's news sentiment and statistics. This endpoint is only available for US companies.",
"operationId": "news-sentiment_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsSentiment"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/peers": {
"get": {
"tags": [
"Default"
],
"summary": "Peers",
"description": "Get company peers. Return a list of peers operating in the same country and sector/industry.",
"operationId": "company-peers",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "grouping",
"in": "query",
"description": "Specify the grouping criteria for choosing peers.Supporter values: <code>sector</code>, <code>industry</code>, <code>subIndustry</code>. Default to <code>subIndustry</code>.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/metric": {
"get": {
"tags": [
"Default"
],
"summary": "Basic Financials",
"description": "Get company basic financials such as margin, P/E ratio, 52-week high/low etc.",
"operationId": "company-basic-financials",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "metric",
"in": "query",
"description": "Metric type. Can be 1 of the following values <code>all</code>",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BasicFinancials"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/price-metric": {
"get": {
"tags": [
"Default"
],
"summary": "Price Metrics",
"description": "Get company price performance statistics such as 52-week high/low, YTD return and much more.",
"operationId": "price-metrics_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Get data on a specific date in the past. The data is available weekly so your date will be automatically adjusted to the last day of that week.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PriceMetrics"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/ca/symbol-change": {
"get": {
"tags": [
"Default"
],
"summary": "Symbol Change",
"description": "Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.",
"operationId": "symbol-change_premium",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SymbolChange"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/ca/isin-change": {
"get": {
"tags": [
"Default"
],
"summary": "ISIN Change",
"description": "Get a list of ISIN changes for EU-listed securities. Limit to 2000 events at a time.",
"operationId": "isin-change_premium",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IsinChange"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/institutional/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Institutional Profile",
"description": "Get a list of well-known institutional investors. Currently support 60+ profiles.",
"operationId": "institutional-profile_premium",
"parameters": [
{
"name": "cik",
"in": "query",
"description": "Filter by CIK. Leave blank to get the full list.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstitutionalProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/institutional/portfolio": {
"get": {
"tags": [
"Default"
],
"summary": "Institutional Portfolio",
"description": "Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time. You can get a list of supported CIK <a href=\"/api/v1/institutional/list?token=\" target=\"_blank\">here</a>.",
"operationId": "institutional-portfolio_premium",
"parameters": [
{
"name": "cik",
"in": "query",
"description": "Fund's CIK.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstitutionalPortfolio"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/institutional/ownership": {
"get": {
"tags": [
"Default"
],
"summary": "Institutional Ownership",
"description": "Get a list institutional investors' positions for a particular stock overtime. Data from 13-F filings. Limit to 1 year of data at a time.",
"operationId": "institutional-ownership_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Filter by symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cusip",
"in": "query",
"description": "Filter by CUSIP.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstitutionalOwnership"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/ownership": {
"get": {
"tags": [
"Default"
],
"summary": "Ownership",
"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, 13G, UK Share Register, SEDI and other international markets.",
"operationId": "ownership_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of results. Leave empty to get the full list.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ownership"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/fund-ownership": {
"get": {
"tags": [
"Default"
],
"summary": "Fund Ownership",
"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, 13G, UK Share Register, SEDI and equivalent filings for other international markets.",
"operationId": "fund-ownership_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of results. Leave empty to get the full list.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FundOwnership"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/insider-transactions": {
"get": {
"tags": [
"Default"
],
"summary": "Insider Transactions",
"description": "Company insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, UK, Canada, Australia, India, and all major EU markets. Limit to 100 transactions per API call.",
"operationId": "insider-transactions",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL. Leave this param blank to get the latest transactions.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsiderTransactions"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/insider-sentiment": {
"get": {
"tags": [
"Default"
],
"summary": "Insider Sentiment",
"description": "Get insider sentiment data for US companies calculated using method discussed https://medium.com/@stock-api/finnhub-insiders-sentiment-analysis-cc43f9f64b3a. The MSPR ranges from -100 for the most negative to 100 for the most positive which can signal price changes in the coming 30-90 days.",
"operationId": "insider-sentiment",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsiderSentiments"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/financials": {
"get": {
"tags": [
"Default"
],
"summary": "Financial Statements",
"description": "<p>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 <a href=\"#filings\">SEC Filings</a> and <a href=\"#international-filings\">International Filings</a> endpoints.",
"operationId": "financials_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "statement",
"in": "query",
"description": "Statement can take 1 of these values <code>bs, ic, cf</code> for Balance Sheet, Income Statement, Cash Flow respectively.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Frequency can take 1 of these values <code>annual, quarterly, ttm, ytd</code>. TTM (Trailing Twelve Months) option is available for Income Statement and Cash Flow. YTD (Year To Date) option is only available for Cash Flow.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialStatements"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/financials-reported": {
"get": {
"tags": [
"Default"
],
"summary": "Financials As Reported",
"description": "Get financials as reported. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/reported-financials\" target=\"_blank\">Kaggle SEC Financials database</a>.",
"operationId": "financials-reported",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"schema": {
"type": "string"
}
},
{
"name": "cik",
"in": "query",
"description": "CIK.",
"schema": {
"type": "string"
}
},
{
"name": "accessNumber",
"in": "query",
"description": "Access number of a specific report you want to retrieve financials from.",
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>. Filter for endDate.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>. Filter for endDate.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinancialsAsReported"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/revenue-breakdown": {
"get": {
"tags": [
"Default"
],
"summary": "Revenue Breakdown",
"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_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"schema": {
"type": "string"
}
},
{
"name": "cik",
"in": "query",
"description": "CIK.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevenueBreakdown"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/filings": {
"get": {
"tags": [
"Default"
],
"summary": "SEC Filings",
"description": "List company's filing. Limit to 250 documents at a time. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/sec-filings\" target=\"_blank\">Kaggle SEC Filings database</a>.",
"operationId": "filings",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol. Leave <code>symbol</code>,<code>cik</code> and <code>accessNumber</code> empty to list latest filings.",
"schema": {
"type": "string"
}
},
{
"name": "cik",
"in": "query",
"description": "CIK.",
"schema": {
"type": "string"
}
},
{
"name": "accessNumber",
"in": "query",
"description": "Access number of a specific report you want to retrieve data from.",
"schema": {
"type": "string"
}
},
{
"name": "form",
"in": "query",
"description": "Filter by form. You can use this value <code>NT 10-K</code> to find non-timely filings for a company.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Filing"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/filings-sentiment": {
"get": {
"tags": [
"Default"
],
"summary": "SEC Sentiment Analysis",
"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.",
"operationId": "filings-sentiment_premium",
"parameters": [
{
"name": "accessNumber",
"in": "query",
"description": "Access number of a specific report you want to retrieve data from.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SECSentimentAnalysis"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/similarity-index": {
"get": {
"tags": [
"Default"
],
"summary": "Similarity Index",
"description": "<p>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.</p>",
"operationId": "similarity-index_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol. Required if cik is empty",
"schema": {
"type": "string"
}
},
{
"name": "cik",
"in": "query",
"description": "CIK. Required if symbol is empty",
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "<code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimilarityIndex"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/calendar/ipo": {
"get": {
"tags": [
"Default"
],
"summary": "IPO Calendar",
"description": "Get recent and upcoming IPO.",
"operationId": "ipo-calendar",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPOCalendar"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/sector/metrics": {
"get": {
"tags": [
"Default"
],
"summary": "Sector Metrics",
"description": "Get ratios for different sectors and regions/indices.",
"operationId": "sector-metric_premium",
"parameters": [
{
"name": "region",
"in": "query",
"description": "Region. A list of supported values for this field can be found <a href=\"https://docs.google.com/spreadsheets/d/1afedyv7yWJ-z7pMjaAZK-f6ENY3mI3EBCk95QffpoHw/edit?usp=sharing\" target=\"_blank\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectorMetric"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/dividend": {
"get": {
"tags": [
"Default"
],
"summary": "Dividends",
"description": "Get dividends data for common stocks going back 30 years.",
"operationId": "stock-dividends_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "YYYY-MM-DD.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "YYYY-MM-DD.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dividends"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/recommendation": {
"get": {
"tags": [
"Default"
],
"summary": "Recommendation Trends",
"description": "Get latest analyst recommendation trends for a company.",
"operationId": "recommendation-trends",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecommendationTrend"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/price-target": {
"get": {
"tags": [
"Default"
],
"summary": "Price Target",
"description": "Get latest price target consensus.",
"operationId": "price-target_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PriceTarget"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/upgrade-downgrade": {
"get": {
"tags": [
"Default"
],
"summary": "Stock Upgrade/Downgrade",
"description": "Get latest stock upgrade and downgrade.",
"operationId": "upgrade-downgrade_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL. If left blank, the API will return latest stock upgrades/downgrades.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date: 2000-03-15.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpgradeDowngrade"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/revenue-estimate": {
"get": {
"tags": [
"Default"
],
"summary": "Revenue Estimates",
"description": "Get company's revenue estimates.",
"operationId": "company-revenue-estimates_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevenueEstimates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/ebitda-estimate": {
"get": {
"tags": [
"Default"
],
"summary": "EBITDA Estimates",
"description": "Get company's ebitda estimates.",
"operationId": "company-ebitda-estimates_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EbitdaEstimates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/ebit-estimate": {
"get": {
"tags": [
"Default"
],
"summary": "EBIT Estimates",
"description": "Get company's ebit estimates.",
"operationId": "company-ebit-estimates_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EbitEstimates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/eps-estimate": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Estimates",
"description": "Get company's EPS estimates.",
"operationId": "company-eps-estimates_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsEstimates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/earnings": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Surprises",
"description": "Get company historical quarterly earnings surprise going back to 2000.",
"operationId": "company-earnings",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of period returned. Leave blank to get the full history.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EarningResult"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/calendar/earnings": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Calendar",
"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.",
"operationId": "earnings-calendar",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date: 2020-03-15.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date: 2020-03-16.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "symbol",
"in": "query",
"description": "Filter by symbol: AAPL.",
"schema": {
"type": "string"
}
},
{
"name": "international",
"in": "query",
"description": "Set to <code>true</code> to include international markets. Default value is <code>false</code>",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCalendar"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/quote": {
"get": {
"tags": [
"Default"
],
"summary": "Quote",
"description": "<p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time updates.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed.",
"operationId": "quote",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Quote"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/candle": {
"get": {
"tags": [
"Default"
],
"summary": "Stock Candles",
"description": "<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted. Only 1 month of intraday will be returned at a time. If you need more historical intraday data, please use the from and to params iteratively to request more data.</p>",
"operationId": "stock-candles",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StockCandles"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/tick": {
"get": {
"tags": [
"Default"
],
"summary": "Tick Data",
"description": "<p>Get historical tick data for global exchanges.",
"operationId": "stock-tick_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Date: 2020-04-02.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of ticks returned. Maximum value: <code>25000</code>",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of ticks to skip. Use this parameter to loop through the entire data.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TickData"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/bbo": {
"get": {
"tags": [
"Default"
],
"summary": "Historical NBBO",
"description": "<p>Get historical best bid and offer for US stocks, LSE, TSX, Euronext and Deutsche Borse.</p><p>For US market, this endpoint only serves historical NBBO from the beginning of 2020.",
"operationId": "stock-nbbo_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Date: 2020-04-02.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of ticks returned. Maximum value: <code>25000</code>",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of ticks to skip. Use this parameter to loop through the entire data.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoricalNBBO"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/bidask": {
"get": {
"tags": [
"Default"
],
"summary": "Last Bid-Ask",
"description": "Get last bid/ask data for US stocks.",
"operationId": "stock-bidask_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LastBid-Ask"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/split": {
"get": {
"tags": [
"Default"
],
"summary": "Splits",
"description": "Get splits data for stocks.",
"operationId": "stock-splits_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "YYYY-MM-DD.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "YYYY-MM-DD.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Split"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/dividend2": {
"get": {
"tags": [
"Default"
],
"summary": "Dividends 2 (Basic)",
"description": "Get global dividends data.",
"operationId": "stock-basic-dividends_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dividends2"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/index/constituents": {
"get": {
"tags": [
"Default"
],
"summary": "Indices Constituents",
"description": "Get a list of index's constituents. A list of supported indices for this endpoint can be found <a href=\"/api/v1/index/list?token=\" target=\"_blank\">here</a>.",
"operationId": "indices-constituents_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "symbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndicesConstituents"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/index/historical-constituents": {
"get": {
"tags": [
"Default"
],
"summary": "Indices Historical Constituents",
"description": "Get full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC</code>, <code>^NDX</code>, <code>^DJI</code>",
"operationId": "indices-historical-constituents_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "symbol",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndicesHistoricalConstituents"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/etf/profile": {
"get": {
"tags": [
"Default"
],
"summary": "ETFs Profile",
"description": "Get ETF profile information. This endpoint has global coverage. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.",
"operationId": "etfs-profile_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "ETF symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ETF isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETFsProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/etf/holdings": {
"get": {
"tags": [
"Default"
],
"summary": "ETFs Holdings",
"description": "Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.",
"operationId": "etfs-holdings_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "ETF symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ETF isin.",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"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.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "date",
"in": "query",
"description": "Query holdings by date. You can use either this param or <code>skip</code> param, not both.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETFsHoldings"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/etf/sector": {
"get": {
"tags": [
"Default"
],
"summary": "ETFs Sector Exposure",
"description": "Get ETF sector exposure data.",
"operationId": "etfs-sector-exposure_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "ETF symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ETF isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETFsSectorExposure"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/etf/country": {
"get": {
"tags": [
"Default"
],
"summary": "ETFs Country Exposure",
"description": "Get ETF country exposure data.",
"operationId": "etfs-country-exposure_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "ETF symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "ETF isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETFsCountryExposure"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds Profile",
"description": "Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.",
"operationId": "mutual-fund-profile_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Fund's symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "Fund's isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/holdings": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds Holdings",
"description": "Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.",
"operationId": "mutual-fund-holdings_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Fund's symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "Fund's isin.",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"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.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundHoldings"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/sector": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds Sector Exposure",
"description": "Get Mutual Funds sector exposure data.",
"operationId": "mutual-fund-sector-exposure_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Mutual Fund symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "Fund's isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundSectorExposure"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/country": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds Country Exposure",
"description": "Get Mutual Funds country exposure data.",
"operationId": "mutual-fund-country-exposure_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"schema": {
"type": "string"
}
},
{
"name": "isin",
"in": "query",
"description": "Fund's isin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundCountryExposure"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/eet": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds EET",
"description": "Get EET data for EU funds. For PAIs data, please see the EET PAI endpoint.",
"operationId": "mutual-fund-eet_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundEet"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/mutual-fund/eet-pai": {
"get": {
"tags": [
"Default"
],
"summary": "Mutual Funds EET PAI",
"description": "Get EET PAI data for EU funds.",
"operationId": "mutual-fund-eet-pai_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutualFundEetPai"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/forex/exchange": {
"get": {
"tags": [
"Default"
],
"summary": "Forex Exchanges",
"description": "List supported forex exchanges",
"operationId": "forex-exchanges",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/forex/symbol": {
"get": {
"tags": [
"Default"
],
"summary": "Forex Symbol",
"description": "List supported forex symbols.",
"operationId": "forex-symbols",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange you want to get the list of symbols from.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForexSymbol"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/forex/candle": {
"get": {
"tags": [
"Default"
],
"summary": "Forex Candles",
"description": "Get candlestick data for forex symbols.",
"operationId": "forex-candles_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Use symbol returned in <code>/forex/symbol</code> endpoint for this field.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForexCandles"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/forex/rates": {
"get": {
"tags": [
"Default"
],
"summary": "Forex rates",
"description": "Get rates for all forex pairs. Ideal for currency conversion",
"operationId": "forex-rates_premium",
"parameters": [
{
"name": "base",
"in": "query",
"description": "Base currency. Default to EUR.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Date. Leave blank to get the latest data.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forexrates"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/crypto/exchange": {
"get": {
"tags": [
"Default"
],
"summary": "Crypto Exchanges",
"description": "List supported crypto exchanges",
"operationId": "crypto-exchanges",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/crypto/symbol": {
"get": {
"tags": [
"Default"
],
"summary": "Crypto Symbol",
"description": "List supported crypto symbols by exchange",
"operationId": "crypto-symbols",
"parameters": [
{
"name": "exchange",
"in": "query",
"description": "Exchange you want to get the list of symbols from.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CryptoSymbol"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/crypto/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Crypto Profile",
"description": "Get crypto's profile.",
"operationId": "crypto-profile_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Crypto symbol such as BTC or ETH.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CryptoProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/crypto/candle": {
"get": {
"tags": [
"Default"
],
"summary": "Crypto Candles",
"description": "Get candlestick data for crypto symbols.",
"operationId": "crypto-candles",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Use symbol returned in <code>/crypto/symbol</code> endpoint for this field.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CryptoCandles"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/scan/pattern": {
"get": {
"tags": [
"Default"
],
"summary": "Pattern Recognition",
"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_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatternRecognition"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/scan/support-resistance": {
"get": {
"tags": [
"Default"
],
"summary": "Support/Resistance",
"description": "Get support and resistance levels for a symbol.",
"operationId": "support-resistance_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupportResistance"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/scan/technical-indicator": {
"get": {
"tags": [
"Default"
],
"summary": "Aggregate Indicators",
"description": "Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v. A full list of indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing\" target=\"_blank\">here</a>.",
"operationId": "aggregate-indicator_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "symbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateIndicators"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/indicator": {
"get": {
"tags": [
"Default"
],
"summary": "Technical Indicators",
"description": "Return technical indicator with price data. List of supported indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.",
"operationId": "technical-indicator",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "symbol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resolution",
"in": "query",
"description": "Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "indicator",
"in": "query",
"description": "Indicator name. Full list can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Check out <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">this page</a> to see which indicators and params are supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndicatorFields"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TechnicalIndicator"
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "indicator_fields"
}
},
"/stock/transcripts/list": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Call Transcripts List",
"description": "List earnings call transcripts' metadata. This endpoint is available for US, UK, European, Australian and Canadian companies.",
"operationId": "transcripts-list_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol: AAPL. Leave empty to list the latest transcripts",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTranscriptsList"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/transcripts": {
"get": {
"tags": [
"Default"
],
"summary": "Earnings Call Transcripts",
"description": "<p>Get earnings call transcripts, audio and participants' list. Data is available for US, UK, European, Australian and Canadian companies.<p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>",
"operationId": "transcripts_premium",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarningsCallTranscripts"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/social-sentiment": {
"get": {
"tags": [
"Default"
],
"summary": "Social Sentiment",
"description": "<p>Get social sentiment for stocks on Reddit and Twitter.</p>",
"operationId": "social-sentiment_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Company symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocialSentiment"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/investment-theme": {
"get": {
"tags": [
"Default"
],
"summary": "Investment Themes (Thematic Investing)",
"description": "<p>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.",
"operationId": "investment-themes_premium",
"parameters": [
{
"name": "theme",
"in": "query",
"description": "Investment theme. A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvestmentThemes"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/supply-chain": {
"get": {
"tags": [
"Default"
],
"summary": "Supply Chain Relationships",
"description": "<p>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.</p>",
"operationId": "supply-chain-relationships_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SupplyChainRelationships"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/esg": {
"get": {
"tags": [
"Default"
],
"summary": "Company ESG Scores",
"description": "<p>This endpoint provides ESG scores and important indicators for 7000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p>",
"operationId": "company-esg-score_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyESG"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/earnings-quality-score": {
"get": {
"tags": [
"Default"
],
"summary": "Company Earnings Quality Score",
"description": "<p>This endpoint provides Earnings Quality Score for global companies.</p><p> Earnings quality refers to the extent to which current earnings predict future earnings. \"High-quality\" earnings are expected to persist, while \"low-quality\" earnings do not.",
"operationId": "company-earnings-quality-score_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "freq",
"in": "query",
"description": "Frequency. Currently support <code>annual</code> and <code>quarterly</code>",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyEarningsQualityScore"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/covid19/us": {
"get": {
"tags": [
"Default"
],
"summary": "COVID-19",
"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 <a href=\"https://rapidapi.com/Finnhub/api/finnhub-real-time-covid-19\" target=\"_blank\" rel=\"nofollow\">here</a>",
"operationId": "covid-19",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CovidInfo"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/fda-advisory-committee-calendar": {
"get": {
"tags": [
"Default"
],
"summary": "FDA Committee Meeting Calendar",
"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.",
"operationId": "fda-committee-meeting-calendar",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FDAComitteeMeeting"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/uspto-patent": {
"get": {
"tags": [
"Default"
],
"summary": "USPTO Patents",
"description": "List USPTO patents for companies. Limit to 250 records per API call.",
"operationId": "stock-uspto-patent",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsptoPatentResult"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/visa-application": {
"get": {
"tags": [
"Default"
],
"summary": "H1-B Visa Application",
"description": "Get a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.",
"operationId": "stock-visa-application",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VisaApplicationResult"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/lobbying": {
"get": {
"tags": [
"Default"
],
"summary": "Senate Lobbying",
"description": "Get a list of reported lobbying activities in the Senate and the House.",
"operationId": "stock-lobbying",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LobbyingResult"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/usa-spending": {
"get": {
"tags": [
"Default"
],
"summary": "USA Spending",
"description": "Get a list of government's spending activities from USASpending dataset for public companies. This dataset can help you identify companies that win big government contracts which is extremely important for industries such as Defense, Aerospace, and Education.",
"operationId": "stock-usa-spending",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>. Filter for <code>actionDate</code>",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsaSpendingResult"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/congressional-trading": {
"get": {
"tags": [
"Default"
],
"summary": "Congressional Trading",
"description": "Get stock trades data disclosed by members of congress.",
"operationId": "congressional-trading_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol of the company: AAPL.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CongressionalTrading"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bond/profile": {
"get": {
"tags": [
"Default"
],
"summary": "Bond Profile",
"description": "Get general information of a bond. You can query by FIGI, ISIN or CUSIP. A list of supported bonds can be found <a href=\"/api/v1/bond/list?token=\" target=\"_blank\">here</a>.",
"operationId": "bond-profile_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN",
"schema": {
"type": "string"
}
},
{
"name": "cusip",
"in": "query",
"description": "CUSIP",
"schema": {
"type": "string"
}
},
{
"name": "figi",
"in": "query",
"description": "FIGI",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BondProfile"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bond/price": {
"get": {
"tags": [
"Default"
],
"summary": "Bond price data",
"description": "Get bond's price data. The following datasets are supported: Exchange, Segment, Delay, US Government Bonds, Government Bonds, End-of-day, FINRA Trace, BTDS: US Corporate Bonds, Delayed 4h, FINRA Trace, 144A Bonds, Delayed 4h",
"operationId": "bond-price_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UNIX timestamp. Interval initial value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "to",
"in": "query",
"description": "UNIX timestamp. Interval end value.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BondCandles"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bond/tick": {
"get": {
"tags": [
"Default"
],
"summary": "Bond Tick Data",
"description": "Get trade-level data for bonds. The following datasets are supported: Exchange, Segment, Delay, FINRA Trace, BTDS: US Corporate Bonds, Delayed 4h, FINRA Trace, 144A Bonds, Delayed 4h.",
"operationId": "bond-tick_premium",
"parameters": [
{
"name": "isin",
"in": "query",
"description": "ISIN.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"description": "Date: 2020-04-02.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of ticks returned. Maximum value: <code>25000</code>",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of ticks to skip. Use this parameter to loop through the entire data.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "exchange",
"in": "query",
"description": "Currently support the following values: <code>trace</code>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BondTickData"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bond/yield-curve": {
"get": {
"tags": [
"Default"
],
"summary": "Bond Yield Curve",
"description": "Get yield curve data for Treasury bonds.",
"operationId": "bond-yield-curve_premium",
"parameters": [
{
"name": "code",
"in": "query",
"description": "Bond's code. You can find the list of supported code <a href=\"https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing\" target=\"_blank\" rel=\"noopener\">here</a>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BondYieldCurve"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/country": {
"get": {
"tags": [
"Default"
],
"summary": "Country Metadata",
"description": "List all countries and metadata.",
"operationId": "country",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryMetadata"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/calendar/economic": {
"get": {
"tags": [
"Default"
],
"summary": "Economic Calendar",
"description": "<p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>",
"operationId": "economic-calendar_premium",
"parameters": [
{
"name": "from",
"in": "query",
"description": "From date <code>YYYY-MM-DD</code>.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "To date <code>YYYY-MM-DD</code>.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EconomicCalendar"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/economic/code": {
"get": {
"tags": [
"Default"
],
"summary": "Economic Code",
"description": "List codes of supported economic data.",
"operationId": "economic-code_premium",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EconomicCode"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/economic": {
"get": {
"tags": [
"Default"
],
"summary": "Economic Data",
"description": "Get economic data.",
"operationId": "economic-data_premium",
"parameters": [
{
"name": "code",
"in": "query",
"description": "Economic code.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EconomicData"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/stock/international-filings": {
"get": {
"tags": [
"Default"
],
"summary": "International Filings",
"description": "List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage.",
"operationId": "international-filings_premium",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol. Leave empty to list latest filings.",
"schema": {
"type": "string"
}
},
{
"name": "country",
"in": "query",
"description": "Filter by country using country's 2-letter code.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InternationalFiling"
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/global-filings/search": {
"post": {
"tags": [
"Default"
],
"summary": "Global Filings Search",
"description": "<p>Search for best-matched filings across global companies' filings, transcripts and press releases. You can filter by anything from symbol, ISIN to form type, and document sources.</p><p>This endpoint will return a list of documents that match your search criteria.",
"operationId": "global-filings-search_premium",
"requestBody": {
"description": "Search body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchBody"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "search"
}
},
"/global-filings/search-in-filing": {
"post": {
"tags": [
"Default"
],
"summary": "Search In Filing",
"description": "<p>Get a list of excerpts and highlight positions within a document using your query.</p>",
"operationId": "search-in-filing_premium",
"requestBody": {
"description": "Search body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InFilingSearchBody"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InFilingResponse"
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "search"
}
},
"/global-filings/filter": {
"get": {
"tags": [
"Default"
],
"summary": "Search Filter",
"description": "<p>Get available values for each filter in search body.</p>",
"operationId": "global-filings-search-filter_premium",
"parameters": [
{
"name": "field",
"in": "query",
"description": "Field to get available filters. Available filters are \"countries\", \"exchanges\", \"exhibits\", \"forms\", \"gics\", \"naics\", \"caps\", \"acts\", and \"sort\".",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "Get available forms for each source.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchFilter"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/global-filings/download": {
"get": {
"tags": [
"Default"
],
"summary": "Download Filings",
"description": "<p>Download filings using document ids.</p>",
"operationId": "global-filings-download_premium",
"parameters": [
{
"name": "documentId",
"in": "query",
"description": "Document's id. Note that this is different from filingId as 1 filing can contain multiple documents.",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"api_key": []
}
]
}
}
},
"components": {
"schemas": {
"SearchBody": {
"required": [
"query"
],
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Search query"
},
"isins": {
"type": "string",
"description": "List of isin to search, comma separated (Max: 50)."
},
"cusips": {
"type": "string",
"description": "List of cusip to search, comma separated (Max: 50)."
},
"ciks": {
"type": "string",
"description": "List of SEC Center Index Key to search, comma separated (Max: 50)."
},
"sedarIds": {
"type": "string",
"description": "List of SEDAR issuer number to search, comma separated (Max: 50)."
},
"chIds": {
"type": "string",
"description": "List of Companies House number to search, comma separated (Max: 50)."
},
"symbols": {
"type": "string",
"description": "List of symbols to search, comma separated (Max: 50)."
},
"sedols": {
"type": "string",
"description": "List of sedols to search, comma separated (Max: 50)."
},
"sources": {
"type": "string",
"description": "List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"forms": {
"type": "string",
"description": "List of forms to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"gics": {
"type": "string",
"description": "List of gics to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"naics": {
"type": "string",
"description": "List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"exhibits": {
"type": "string",
"description": "List of exhibits to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"exchanges": {
"type": "string",
"description": "List of exchanges to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"countries": {
"type": "string",
"description": "List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values."
},
"acts": {
"type": "string",
"description": "List of SEC's exchanges act to search, comma separated. Look at <code>/filter</code> endpoint to see all available values."
},
"caps": {
"type": "string",
"description": "List of market capitalization to search, comma separated. Look at <code>/filter</code> endpoint to see all available values."
},
"fromDate": {
"type": "string",
"description": "Search from date in format: YYYY-MM-DD, default from the last 2 years"
},
"toDate": {
"type": "string",
"description": "Search to date in format: YYYY-MM-DD, default to today"
},
"page": {
"type": "string",
"description": "Use for pagination, default to page 1"
},
"sort": {
"type": "string",
"description": "Sort result by, default: sortMostRecent. Look at <code>/filter</code> endpoint to see all available values."
},
"highlighted": {
"type": "boolean",
"description": "Enable highlight in returned filings. If enabled, only return 10 results each time"
}
}
},
"InFilingSearchBody": {
"required": [
"filingId",
"query"
],
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Search query"
},
"filingId": {
"type": "string",
"description": "Filing Id to search"
}
}
},
"SearchResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Total filing matched your search criteria."
},
"took": {
"type": "integer",
"description": "Time took to execute your search query on our server, value in ms."
},
"page": {
"type": "integer",
"description": "Current search page"
},
"filings": {
"type": "array",
"description": "Filing match your search criteria.",
"items": {
"$ref": "#/components/schemas/FilingResponse"
}
}
}
},
"FilingResponse": {
"type": "object",
"properties": {
"filingId": {
"type": "string",
"description": "Filing Id in Alpharesearch platform"
},
"title": {
"type": "string",
"description": "Filing title"
},
"filerId": {
"type": "string",
"description": "Id of the entity submitted the filing"
},
"symbol": {
"type": "object",
"description": "List of symbol associate with this filing"
},
"name": {
"type": "string",
"description": "Filer name"
},
"acceptanceDate": {
"type": "string",
"description": "Date the filing is submitted."
},
"filedDate": {
"type": "string",
"description": "Date the filing is make available to the public"
},
"reportDate": {
"type": "string",
"description": "Date as which the filing is reported"
},
"form": {
"type": "string",
"description": "Filing Form"
},
"amend": {
"type": "boolean",
"description": "Amendment"
},
"source": {
"type": "string",
"description": "Filing Source"
},
"pageCount": {
"type": "integer",
"description": "Estimate number of page when printing"
},
"documentCount": {
"type": "integer",
"description": "Number of document in this filing"
}
}
},
"InFilingResponse": {
"type": "object",
"properties": {
"filingId": {
"type": "string",
"description": "Filing Id in Alpharesearch platform"
},
"title": {
"type": "string",
"description": "Filing title"
},
"filerId": {
"type": "string",
"description": "Id of the entity submitted the filing"
},
"symbol": {
"type": "object",
"description": "List of symbol associate with this filing"
},
"name": {
"type": "string",
"description": "Filer name"
},
"acceptanceDate": {
"type": "string",
"description": "Date the filing is submitted."
},
"filedDate": {
"type": "string",
"description": "Date the filing is make available to the public"
},
"reportDate": {
"type": "string",
"description": "Date as which the filing is reported"
},
"form": {
"type": "string",
"description": "Filing Form"
},
"amend": {
"type": "boolean",
"description": "Amendment"
},
"source": {
"type": "string",
"description": "Filing Source"
},
"pageCount": {
"type": "integer",
"description": "Estimate number of page when printing"
},
"documentCount": {
"type": "integer",
"description": "Number of document in this filing"
},
"documents": {
"type": "array",
"description": "Document for this filing.",
"items": {
"$ref": "#/components/schemas/DocumentResponse"
}
}
}
},
"DocumentResponse": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "AlphaResearch internal document id."
},
"title": {
"type": "string",
"description": "Title for this document."
},
"hits": {
"type": "string",
"description": "Number of hit in this document"
},
"url": {
"type": "string",
"description": "Link to render this document"
},
"format": {
"type": "string",
"description": "Format of this document (can be html or pdf)"
},
"excerpts": {
"type": "array",
"description": "Highlighted excerpts for this document",
"items": {
"$ref": "#/components/schemas/ExcerptResponse"
}
}
}
},
"ExcerptResponse": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "Highlighted content"
},
"snippetId": {
"type": "string",
"description": "Location of the content in the rendered document"
},
"startOffset": {
"type": "string",
"description": "Start offset of highlighted content"
},
"endOffset": {
"type": "string",
"description": "End offset of highlighted content"
}
}
},
"SearchFilter": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Filter id, use with respective field in search query body."
},
"name": {
"type": "string",
"description": "Display name."
}
}
},
"StockSymbol": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Symbol description"
},
"displaySymbol": {
"type": "string",
"description": "Display symbol name."
},
"symbol": {
"type": "string",
"description": "Unique symbol used to identify this symbol used in <code>/stock/candle</code> endpoint."
},
"type": {
"type": "string",
"description": "Security type."
},
"mic": {
"type": "string",
"description": "Primary exchange's MIC."
},
"figi": {
"type": "string",
"description": "FIGI identifier."
},
"shareClassFIGI": {
"type": "string",
"description": "Global Share Class FIGI."
},
"currency": {
"type": "string",
"description": "Price's currency. This might be different from the reporting currency of fundamental data."
},
"symbol2": {
"type": "string",
"description": "Alternative ticker for exchanges with multiple tickers for 1 stock such as BSE."
},
"isin": {
"type": "string",
"description": "ISIN. This field is only available for EU stocks and selected Asian markets. Entitlement from Finnhub is required to access this field."
}
}
},
"SymbolLookup": {
"type": "object",
"properties": {
"result": {
"type": "array",
"description": "Array of search results.",
"items": {
"$ref": "#/components/schemas/SymbolLookupInfo"
}
},
"count": {
"type": "integer",
"description": "Number of results.",
"format": "int64"
}
}
},
"SymbolLookupInfo": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Symbol description"
},
"displaySymbol": {
"type": "string",
"description": "Display symbol name."
},
"symbol": {
"type": "string",
"description": "Unique symbol used to identify this symbol used in <code>/stock/candle</code> endpoint."
},
"type": {
"type": "string",
"description": "Security type."
}
}
},
"InstitutionalPortfolio": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Investor's name."
},
"cik": {
"type": "string",
"description": "CIK."
},
"data": {
"type": "array",
"description": "Array of positions.",
"items": {
"$ref": "#/components/schemas/InstitutionalPortfolioGroup"
}
}
}
},
"MarketStatus": {
"type": "object",
"properties": {
"exchange": {
"type": "string",
"description": "Exchange."
},
"timezone": {
"type": "string",
"description": "Timezone."
},
"session": {
"type": "string",
"description": "Market session."
},
"holiday": {
"type": "string",
"description": "Holiday event."
},
"isOpen": {
"type": "boolean",
"description": "Whether the market is open at the moment."
},
"t": {
"type": "integer",
"description": "Current timestamp.",
"format": "int64"
}
}
},
"MarketHolidayData": {
"type": "object",
"properties": {
"eventName": {
"type": "string",
"description": "Holiday's name."
},
"atDate": {
"type": "string",
"description": "Date."
},
"tradingHour": {
"type": "string",
"description": "Trading hours for this day if the market is partially closed only."
}
}
},
"MarketHoliday": {
"type": "object",
"properties": {
"timezone": {
"type": "string",
"description": "Timezone."
},
"exchange": {
"type": "string",
"description": "Exchange."
},
"data": {
"type": "array",
"description": "Array of holidays.",
"items": {
"$ref": "#/components/schemas/MarketHolidayData"
}
}
}
},
"CompanyProfile": {
"type": "object",
"properties": {
"alias": {
"type": "array",
"description": "Company name alias.",
"items": {
"type": "string"
}
},
"address": {
"type": "string",
"description": "Address of company's headquarter."
},
"city": {
"type": "string",
"description": "City of company's headquarter."
},
"country": {
"type": "string",
"description": "Country of company's headquarter."
},
"currency": {
"type": "string",
"description": "Currency used in company filings and financials."
},
"estimateCurrency": {
"type": "string",
"description": "Currency used in Estimates data."
},
"marketCapCurrency": {
"type": "string",
"description": "Currency used in market capitalization."
},
"cusip": {
"type": "string",
"description": "CUSIP number."
},
"sedol": {
"type": "string",
"description": "Sedol number."
},
"description": {
"type": "string",
"description": "Company business summary."
},
"exchange": {
"type": "string",
"description": "Listed exchange."
},
"ggroup": {
"type": "string",
"description": "Industry group."
},
"gind": {
"type": "string",
"description": "Industry."
},
"gsector": {
"type": "string",
"description": "Sector."
},
"gsubind": {
"type": "string",
"description": "Sub-industry."
},
"isin": {
"type": "string",
"description": "ISIN number."
},
"lei": {
"type": "string",
"description": "LEI number."
},
"naicsNationalIndustry": {
"type": "string",
"description": "NAICS national industry."
},
"naics": {
"type": "string",
"description": "NAICS industry."
},
"naicsSector": {
"type": "string",
"description": "NAICS sector."
},
"naicsSubsector": {
"type": "string",
"description": "NAICS subsector."
},
"name": {
"type": "string",
"description": "Company name."
},
"phone": {
"type": "string",
"description": "Company phone number."
},
"state": {
"type": "string",
"description": "State of company's headquarter."
},
"ticker": {
"type": "string",
"description": "Company symbol/ticker as used on the listed exchange."
},
"weburl": {
"type": "string",
"description": "Company website."
},
"ipo": {
"type": "string",
"description": "IPO date.",
"format": "date"
},
"marketCapitalization": {
"type": "number",
"description": "Market Capitalization.",
"format": "float"
},
"shareOutstanding": {
"type": "number",
"description": "Number of oustanding shares.",
"format": "float"
},
"employeeTotal": {
"type": "number",
"description": "Number of employee.",
"format": "float"
},
"logo": {
"type": "string",
"description": "Logo image."
},
"finnhubIndustry": {
"type": "string",
"description": "Finnhub industry classification."
}
}
},
"CompanyProfile2": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country of company's headquarter."
},
"currency": {
"type": "string",
"description": "Currency used in company filings."
},
"exchange": {
"type": "string",
"description": "Listed exchange."
},
"name": {
"type": "string",
"description": "Company name."
},
"ticker": {
"type": "string",
"description": "Company symbol/ticker as used on the listed exchange."
},
"ipo": {
"type": "string",
"description": "IPO date.",
"format": "date"
},
"marketCapitalization": {
"type": "number",
"description": "Market Capitalization.",
"format": "float"
},
"shareOutstanding": {
"type": "number",
"description": "Number of oustanding shares.",
"format": "float"
},
"logo": {
"type": "string",
"description": "Logo image."
},
"phone": {
"type": "string",
"description": "Company phone number."
},
"weburl": {
"type": "string",
"description": "Company website."
},
"finnhubIndustry": {
"type": "string",
"description": "Finnhub industry classification."
}
}
},
"Company": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Executive name"
},
"age": {
"type": "integer",
"description": "Age",
"format": "int64"
},
"title": {
"type": "string",
"description": "Title"
},
"since": {
"type": "string",
"description": "Year first appointed as executive/director of the company"
},
"sex": {
"type": "string",
"description": "Sex"
},
"compensation": {
"type": "integer",
"description": "Total compensation",
"format": "int64"
},
"currency": {
"type": "string",
"description": "Compensation currency"
}
}
},
"CompanyExecutive": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"executive": {
"type": "array",
"description": "Array of company's executives and members of the Board.",
"items": {
"$ref": "#/components/schemas/Company"
}
}
}
},
"MarketNews": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "News category."
},
"datetime": {
"type": "integer",
"description": "Published time in UNIX timestamp.",
"format": "int64"
},
"headline": {
"type": "string",
"description": "News headline."
},
"id": {
"type": "integer",
"description": "News ID. This value can be used for <code>minId</code> params to get the latest news only.",
"format": "int64"
},
"image": {
"type": "string",
"description": "Thumbnail image URL."
},
"related": {
"type": "string",
"description": "Related stocks and companies mentioned in the article."
},
"source": {
"type": "string",
"description": "News source."
},
"summary": {
"type": "string",
"description": "News summary."
},
"url": {
"type": "string",
"description": "URL of the original article."
}
}
},
"CompanyNews": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "News category."
},
"datetime": {
"type": "integer",
"description": "Published time in UNIX timestamp.",
"format": "int64"
},
"headline": {
"type": "string",
"description": "News headline."
},
"id": {
"type": "integer",
"description": "News ID. This value can be used for <code>minId</code> params to get the latest news only.",
"format": "int64"
},
"image": {
"type": "string",
"description": "Thumbnail image URL."
},
"related": {
"type": "string",
"description": "Related stocks and companies mentioned in the article."
},
"source": {
"type": "string",
"description": "News source."
},
"summary": {
"type": "string",
"description": "News summary."
},
"url": {
"type": "string",
"description": "URL of the original article."
}
}
},
"Development": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"datetime": {
"type": "string",
"description": "Published time in <code>YYYY-MM-DD HH:MM:SS</code> format."
},
"headline": {
"type": "string",
"description": "Development headline."
},
"description": {
"type": "string",
"description": "Development description."
},
"url": {
"type": "string",
"description": "URL."
}
}
},
"PressRelease": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"majorDevelopment": {
"type": "array",
"description": "Array of major developments.",
"items": {
"$ref": "#/components/schemas/Development"
}
}
}
},
"CompanyNewsStatistics": {
"type": "object",
"properties": {
"articlesInLastWeek": {
"type": "integer",
"description": "",
"format": "int64"
},
"buzz": {
"type": "number",
"description": "",
"format": "float"
},
"weeklyAverage": {
"type": "number",
"description": "",
"format": "float"
}
}
},
"Sentiment": {
"type": "object",
"properties": {
"bearishPercent": {
"type": "number",
"description": "",
"format": "float"
},
"bullishPercent": {
"type": "number",
"description": "",
"format": "float"
}
}
},
"NewsSentiment": {
"type": "object",
"properties": {
"buzz": {
"$ref": "#/components/schemas/CompanyNewsStatistics"
},
"companyNewsScore": {
"type": "number",
"description": "News score.",
"format": "float"
},
"sectorAverageBullishPercent": {
"type": "number",
"description": "Sector average bullish percent.",
"format": "float"
},
"sectorAverageNewsScore": {
"type": "number",
"description": "Sectore average score.",
"format": "float"
},
"sentiment": {
"$ref": "#/components/schemas/Sentiment"
},
"symbol": {
"type": "string",
"description": "Requested symbol."
}
}
},
"MetricSeriesMap": {
"type": "object",
"properties": {}
},
"MetricMap": {
"type": "object",
"properties": {}
},
"PriceMetricMap": {
"type": "object",
"properties": {}
},
"BasicFinancials": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"metricType": {
"type": "string",
"description": "Metric type."
},
"series": {
"$ref": "#/components/schemas/MetricSeriesMap"
},
"metric": {
"$ref": "#/components/schemas/MetricMap"
}
}
},
"PriceMetrics": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"atDate": {
"type": "string",
"description": "Data date."
},
"data": {
"$ref": "#/components/schemas/PriceMetricMap"
}
}
},
"CongressionalTransaction": {
"type": "object",
"properties": {
"amountFrom": {
"type": "number",
"description": "Transaction amount from.",
"format": "float"
},
"amountTo": {
"type": "number",
"description": "Transaction amount to.",
"format": "float"
},
"assetName": {
"type": "string",
"description": "Asset name."
},
"filingDate": {
"type": "string",
"description": "Filing date."
},
"name": {
"type": "string",
"description": "Name of the representative."
},
"ownerType": {
"type": "string",
"description": "Owner Type."
},
"position": {
"type": "string",
"description": "Position."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"transactionDate": {
"type": "string",
"description": "Transaction date."
},
"transactionType": {
"type": "string",
"description": "Transaction type <code>Sale</code> or <code>Purchase</code>."
}
}
},
"CongressionalTrading": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"data": {
"type": "array",
"description": "Array of stock trades.",
"items": {
"$ref": "#/components/schemas/CongressionalTransaction"
}
}
}
},
"IsinChangeInfo": {
"type": "object",
"properties": {
"atDate": {
"type": "string",
"description": "Event's date."
},
"oldIsin": {
"type": "string",
"description": "Old ISIN."
},
"newIsin": {
"type": "string",
"description": "New ISIN."
}
}
},
"IsinChange": {
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "From date."
},
"toDate": {
"type": "string",
"description": "To date."
},
"data": {
"type": "array",
"description": "Array of ISIN change events.",
"items": {
"$ref": "#/components/schemas/IsinChangeInfo"
}
}
}
},
"SymbolChangeInfo": {
"type": "object",
"properties": {
"atDate": {
"type": "string",
"description": "Event's date."
},
"oldSymbol": {
"type": "string",
"description": "Old symbol."
},
"newSymbol": {
"type": "string",
"description": "New symbol."
}
}
},
"SymbolChange": {
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "From date."
},
"toDate": {
"type": "string",
"description": "To date."
},
"data": {
"type": "array",
"description": "Array of symbol change events.",
"items": {
"$ref": "#/components/schemas/SymbolChangeInfo"
}
}
}
},
"InstitutionalPortfolioInfo": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"name": {
"type": "string",
"description": "Position's name."
},
"putCall": {
"type": "string",
"description": "<code>put</code> or <code>call</code> for options."
},
"change": {
"type": "number",
"description": "Number of shares change.",
"format": "float"
},
"noVoting": {
"type": "number",
"description": "Number of shares with no voting rights.",
"format": "float"
},
"percentage": {
"type": "number",
"description": "Percentage of portfolio.",
"format": "float"
},
"share": {
"type": "number",
"description": "Number of shares.",
"format": "float"
},
"sharedVoting": {
"type": "number",
"description": "Number of shares with shared voting rights.",
"format": "float"
},
"soleVoting": {
"type": "number",
"description": "Number of shares with sole voting rights.",
"format": "float"
},
"value": {
"type": "number",
"description": "Position value.",
"format": "float"
}
}
},
"InstitutionalPortfolioGroup": {
"type": "object",
"properties": {
"reportDate": {
"type": "string",
"description": "Report date."
},
"filingDate": {
"type": "string",
"description": "Filing date."
},
"portfolio": {
"type": "array",
"description": "Array of positions.",
"items": {
"$ref": "#/components/schemas/InstitutionalPortfolioInfo"
}
}
}
},
"InstitutionalOwnershipInfo": {
"type": "object",
"properties": {
"cik": {
"type": "string",
"description": "Investor's company CIK."
},
"name": {
"type": "string",
"description": "Firm's name."
},
"putCall": {
"type": "string",
"description": "<code>put</code> or <code>call</code> for options."
},
"change": {
"type": "number",
"description": "Number of shares change.",
"format": "float"
},
"noVoting": {
"type": "number",
"description": "Number of shares with no voting rights.",
"format": "float"
},
"percentage": {
"type": "number",
"description": "Percentage of portfolio.",
"format": "float"
},
"share": {
"type": "number",
"description": "News score.",
"format": "float"
},
"sharedVoting": {
"type": "number",
"description": "Number of shares with shared voting rights.",
"format": "float"
},
"soleVoting": {
"type": "number",
"description": "Number of shares with sole voting rights.",
"format": "float"
},
"value": {
"type": "number",
"description": "Position value.",
"format": "float"
}
}
},
"InstitutionalOwnershipGroup": {
"type": "object",
"properties": {
"reportDate": {
"type": "string",
"description": "Report date."
},
"ownership": {
"type": "array",
"description": "Array of institutional investors.",
"items": {
"$ref": "#/components/schemas/InstitutionalOwnershipInfo"
}
}
}
},
"InstitutionalOwnership": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"cusip": {
"type": "string",
"description": "Cusip."
},
"data": {
"type": "array",
"description": "Array of institutional investors.",
"items": {
"$ref": "#/components/schemas/InstitutionalOwnershipGroup"
}
}
}
},
"InstitutionalProfileInfo": {
"type": "object",
"properties": {
"cik": {
"type": "string",
"description": "Investor's company CIK."
},
"firmType": {
"type": "string",
"description": "Firm type."
},
"manager": {
"type": "string",
"description": "Manager."
},
"philosophy": {
"type": "string",
"description": "Investing philosophy."
},
"profile": {
"type": "string",
"description": "Profile info."
},
"profileImg": {
"type": "string",
"description": "Profile image."
}
}
},
"InstitutionalProfile": {
"type": "object",
"properties": {
"cik": {
"type": "string",
"description": "CIK."
},
"data": {
"type": "array",
"description": "Array of investors.",
"items": {
"$ref": "#/components/schemas/InstitutionalProfileInfo"
}
}
}
},
"OwnershipInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Investor's name."
},
"share": {
"type": "integer",
"description": "Number of shares held by the investor.",
"format": "int64"
},
"change": {
"type": "integer",
"description": "Number of share changed (net buy or sell) from the last period.",
"format": "int64"
},
"filingDate": {
"type": "string",
"description": "Filing date.",
"format": "date"
}
}
},
"Ownership": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"ownership": {
"type": "array",
"description": "Array of investors with detailed information about their holdings.",
"items": {
"$ref": "#/components/schemas/OwnershipInfo"
}
}
}
},
"FundOwnershipInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Investor's name."
},
"share": {
"type": "integer",
"description": "Number of shares held by the investor.",
"format": "int64"
},
"change": {
"type": "integer",
"description": "Number of share changed (net buy or sell) from the last period.",
"format": "int64"
},
"filingDate": {
"type": "string",
"description": "Filing date.",
"format": "date"
},
"portfolioPercent": {
"type": "number",
"description": "Percent of the fund's portfolio comprised of the company's share.",
"format": "float"
}
}
},
"FundOwnership": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"ownership": {
"type": "array",
"description": "Array of investors with detailed information about their holdings.",
"items": {
"$ref": "#/components/schemas/FundOwnershipInfo"
}
}
}
},
"Transactions": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"name": {
"type": "string",
"description": "Insider's name."
},
"share": {
"type": "integer",
"description": "Number of shares held after the transaction.",
"format": "int64"
},
"change": {
"type": "integer",
"description": "Number of share changed from the last period. A positive value suggests a <code>BUY</code> transaction. A negative value suggests a <code>SELL</code> transaction.",
"format": "int64"
},
"filingDate": {
"type": "string",
"description": "Filing date.",
"format": "date"
},
"transactionDate": {
"type": "string",
"description": "Transaction date.",
"format": "date"
},
"transactionPrice": {
"type": "number",
"description": "Average transaction price.",
"format": "float"
},
"transactionCode": {
"type": "string",
"description": "Transaction code. A list of codes and their meanings can be found <a href=\"https://www.sec.gov/about/forms/form4data.pdf\" target=\"_blank\" rel=\"noopener\">here</a>."
}
}
},
"InsiderTransactions": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"data": {
"type": "array",
"description": "Array of insider transactions.",
"items": {
"$ref": "#/components/schemas/Transactions"
}
}
}
},
"InsiderSentimentsData": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"year": {
"type": "integer",
"description": "Year.",
"format": "int64"
},
"month": {
"type": "integer",
"description": "Month.",
"format": "int64"
},
"change": {
"type": "integer",
"description": "Net buying/selling from all insiders' transactions.",
"format": "int64"
},
"mspr": {
"type": "number",
"description": "Monthly share purchase ratio.",
"format": "float"
}
}
},
"InsiderSentiments": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"data": {
"type": "array",
"description": "Array of sentiment data.",
"items": {
"$ref": "#/components/schemas/InsiderSentimentsData"
}
}
}
},
"FinancialMap": {
"type": "object",
"properties": {}
},
"FinancialStatements": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol of the company."
},
"financials": {
"type": "array",
"description": "An array of map of key, value pairs containing the data for each period.",
"items": {
"$ref": "#/components/schemas/FinancialMap"
}
}
}
},
"ReportDataMap": {
"type": "object",
"properties": {}
},
"Report": {
"type": "object",
"properties": {
"accessNumber": {
"type": "string",
"description": "Access number."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"cik": {
"type": "string",
"description": "CIK."
},
"year": {
"type": "integer",
"description": "Year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Quarter.",
"format": "int64"
},
"form": {
"type": "string",
"description": "Form type."
},
"startDate": {
"type": "string",
"description": "Period start date <code>%Y-%m-%d %H:%M:%S</code>."
},
"endDate": {
"type": "string",
"description": "Period end date <code>%Y-%m-%d %H:%M:%S</code>."
},
"filedDate": {
"type": "string",
"description": "Filed date <code>%Y-%m-%d %H:%M:%S</code>."
},
"acceptedDate": {
"type": "string",
"description": "Accepted date <code>%Y-%m-%d %H:%M:%S</code>."
},
"report": {
"$ref": "#/components/schemas/ReportDataMap"
}
}
},
"FinancialsAsReported": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"cik": {
"type": "string",
"description": "CIK"
},
"data": {
"type": "array",
"description": "Array of filings.",
"items": {
"$ref": "#/components/schemas/Report"
}
}
}
},
"BreakdownItemMap": {
"type": "object",
"properties": {}
},
"BreakdownItem": {
"type": "object",
"properties": {
"accessNumber": {
"type": "string",
"description": "Access number of the report from which the data is sourced."
},
"breakdown": {
"$ref": "#/components/schemas/BreakdownItemMap"
}
}
},
"RevenueBreakdown": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"cik": {
"type": "string",
"description": "CIK"
},
"data": {
"type": "array",
"description": "Array of revenue breakdown over multiple periods.",
"items": {
"$ref": "#/components/schemas/BreakdownItem"
}
}
}
},
"Filing": {
"type": "object",
"properties": {
"accessNumber": {
"type": "string",
"description": "Access number."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"cik": {
"type": "string",
"description": "CIK."
},
"form": {
"type": "string",
"description": "Form type."
},
"filedDate": {
"type": "string",
"description": "Filed date <code>%Y-%m-%d %H:%M:%S</code>."
},
"acceptedDate": {
"type": "string",
"description": "Accepted date <code>%Y-%m-%d %H:%M:%S</code>."
},
"reportUrl": {
"type": "string",
"description": "Report's URL."
},
"filingUrl": {
"type": "string",
"description": "Filing's URL."
}
}
},
"InternationalFiling": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"companyName": {
"type": "string",
"description": "Company name."
},
"filedDate": {
"type": "string",
"description": "Filed date <code>%Y-%m-%d %H:%M:%S</code>."
},
"category": {
"type": "string",
"description": "Category."
},
"title": {
"type": "string",
"description": "Document's title."
},
"description": {
"type": "string",
"description": "Document's description."
},
"url": {
"type": "string",
"description": "Url."
},
"language": {
"type": "string",
"description": "Language."
},
"country": {
"type": "string",
"description": "Country."
}
}
},
"FilingSentiment": {
"type": "object",
"properties": {
"negative": {
"type": "number",
"description": "% of negative words in the filing.",
"format": "float"
},
"positive": {
"type": "number",
"description": "% of positive words in the filing.",
"format": "float"
},
"polarity": {
"type": "number",
"description": "% of polarity words in the filing.",
"format": "float"
},
"litigious": {
"type": "number",
"description": "% of litigious words in the filing.",
"format": "float"
},
"uncertainty": {
"type": "number",
"description": "% of uncertainty words in the filing.",
"format": "float"
},
"constraining": {
"type": "number",
"description": "% of constraining words in the filing.",
"format": "float"
},
"modal-weak": {
"type": "number",
"description": "% of modal-weak words in the filing.",
"format": "float"
},
"modal-strong": {
"type": "number",
"description": "% of modal-strong words in the filing.",
"format": "float"
},
"modal-moderate": {
"type": "number",
"description": "% of modal-moderate words in the filing.",
"format": "float"
}
}
},
"SECSentimentAnalysis": {
"type": "object",
"properties": {
"accessNumber": {
"type": "string",
"description": "Access number."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"cik": {
"type": "string",
"description": "CIK."
},
"sentiment": {
"$ref": "#/components/schemas/FilingSentiment"
}
}
},
"SimilarityIndexInfo": {
"type": "object",
"properties": {
"cik": {
"type": "string",
"description": "CIK."
},
"item1": {
"type": "number",
"description": "Cosine similarity of Item 1 (Business). This number is only available for Annual reports.",
"format": "float"
},
"item1a": {
"type": "number",
"description": "Cosine similarity of Item 1A (Risk Factors). This number is available for both Annual and Quarterly reports.",
"format": "float"
},
"item2": {
"type": "number",
"description": "Cosine similarity of Item 2 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Quarterly reports.",
"format": "float"
},
"item7": {
"type": "number",
"description": "Cosine similarity of Item 7 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Annual reports.",
"format": "float"
},
"item7a": {
"type": "number",
"description": "Cosine similarity of Item 7A (Quantitative and Qualitative Disclosures About Market Risk). This number is only available for Annual reports.",
"format": "float"
},
"accessNumber": {
"type": "string",
"description": "Access number."
},
"form": {
"type": "string",
"description": "Form type."
},
"filedDate": {
"type": "string",
"description": "Filed date <code>%Y-%m-%d %H:%M:%S</code>."
},
"acceptedDate": {
"type": "string",
"description": "Accepted date <code>%Y-%m-%d %H:%M:%S</code>."
},
"reportUrl": {
"type": "string",
"description": "Report's URL."
},
"filingUrl": {
"type": "string",
"description": "Filing's URL."
}
}
},
"SimilarityIndex": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"cik": {
"type": "string",
"description": "CIK."
},
"similarity": {
"type": "array",
"description": "Array of filings with its cosine similarity compared to the same report of the previous year.",
"items": {
"$ref": "#/components/schemas/SimilarityIndexInfo"
}
}
}
},
"IPOEvent": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"date": {
"type": "string",
"description": "IPO date.",
"format": "date"
},
"exchange": {
"type": "string",
"description": "Exchange."
},
"name": {
"type": "string",
"description": "Company's name."
},
"status": {
"type": "string",
"description": "IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code>"
},
"price": {
"type": "string",
"description": "Projected price or price range."
},
"numberOfShares": {
"type": "number",
"description": "Number of shares offered during the IPO.",
"format": "float"
},
"totalSharesValue": {
"type": "number",
"description": "Total shares value.",
"format": "float"
}
}
},
"IPOCalendar": {
"type": "object",
"properties": {
"ipoCalendar": {
"type": "array",
"description": "Array of IPO events.",
"items": {
"$ref": "#/components/schemas/IPOEvent"
}
}
}
},
"Dividends": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"date": {
"type": "string",
"description": "Ex-Dividend date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "Amount in local currency.",
"format": "float"
},
"adjustedAmount": {
"type": "number",
"description": "Adjusted dividend.",
"format": "float"
},
"payDate": {
"type": "string",
"description": "Pay date.",
"format": "date"
},
"recordDate": {
"type": "string",
"description": "Record date.",
"format": "date"
},
"declarationDate": {
"type": "string",
"description": "Declaration date.",
"format": "date"
},
"currency": {
"type": "string",
"description": "Currency."
},
"freq": {
"type": "string",
"description": "<p>Dividend frequency. Can be 1 of the following values:</p><ul>\n<li><code>0: Annually</code></li>\n<li><code>1: Monthly</code></li>\n<li><code>2: Quarterly</code></li>\n<li><code>3: Semi-annually</code></li>\n<li><code>4: Other/Unknown</code></li>\n<li><code>5: Bimonthly</code></li>\n<li><code>6: Trimesterly</code></li>\n<li><code>7: Weekly</code></li>\n</ul>"
}
}
},
"Dividends2Info": {
"type": "object",
"properties": {
"exDate": {
"type": "string",
"description": "Ex-Dividend date.",
"format": "date"
},
"amount": {
"type": "number",
"description": "Amount in local currency.",
"format": "float"
}
}
},
"RecommendationTrend": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"buy": {
"type": "integer",
"description": "Number of recommendations that fall into the Buy category",
"format": "int64"
},
"hold": {
"type": "integer",
"description": "Number of recommendations that fall into the Hold category",
"format": "int64"
},
"period": {
"type": "string",
"description": "Updated period"
},
"sell": {
"type": "integer",
"description": "Number of recommendations that fall into the Sell category",
"format": "int64"
},
"strongBuy": {
"type": "integer",
"description": "Number of recommendations that fall into the Strong Buy category",
"format": "int64"
},
"strongSell": {
"type": "integer",
"description": "Number of recommendations that fall into the Strong Sell category",
"format": "int64"
}
}
},
"PriceTarget": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"targetHigh": {
"type": "number",
"description": "Highes analysts' target.",
"format": "float"
},
"targetLow": {
"type": "number",
"description": "Lowest analysts' target.",
"format": "float"
},
"targetMean": {
"type": "number",
"description": "Mean of all analysts' targets.",
"format": "float"
},
"targetMedian": {
"type": "number",
"description": "Median of all analysts' targets.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"lastUpdated": {
"type": "string",
"description": "Updated time of the data"
}
}
},
"UpgradeDowngrade": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"gradeTime": {
"type": "integer",
"description": "Upgrade/downgrade time in UNIX timestamp.",
"format": "int64"
},
"fromGrade": {
"type": "string",
"description": "From grade."
},
"toGrade": {
"type": "string",
"description": "To grade."
},
"company": {
"type": "string",
"description": "Company/analyst who did the upgrade/downgrade."
},
"action": {
"type": "string",
"description": "Action can take any of the following values: <code>up(upgrade), down(downgrade), main(maintains), init(initiate), reit(reiterate)</code>."
}
}
},
"RevenueEstimatesInfo": {
"type": "object",
"properties": {
"revenueAvg": {
"type": "number",
"description": "Average revenue estimates including Finnhub's proprietary estimates.",
"format": "float"
},
"revenueHigh": {
"type": "number",
"description": "Highest estimate.",
"format": "float"
},
"revenueLow": {
"type": "number",
"description": "Lowest estimate.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period.",
"format": "date"
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"RevenueEstimates": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of estimates",
"items": {
"$ref": "#/components/schemas/RevenueEstimatesInfo"
}
},
"freq": {
"type": "string",
"description": "Frequency: annual or quarterly."
},
"symbol": {
"type": "string",
"description": "Company symbol."
}
}
},
"EbitdaEstimatesInfo": {
"type": "object",
"properties": {
"ebitdaAvg": {
"type": "number",
"description": "Average EBITDA estimates including Finnhub's proprietary estimates.",
"format": "float"
},
"ebitdaHigh": {
"type": "number",
"description": "Highest estimate.",
"format": "float"
},
"ebitdaLow": {
"type": "number",
"description": "Lowest estimate.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period.",
"format": "date"
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"EbitdaEstimates": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of estimates",
"items": {
"$ref": "#/components/schemas/EbitdaEstimatesInfo"
}
},
"freq": {
"type": "string",
"description": "Frequency: annual or quarterly."
},
"symbol": {
"type": "string",
"description": "Company symbol."
}
}
},
"EbitEstimatesInfo": {
"type": "object",
"properties": {
"ebitAvg": {
"type": "number",
"description": "Average EBIT estimates including Finnhub's proprietary estimates.",
"format": "float"
},
"ebitHigh": {
"type": "number",
"description": "Highest estimate.",
"format": "float"
},
"ebitLow": {
"type": "number",
"description": "Lowest estimate.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period.",
"format": "date"
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"EbitEstimates": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of estimates",
"items": {
"$ref": "#/components/schemas/EbitEstimatesInfo"
}
},
"freq": {
"type": "string",
"description": "Frequency: annual or quarterly."
},
"symbol": {
"type": "string",
"description": "Company symbol."
}
}
},
"EarningsEstimatesInfo": {
"type": "object",
"properties": {
"epsAvg": {
"type": "number",
"description": "Average EPS estimates including Finnhub's proprietary estimates.",
"format": "float"
},
"epsHigh": {
"type": "number",
"description": "Highest estimate.",
"format": "float"
},
"epsLow": {
"type": "number",
"description": "Lowest estimate.",
"format": "float"
},
"numberAnalysts": {
"type": "integer",
"description": "Number of Analysts.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period.",
"format": "date"
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"EarningsEstimates": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of estimates",
"items": {
"$ref": "#/components/schemas/EarningsEstimatesInfo"
}
},
"freq": {
"type": "string",
"description": "Frequency: annual or quarterly."
},
"symbol": {
"type": "string",
"description": "Company symbol."
}
}
},
"EarningResult": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"description": "Actual earning result.",
"format": "float"
},
"estimate": {
"type": "number",
"description": "Estimated earning.",
"format": "float"
},
"surprise": {
"type": "number",
"description": "Surprise - The difference between actual and estimate.",
"format": "float"
},
"surprisePercent": {
"type": "number",
"description": "Surprise percent.",
"format": "float"
},
"period": {
"type": "string",
"description": "Reported period.",
"format": "date"
},
"symbol": {
"type": "string",
"description": "Company symbol."
},
"year": {
"type": "integer",
"description": "Fiscal year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Fiscal quarter.",
"format": "int64"
}
}
},
"EarningRelease": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"date": {
"type": "string",
"description": "Date.",
"format": "date"
},
"hour": {
"type": "string",
"description": "Indicates whether the earnings is announced before market open(<code>bmo</code>), after market close(<code>amc</code>), or during market hour(<code>dmh</code>)."
},
"year": {
"type": "integer",
"description": "Earnings year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Earnings quarter.",
"format": "int64"
},
"epsEstimate": {
"type": "number",
"description": "EPS estimate.",
"format": "float"
},
"epsActual": {
"type": "number",
"description": "EPS actual.",
"format": "float"
},
"revenueEstimate": {
"type": "number",
"description": "Revenue estimate including Finnhub's proprietary estimates.",
"format": "float"
},
"revenueActual": {
"type": "number",
"description": "Revenue actual.",
"format": "float"
}
}
},
"EarningsCalendar": {
"type": "object",
"properties": {
"earningsCalendar": {
"type": "array",
"description": "Array of earnings release.",
"items": {
"$ref": "#/components/schemas/EarningRelease"
}
}
}
},
"Quote": {
"type": "object",
"properties": {
"o": {
"type": "number",
"description": "Open price of the day",
"format": "float"
},
"h": {
"type": "number",
"description": "High price of the day",
"format": "float"
},
"l": {
"type": "number",
"description": "Low price of the day",
"format": "float"
},
"c": {
"type": "number",
"description": "Current price",
"format": "float"
},
"pc": {
"type": "number",
"description": "Previous close price",
"format": "float"
},
"d": {
"type": "number",
"description": "Change",
"format": "float"
},
"dp": {
"type": "number",
"description": "Percent change",
"format": "float"
}
}
},
"StockCandles": {
"type": "object",
"properties": {
"o": {
"type": "array",
"description": "List of open prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"h": {
"type": "array",
"description": "List of high prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"l": {
"type": "array",
"description": "List of low prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"c": {
"type": "array",
"description": "List of close prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"v": {
"type": "array",
"description": "List of volume data for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp for returned candles.",
"items": {
"type": "integer",
"format": "int64"
}
},
"s": {
"type": "string",
"description": "Status of the response. This field can either be ok or no_data."
}
}
},
"TickData": {
"type": "object",
"properties": {
"s": {
"type": "string",
"description": "Symbol."
},
"skip": {
"type": "integer",
"description": "Number of ticks skipped.",
"format": "int64"
},
"count": {
"type": "integer",
"description": "Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned.",
"format": "int64"
},
"total": {
"type": "integer",
"description": "Total number of ticks for that date.",
"format": "int64"
},
"v": {
"type": "array",
"description": "List of volume data.",
"items": {
"type": "number",
"format": "float"
}
},
"p": {
"type": "array",
"description": "List of price data.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp in UNIX ms.",
"items": {
"type": "integer",
"format": "int64"
}
},
"x": {
"type": "array",
"description": "List of venues/exchanges. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"c": {
"type": "array",
"description": "List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1PUxiSWPHSODbaTaoL2Vef6DgU-yFtlRGZf19oBb9Hp0/edit?usp=sharing\">here</a>",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"BondTickData": {
"type": "object",
"properties": {
"skip": {
"type": "integer",
"description": "Number of ticks skipped.",
"format": "int64"
},
"count": {
"type": "integer",
"description": "Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned.",
"format": "int64"
},
"total": {
"type": "integer",
"description": "Total number of ticks for that date.",
"format": "int64"
},
"v": {
"type": "array",
"description": "List of volume data.",
"items": {
"type": "number",
"format": "float"
}
},
"p": {
"type": "array",
"description": "List of price data.",
"items": {
"type": "number",
"format": "float"
}
},
"y": {
"type": "array",
"description": "List of yield data.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp in UNIX ms.",
"items": {
"type": "integer",
"format": "int64"
}
},
"si": {
"type": "array",
"description": "List of values showing the side (Buy/sell) of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"cp": {
"type": "array",
"description": "List of values showing the counterparty of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"rp": {
"type": "array",
"description": "List of values showing the reporting party of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"ats": {
"type": "array",
"description": "ATS flag. Y or empty",
"items": {
"type": "string"
}
},
"c": {
"type": "array",
"description": "List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\">here</a>",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"HistoricalNBBO": {
"type": "object",
"properties": {
"s": {
"type": "string",
"description": "Symbol."
},
"skip": {
"type": "integer",
"description": "Number of ticks skipped.",
"format": "int64"
},
"count": {
"type": "integer",
"description": "Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned.",
"format": "int64"
},
"total": {
"type": "integer",
"description": "Total number of ticks for that date.",
"format": "int64"
},
"av": {
"type": "array",
"description": "List of Ask volume data.",
"items": {
"type": "number",
"format": "float"
}
},
"a": {
"type": "array",
"description": "List of Ask price data.",
"items": {
"type": "number",
"format": "float"
}
},
"ax": {
"type": "array",
"description": "List of venues/exchanges - Ask price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"bv": {
"type": "array",
"description": "List of Bid volume data.",
"items": {
"type": "number",
"format": "float"
}
},
"b": {
"type": "array",
"description": "List of Bid price data.",
"items": {
"type": "number",
"format": "float"
}
},
"bx": {
"type": "array",
"description": "List of venues/exchanges - Bid price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a>",
"items": {
"type": "string"
}
},
"t": {
"type": "array",
"description": "List of timestamp in UNIX ms.",
"items": {
"type": "integer",
"format": "int64"
}
},
"c": {
"type": "array",
"description": "List of quote conditions. A comprehensive list of quote conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1iiA6e7Osdtai0oPMOUzgAIKXCsay89dFDmsegz6OpEg/edit?usp=sharing\">here</a>",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"LastBid-Ask": {
"type": "object",
"properties": {
"b": {
"type": "number",
"description": "Bid price.",
"format": "float"
},
"a": {
"type": "number",
"description": "Ask price.",
"format": "float"
},
"bv": {
"type": "number",
"description": "Bid volume.",
"format": "float"
},
"av": {
"type": "number",
"description": "Ask volume.",
"format": "float"
},
"t": {
"type": "integer",
"description": "Reference UNIX timestamp in ms.",
"format": "int64"
}
}
},
"Split": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"date": {
"type": "string",
"description": "Split date.",
"format": "date"
},
"fromFactor": {
"type": "number",
"description": "From factor.",
"format": "float"
},
"toFactor": {
"type": "number",
"description": "To factor.",
"format": "float"
}
}
},
"Dividends2": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"data": {
"type": "array",
"description": "",
"items": {
"$ref": "#/components/schemas/Dividends2Info"
}
}
}
},
"IndicesConstituents": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Index's symbol."
},
"constituents": {
"type": "array",
"description": "Array of constituents.",
"items": {
"type": "string"
}
},
"constituentsBreakdown": {
"type": "array",
"description": "Array of constituents' details.",
"items": {
"$ref": "#/components/schemas/IndicesConstituentsBreakdown"
}
}
}
},
"IndicesConstituentsBreakdown": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"name": {
"type": "string",
"description": "Name."
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "Cusip."
},
"shareClassFIGI": {
"type": "string",
"description": "Global Share Class FIGI."
},
"weight": {
"type": "number",
"description": "Weight.",
"format": "float"
}
}
},
"IndexHistoricalConstituent": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"action": {
"type": "string",
"description": "<code>add</code> or <code>remove</code>."
},
"date": {
"type": "string",
"description": "Date of joining or leaving the index.",
"format": "date"
}
}
},
"IndicesHistoricalConstituents": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Index's symbol."
},
"historicalConstituents": {
"type": "array",
"description": "Array of historical constituents.",
"items": {
"$ref": "#/components/schemas/IndexHistoricalConstituent"
}
}
}
},
"ETFProfileData": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"assetClass": {
"type": "string",
"description": "Asset Class."
},
"investmentSegment": {
"type": "string",
"description": "Investment Segment."
},
"aum": {
"type": "number",
"description": "AUM.",
"format": "float"
},
"nav": {
"type": "number",
"description": "NAV.",
"format": "float"
},
"navCurrency": {
"type": "string",
"description": "NAV currency."
},
"expenseRatio": {
"type": "number",
"description": "Expense ratio. For non-US funds, this is the <a href=\"https://www.esma.europa.eu/sites/default/files/library/2015/11/09_1028_final_kid_ongoing_charges_methodology_for_publication_u_2_.pdf\" target=\"_blank\">KID ongoing charges<a/>.",
"format": "float"
},
"trackingIndex": {
"type": "string",
"description": "Tracking Index."
},
"etfCompany": {
"type": "string",
"description": "ETF issuer."
},
"domicile": {
"type": "string",
"description": "ETF domicile."
},
"inceptionDate": {
"type": "string",
"description": "Inception date.",
"format": "date"
},
"website": {
"type": "string",
"description": "ETF's website."
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"priceToEarnings": {
"type": "number",
"description": "P/E.",
"format": "float"
},
"priceToBook": {
"type": "number",
"description": "P/B.",
"format": "float"
},
"avgVolume": {
"type": "number",
"description": "30-day average volume.",
"format": "float"
},
"description": {
"type": "string",
"description": "ETF's description."
},
"isInverse": {
"type": "boolean",
"description": "Whether the ETF is inverse"
},
"isLeveraged": {
"type": "boolean",
"description": "Whether the ETF is leveraged"
},
"leverageFactor": {
"type": "number",
"description": "Leverage factor.",
"format": "float"
}
}
},
"ETFsProfile": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"profile": {
"$ref": "#/components/schemas/ETFProfileData"
}
}
},
"ETFHoldingsData": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol description"
},
"name": {
"type": "string",
"description": "Security name"
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"share": {
"type": "number",
"description": "Number of shares owned by the ETF.",
"format": "float"
},
"percent": {
"type": "number",
"description": "Portfolio's percent",
"format": "float"
},
"value": {
"type": "number",
"description": "Market value",
"format": "float"
},
"assetType": {
"type": "string",
"description": "Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty."
}
}
},
"ETFsHoldings": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "ETF symbol."
},
"atDate": {
"type": "string",
"description": "Holdings update date.",
"format": "date"
},
"numberOfHoldings": {
"type": "integer",
"description": "Number of holdings.",
"format": "int64"
},
"holdings": {
"type": "array",
"description": "Array of holdings.",
"items": {
"$ref": "#/components/schemas/ETFHoldingsData"
}
}
}
},
"ETFSectorExposureData": {
"type": "object",
"properties": {
"industry": {
"type": "string",
"description": "Industry"
},
"exposure": {
"type": "number",
"description": "Percent of exposure.",
"format": "float"
}
}
},
"ETFsSectorExposure": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "ETF symbol."
},
"sectorExposure": {
"type": "array",
"description": "Array of industries and exposure levels.",
"items": {
"$ref": "#/components/schemas/ETFSectorExposureData"
}
}
}
},
"ETFCountryExposureData": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country"
},
"exposure": {
"type": "number",
"description": "Percent of exposure.",
"format": "float"
}
}
},
"ETFsCountryExposure": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "ETF symbol."
},
"countryExposure": {
"type": "array",
"description": "Array of countries and and exposure levels.",
"items": {
"$ref": "#/components/schemas/ETFCountryExposureData"
}
}
}
},
"MutualFundProfileData": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name"
},
"category": {
"type": "string",
"description": "Fund's category."
},
"investmentSegment": {
"type": "string",
"description": "Investment Segment."
},
"totalNav": {
"type": "number",
"description": "NAV.",
"format": "float"
},
"expenseRatio": {
"type": "number",
"description": "Expense ratio.",
"format": "float"
},
"benchmark": {
"type": "string",
"description": "Index benchmark."
},
"inceptionDate": {
"type": "string",
"description": "Inception date.",
"format": "date"
},
"description": {
"type": "string",
"description": "Fund's description."
},
"fundFamily": {
"type": "string",
"description": "Fund Family."
},
"fundCompany": {
"type": "string",
"description": "Fund Company."
},
"manager": {
"type": "string",
"description": "Fund's managers."
},
"status": {
"type": "string",
"description": "Status."
},
"beta": {
"type": "number",
"description": "Beta.",
"format": "float"
},
"deferredLoad": {
"type": "number",
"description": "Deferred load.",
"format": "float"
},
"fee12b1": {
"type": "number",
"description": "12B-1 fee.",
"format": "float"
},
"frontLoad": {
"type": "number",
"description": "Front Load.",
"format": "float"
},
"iraMinInvestment": {
"type": "number",
"description": "IRA minimum investment.",
"format": "float"
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"maxRedemptionFee": {
"type": "number",
"description": "Max redemption fee.",
"format": "float"
},
"standardMinInvestment": {
"type": "number",
"description": "Minimum investment for standard accounts.",
"format": "float"
},
"turnover": {
"type": "number",
"description": "Turnover.",
"format": "float"
},
"seriesId": {
"type": "string",
"description": "Fund's series ID. This field can be used to group multiple share classes into 1 unique fund."
},
"seriesName": {
"type": "string",
"description": "Fund's series name."
},
"classId": {
"type": "string",
"description": "Class ID."
},
"className": {
"type": "string",
"description": "Class name."
},
"sfdrClassification": {
"type": "string",
"description": "SFDR classification for EU funds. Under the new classifications, a fund's strategy will labeled under either Article 6, 8 or 9. Article 6 covers funds which do not integrate any kind of sustainability into the investment process. Article 8, also known as ‘environmental and socially promoting’, applies “… where a financial product promotes, among other characteristics, environmental or social characteristics, or a combination of those characteristics, provided that the companies in which the investments are made follow good governance practices.”. Article 9, also known as ‘products targeting sustainable investments’, covers products targeting bespoke sustainable investments and applies “… where a financial product has sustainable investment as its objective and an index has been designated as a reference benchmark.”"
},
"currency": {
"type": "string",
"description": "Fund's currency"
}
}
},
"MutualFundProfile": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"profile": {
"$ref": "#/components/schemas/MutualFundProfileData"
}
}
},
"MutualFundHoldingsData": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol description"
},
"name": {
"type": "string",
"description": "Security name"
},
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "CUSIP."
},
"share": {
"type": "number",
"description": "Number of shares.",
"format": "float"
},
"percent": {
"type": "number",
"description": "Portfolio's percent",
"format": "float"
},
"value": {
"type": "number",
"description": "Market value",
"format": "float"
},
"assetType": {
"type": "string",
"description": "Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty."
}
}
},
"MutualFundHoldings": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"atDate": {
"type": "string",
"description": "Holdings update date.",
"format": "date"
},
"numberOfHoldings": {
"type": "integer",
"description": "Number of holdings.",
"format": "int64"
},
"holdings": {
"type": "array",
"description": "Array of holdings.",
"items": {
"$ref": "#/components/schemas/MutualFundHoldingsData"
}
}
}
},
"MutualFundSectorExposureData": {
"type": "object",
"properties": {
"sector": {
"type": "string",
"description": "Sector"
},
"exposure": {
"type": "number",
"description": "Percent of exposure.",
"format": "float"
}
}
},
"MutualFundSectorExposure": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Mutual symbol."
},
"sectorExposure": {
"type": "array",
"description": "Array of sector and exposure levels.",
"items": {
"$ref": "#/components/schemas/MutualFundSectorExposureData"
}
}
}
},
"MutualFundCountryExposureData": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country"
},
"exposure": {
"type": "number",
"description": "Percent of exposure.",
"format": "float"
}
}
},
"MutualFundCountryExposure": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"countryExposure": {
"type": "array",
"description": "Array of countries and and exposure levels.",
"items": {
"$ref": "#/components/schemas/MutualFundCountryExposureData"
}
}
}
},
"MutualFundEetData": {
"type": "object",
"properties": {}
},
"MutualFundEet": {
"type": "object",
"properties": {
"isin": {
"type": "string",
"description": "ISIN."
},
"data": {
"$ref": "#/components/schemas/MutualFundEetData"
}
}
},
"MutualFundEetPaiData": {
"type": "object",
"properties": {}
},
"MutualFundEetPai": {
"type": "object",
"properties": {
"isin": {
"type": "string",
"description": "ISIN."
},
"data": {
"$ref": "#/components/schemas/MutualFundEetPaiData"
}
}
},
"ForexSymbol": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Symbol description"
},
"displaySymbol": {
"type": "string",
"description": "Display symbol name."
},
"symbol": {
"type": "string",
"description": "Unique symbol used to identify this symbol used in <code>/forex/candle</code> endpoint."
}
}
},
"ForexCandles": {
"type": "object",
"properties": {
"o": {
"type": "array",
"description": "List of open prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"h": {
"type": "array",
"description": "List of high prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"l": {
"type": "array",
"description": "List of low prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"c": {
"type": "array",
"description": "List of close prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"v": {
"type": "array",
"description": "List of volume data for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"s": {
"type": "string",
"description": "Status of the response. This field can either be ok or no_data."
}
}
},
"ForexRate": {
"type": "object",
"properties": {}
},
"Forexrates": {
"type": "object",
"properties": {
"base": {
"type": "string",
"description": "Base currency."
},
"quote": {
"$ref": "#/components/schemas/ForexRate"
}
}
},
"CryptoSymbol": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Symbol description"
},
"displaySymbol": {
"type": "string",
"description": "Display symbol name."
},
"symbol": {
"type": "string",
"description": "Unique symbol used to identify this symbol used in <code>/crypto/candle</code> endpoint."
}
}
},
"CryptoProfile": {
"type": "object",
"properties": {
"longName": {
"type": "string",
"description": "Long name."
},
"name": {
"type": "string",
"description": "Name."
},
"description": {
"type": "string",
"description": "Description."
},
"website": {
"type": "string",
"description": "Project's website."
},
"marketCap": {
"type": "number",
"description": "Market capitalization.",
"format": "float"
},
"totalSupply": {
"type": "number",
"description": "Total supply.",
"format": "float"
},
"maxSupply": {
"type": "number",
"description": "Max supply.",
"format": "float"
},
"circulatingSupply": {
"type": "number",
"description": "Circulating supply.",
"format": "float"
},
"logo": {
"type": "string",
"description": "Logo image."
},
"launchDate": {
"type": "string",
"description": "Launch date."
},
"proofType": {
"type": "string",
"description": "Proof type."
}
}
},
"CryptoCandles": {
"type": "object",
"properties": {
"o": {
"type": "array",
"description": "List of open prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"h": {
"type": "array",
"description": "List of high prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"l": {
"type": "array",
"description": "List of low prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"c": {
"type": "array",
"description": "List of close prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"v": {
"type": "array",
"description": "List of volume data for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp for returned candles.",
"items": {
"type": "integer",
"format": "int64"
}
},
"s": {
"type": "string",
"description": "Status of the response. This field can either be ok or no_data."
}
}
},
"ScanPattern": {
"type": "object",
"properties": {}
},
"PatternRecognition": {
"type": "object",
"properties": {
"points": {
"type": "array",
"description": "Array of patterns.",
"items": {
"$ref": "#/components/schemas/ScanPattern"
}
}
}
},
"SupportResistance": {
"type": "object",
"properties": {
"levels": {
"type": "array",
"description": "Array of support and resistance levels.",
"items": {
"type": "number",
"format": "float"
}
}
}
},
"Indicator": {
"type": "object",
"properties": {
"buy": {
"type": "integer",
"description": "Number of buy signals",
"format": "int64"
},
"neutral": {
"type": "integer",
"description": "Number of neutral signals",
"format": "int64"
},
"sell": {
"type": "integer",
"description": "Number of sell signals",
"format": "int64"
}
}
},
"TechnicalAnalysis": {
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Indicator"
},
"signal": {
"type": "string",
"description": "Aggregate Signal"
}
}
},
"Trend": {
"type": "object",
"properties": {
"adx": {
"type": "number",
"description": "ADX reading",
"format": "float"
},
"trending": {
"type": "boolean",
"description": "Whether market is trending or going sideway"
}
}
},
"AggregateIndicators": {
"type": "object",
"properties": {
"technicalAnalysis": {
"$ref": "#/components/schemas/TechnicalAnalysis"
},
"trend": {
"$ref": "#/components/schemas/Trend"
}
}
},
"TechnicalIndicator": {
"type": "object",
"properties": {}
},
"IndicatorFields": {
"type": "object",
"properties": {}
},
"StockTranscripts": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Transcript's ID used to get the <a href=\"#transcripts\">full transcript</a>."
},
"title": {
"type": "string",
"description": "Title."
},
"time": {
"type": "string",
"description": "Time of the event."
},
"year": {
"type": "integer",
"description": "Year of earnings result in the case of earnings call transcript.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Quarter of earnings result in the case of earnings call transcript.",
"format": "int64"
}
}
},
"EarningsCallTranscriptsList": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"transcripts": {
"type": "array",
"description": "Array of transcripts' metadata",
"items": {
"$ref": "#/components/schemas/StockTranscripts"
}
}
}
},
"TranscriptContent": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Speaker's name"
},
"speech": {
"type": "array",
"description": "Speaker's speech",
"items": {
"type": "string"
}
},
"session": {
"type": "string",
"description": "Earnings calls section (management discussion or Q&A)"
}
}
},
"TranscriptParticipant": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Participant's name"
},
"description": {
"type": "string",
"description": "Participant's description"
},
"role": {
"type": "string",
"description": "Whether the speak is a company's executive or an analyst"
}
}
},
"EarningsCallTranscripts": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"transcript": {
"type": "array",
"description": "Transcript content.",
"items": {
"$ref": "#/components/schemas/TranscriptContent"
}
},
"participant": {
"type": "array",
"description": "Participant list",
"items": {
"$ref": "#/components/schemas/TranscriptParticipant"
}
},
"audio": {
"type": "string",
"description": "Audio link."
},
"id": {
"type": "string",
"description": "Transcript's ID."
},
"title": {
"type": "string",
"description": "Title."
},
"time": {
"type": "string",
"description": "Time of the event."
},
"year": {
"type": "integer",
"description": "Year of earnings result in the case of earnings call transcript.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Quarter of earnings result in the case of earnings call transcript.",
"format": "int64"
}
}
},
"SentimentContent": {
"type": "object",
"properties": {
"mention": {
"type": "integer",
"description": "Number of mentions",
"format": "int64"
},
"positiveMention": {
"type": "integer",
"description": "Number of positive mentions",
"format": "int64"
},
"negativeMention": {
"type": "integer",
"description": "Number of negative mentions",
"format": "int64"
},
"positiveScore": {
"type": "number",
"description": "Positive score. Range 0-1",
"format": "float"
},
"negativeScore": {
"type": "number",
"description": "Negative score. Range 0-1",
"format": "float"
},
"score": {
"type": "number",
"description": "Final score. Range: -1 to 1 with 1 is very positive and -1 is very negative",
"format": "float"
},
"atTime": {
"type": "string",
"description": "Period."
}
}
},
"SocialSentiment": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Company symbol."
},
"data": {
"type": "array",
"description": "Sentiment data.",
"items": {
"$ref": "#/components/schemas/SentimentContent"
}
}
}
},
"InvestmentThemePortfolio": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
}
}
},
"InvestmentThemes": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"description": "Investment theme"
},
"data": {
"type": "array",
"description": "Investment theme portfolio.",
"items": {
"$ref": "#/components/schemas/InvestmentThemePortfolio"
}
}
}
},
"SectorMetric": {
"type": "object",
"properties": {
"region": {
"type": "string",
"description": "Region."
},
"data": {
"type": "array",
"description": "Metrics for each sector.",
"items": {
"$ref": "#/components/schemas/SectorMetricData"
}
}
}
},
"SectorMetricData": {
"type": "object",
"properties": {
"sector": {
"type": "string",
"description": "Sector"
},
"metrics": {
"type": "object",
"properties": {},
"description": "Metrics data in key-value format. <code>a</code> and <code>m</code> fields are for average and median respectively."
}
}
},
"KeyCustomersSuppliers": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"name": {
"type": "string",
"description": "Name"
},
"country": {
"type": "string",
"description": "Country"
},
"industry": {
"type": "string",
"description": "Industry"
},
"customer": {
"type": "boolean",
"description": "Whether the company is a customer."
},
"supplier": {
"type": "boolean",
"description": "Whether the company is a supplier"
},
"oneMonthCorrelation": {
"type": "number",
"description": "1-month price correlation",
"format": "float"
},
"oneYearCorrelation": {
"type": "number",
"description": "1-year price correlation",
"format": "float"
},
"sixMonthCorrelation": {
"type": "number",
"description": "6-month price correlation",
"format": "float"
},
"threeMonthCorrelation": {
"type": "number",
"description": "3-month price correlation",
"format": "float"
},
"twoWeekCorrelation": {
"type": "number",
"description": "2-week price correlation",
"format": "float"
},
"twoYearCorrelation": {
"type": "number",
"description": "2-year price correlation",
"format": "float"
}
}
},
"SupplyChainRelationships": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "symbol"
},
"data": {
"type": "array",
"description": "Key customers and suppliers.",
"items": {
"$ref": "#/components/schemas/KeyCustomersSuppliers"
}
}
}
},
"CompanyESG": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "symbol"
},
"totalESGScore": {
"type": "number",
"description": "Total ESG Score",
"format": "float"
},
"environmentScore": {
"type": "number",
"description": "Environment Score",
"format": "float"
},
"governanceScore": {
"type": "number",
"description": "Governance Score",
"format": "float"
},
"socialScore": {
"type": "number",
"description": "Social Score",
"format": "float"
},
"data": {
"$ref": "#/components/schemas/CompanyESGMap"
}
}
},
"CompanyESGMap": {
"type": "object",
"properties": {}
},
"CompanyEarningsQualityScore": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol"
},
"freq": {
"type": "string",
"description": "Frequency"
},
"data": {
"type": "array",
"description": "Array of earnings quality score.",
"items": {
"$ref": "#/components/schemas/CompanyEarningsQualityScoreData"
}
}
}
},
"CompanyEarningsQualityScoreData": {
"type": "object",
"properties": {
"period": {
"type": "string",
"description": "Period"
},
"growth": {
"type": "number",
"description": "Growth Score",
"format": "float"
},
"profitability": {
"type": "number",
"description": "Profitability Score",
"format": "float"
},
"cashGenerationCapitalAllocation": {
"type": "number",
"description": "Cash Generation and Capital Allocation",
"format": "float"
},
"leverage": {
"type": "number",
"description": "Leverage Score",
"format": "float"
},
"score": {
"type": "number",
"description": "Total Score",
"format": "float"
},
"letterScore": {
"type": "string",
"description": "Letter Score"
}
}
},
"CovidInfo": {
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "State."
},
"case": {
"type": "number",
"description": "Number of confirmed cases.",
"format": "float"
},
"death": {
"type": "number",
"description": "Number of confirmed deaths.",
"format": "float"
},
"updated": {
"type": "string",
"description": "Updated time."
}
}
},
"FDAComitteeMeeting": {
"type": "object",
"properties": {
"fromDate": {
"type": "string",
"description": "Start time of the event in EST."
},
"toDate": {
"type": "string",
"description": "End time of the event in EST."
},
"eventDescription": {
"type": "string",
"description": "Event's description."
},
"url": {
"type": "string",
"description": "URL."
}
}
},
"CountryMetadata": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country name"
},
"code2": {
"type": "string",
"description": "Alpha 2 code"
},
"code3": {
"type": "string",
"description": "Alpha 3 code"
},
"codeNo": {
"type": "string",
"description": "UN code"
},
"currency": {
"type": "string",
"description": "Currency name"
},
"currencyCode": {
"type": "string",
"description": "Currency code"
},
"region": {
"type": "string",
"description": "Region"
},
"subRegion": {
"type": "string",
"description": "Sub-Region"
},
"rating": {
"type": "string",
"description": "Moody's credit risk rating."
},
"defaultSpread": {
"type": "number",
"description": "Default spread",
"format": "float"
},
"countryRiskPremium": {
"type": "number",
"description": "Country risk premium",
"format": "float"
},
"equityRiskPremium": {
"type": "number",
"description": "Equity risk premium",
"format": "float"
}
}
},
"Economic event": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"description": "Actual release",
"format": "float"
},
"prev": {
"type": "number",
"description": "Previous release",
"format": "float"
},
"country": {
"type": "string",
"description": "Country"
},
"unit": {
"type": "string",
"description": "Unit"
},
"estimate": {
"type": "number",
"description": "Estimate",
"format": "float"
},
"event": {
"type": "string",
"description": "Event"
},
"impact": {
"type": "string",
"description": "Impact level"
},
"time": {
"type": "string",
"description": "Release time"
}
}
},
"EconomicCalendar": {
"type": "object",
"properties": {
"economicCalendar": {
"type": "array",
"description": "Array of economic events.",
"items": {
"$ref": "#/components/schemas/Economic event"
}
}
}
},
"EconomicCode": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Finnhub economic code used to get historical data"
},
"country": {
"type": "string",
"description": "Country"
},
"name": {
"type": "string",
"description": "Indicator name"
},
"unit": {
"type": "string",
"description": "Unit"
}
}
},
"EconomicDataInfo": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Date of the reading"
},
"value": {
"type": "number",
"description": "Value",
"format": "float"
}
}
},
"EconomicData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Array of economic data for requested code.",
"items": {
"$ref": "#/components/schemas/EconomicDataInfo"
}
},
"code": {
"type": "string",
"description": "Finnhub economic code"
}
}
},
"BondYieldCurveInfo": {
"type": "object",
"properties": {
"d": {
"type": "string",
"description": "Date of the reading"
},
"v": {
"type": "number",
"description": "Value",
"format": "float"
}
}
},
"BondYieldCurve": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Array of data.",
"items": {
"$ref": "#/components/schemas/BondYieldCurveInfo"
}
},
"code": {
"type": "string",
"description": "Bond's code"
}
}
},
"UsptoPatentResult": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"data": {
"type": "array",
"description": "Array of patents.",
"items": {
"$ref": "#/components/schemas/UsptoPatent"
}
}
}
},
"UsptoPatent": {
"type": "object",
"properties": {
"applicationNumber": {
"type": "string",
"description": "Application Number."
},
"companyFilingName": {
"type": "array",
"description": "Array of companies' name on the patent.",
"items": {
"type": "string"
}
},
"filingDate": {
"type": "string",
"description": "Filing date."
},
"description": {
"type": "string",
"description": "Description."
},
"filingStatus": {
"type": "string",
"description": "Filing status."
},
"patentNumber": {
"type": "string",
"description": "Patent number."
},
"publicationDate": {
"type": "string",
"description": "Publication date."
},
"patentType": {
"type": "string",
"description": "Patent's type."
},
"url": {
"type": "string",
"description": "URL of the original article."
}
}
},
"VisaApplicationResult": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"data": {
"type": "array",
"description": "Array of H1b and Permanent visa applications.",
"items": {
"$ref": "#/components/schemas/VisaApplication"
}
}
}
},
"LobbyingResult": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"data": {
"type": "array",
"description": "Array of lobbying activities.",
"items": {
"$ref": "#/components/schemas/LobbyingData"
}
}
}
},
"UsaSpendingResult": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"data": {
"type": "array",
"description": "Array of government's spending data points.",
"items": {
"$ref": "#/components/schemas/UsaSpending"
}
}
}
},
"UsaSpending": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"recipientName": {
"type": "string",
"description": "Company's name."
},
"recipientParentName": {
"type": "string",
"description": "Company's name."
},
"awardDescription": {
"type": "string",
"description": "Description."
},
"country": {
"type": "string",
"description": "Recipient's country."
},
"actionDate": {
"type": "string",
"description": "Period."
},
"totalValue": {
"type": "number",
"description": "Income reported by lobbying firms.",
"format": "float"
},
"performanceStartDate": {
"type": "string",
"description": "Performance start date."
},
"performanceEndDate": {
"type": "string",
"description": "Performance end date."
},
"awardingAgencyName": {
"type": "string",
"description": "Award agency."
},
"awardingSubAgencyName": {
"type": "string",
"description": "Award sub-agency."
},
"awardingOfficeName": {
"type": "string",
"description": "Award office name."
},
"performanceCountry": {
"type": "string",
"description": "Performance country."
},
"performanceCity": {
"type": "string",
"description": "Performance city."
},
"performanceCounty": {
"type": "string",
"description": "Performance county."
},
"performanceState": {
"type": "string",
"description": "Performance state."
},
"performanceZipCode": {
"type": "string",
"description": "Performance zip code."
},
"performanceCongressionalDistrict": {
"type": "string",
"description": "Performance congressional district."
},
"naicsCode": {
"type": "string",
"description": "NAICS code."
},
"permalink": {
"type": "string",
"description": "Permalink."
}
}
},
"LobbyingData": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Symbol."
},
"name": {
"type": "string",
"description": "Company's name."
},
"description": {
"type": "string",
"description": "Description."
},
"country": {
"type": "string",
"description": "Country."
},
"year": {
"type": "integer",
"description": "Year.",
"format": "int64"
},
"period": {
"type": "string",
"description": "Period."
},
"income": {
"type": "number",
"description": "Income reported by lobbying firms.",
"format": "float"
},
"expenses": {
"type": "number",
"description": "Expenses reported by the company.",
"format": "float"
},
"documentUrl": {
"type": "string",
"description": "Document's URL."
},
"postedName": {
"type": "string",
"description": "Posted name."
},
"date": {
"type": "string",
"description": "Date."
},
"clientId": {
"type": "string",
"description": "Client ID."
},
"registrantId": {
"type": "string",
"description": "Registrant ID."
},
"senateId": {
"type": "string",
"description": "Senate ID."
},
"houseregistrantId": {
"type": "string",
"description": "House registrant ID."
}
}
},
"BondProfile": {
"type": "object",
"properties": {
"isin": {
"type": "string",
"description": "ISIN."
},
"cusip": {
"type": "string",
"description": "Cusip."
},
"figi": {
"type": "string",
"description": "FIGI."
},
"coupon": {
"type": "number",
"description": "Coupon.",
"format": "float"
},
"maturityDate": {
"type": "string",
"description": "Period."
},
"offeringPrice": {
"type": "number",
"description": "Offering price.",
"format": "float"
},
"issueDate": {
"type": "string",
"description": "Issue date."
},
"bondType": {
"type": "string",
"description": "Bond type."
},
"debtType": {
"type": "string",
"description": "Bond type."
},
"industryGroup": {
"type": "string",
"description": "Industry."
},
"industrySubGroup": {
"type": "string",
"description": "Sub-Industry."
},
"asset": {
"type": "string",
"description": "Asset."
},
"assetType": {
"type": "string",
"description": "Asset."
},
"datedDate": {
"type": "string",
"description": "Dated date."
},
"firstCouponDate": {
"type": "string",
"description": "First coupon date."
},
"originalOffering": {
"type": "number",
"description": "Offering amount.",
"format": "float"
},
"amountOutstanding": {
"type": "number",
"description": "Outstanding amount.",
"format": "float"
},
"paymentFrequency": {
"type": "string",
"description": "Payment frequency."
},
"securityLevel": {
"type": "string",
"description": "Security level."
},
"callable": {
"type": "boolean",
"description": "Callable."
},
"couponType": {
"type": "string",
"description": "Coupon type."
}
}
},
"BondCandles": {
"type": "object",
"properties": {
"c": {
"type": "array",
"description": "List of close prices for returned candles.",
"items": {
"type": "number",
"format": "float"
}
},
"t": {
"type": "array",
"description": "List of timestamp for returned candles.",
"items": {
"type": "integer",
"format": "int64"
}
},
"s": {
"type": "string",
"description": "Status of the response. This field can either be ok or no_data."
}
}
},
"VisaApplication": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"description": "Year.",
"format": "int64"
},
"quarter": {
"type": "integer",
"description": "Quarter.",
"format": "int64"
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"caseNumber": {
"type": "string",
"description": "Case number."
},
"caseStatus": {
"type": "string",
"description": "Case status."
},
"receivedDate": {
"type": "string",
"description": "Received date."
},
"visaClass": {
"type": "string",
"description": "Visa class."
},
"jobTitle": {
"type": "string",
"description": "Job Title."
},
"socCode": {
"type": "string",
"description": "SOC Code. A list of SOC code can be found <a href=\"https://www.bls.gov/oes/current/oes_stru.htm\" target=\"_blank\">here</a>."
},
"fullTimePosition": {
"type": "string",
"description": "Full-time position flag."
},
"beginDate": {
"type": "string",
"description": "Job's start date."
},
"endDate": {
"type": "string",
"description": "Job's end date."
},
"employerName": {
"type": "string",
"description": "Company's name."
},
"worksiteAddress": {
"type": "string",
"description": "Worksite address."
},
"worksiteCity": {
"type": "string",
"description": "Worksite city."
},
"worksiteCounty": {
"type": "string",
"description": "Worksite county."
},
"worksiteState": {
"type": "string",
"description": "Worksite state."
},
"worksitePostalCode": {
"type": "string",
"description": "Worksite postal code."
},
"wageRangeFrom": {
"type": "number",
"description": "Wage range from.",
"format": "float"
},
"wageRangeTo": {
"type": "number",
"description": "Wage range to.",
"format": "float"
},
"wageUnitOfPay": {
"type": "string",
"description": "Wage unit of pay."
},
"wageLevel": {
"type": "string",
"description": "Wage level."
},
"h1bDependent": {
"type": "string",
"description": "H1B dependent flag."
}
}
}
},
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "token",
"in": "query"
}
}
},
"x-original-swagger-version": "2.0"
}TwelveData API
GET /time_seriesTime SeriesThis API call returns meta and time series for the requested instrument. Metaobject consists of general information about the requested symbol. Time series is the array of objects ordered by time descending with Open, High, Low, Close prices. Non-currency instruments also include volume information.
Ursprüngliches API-Schema
{
"openapi": "3.0.1",
"info": {
"title": "TwelveData API",
"license": {
"name": "MIT license",
"url": "https://www.mit.edu/~amini/LICENSE.md"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.twelvedata.com"
}
],
"paths": {
"/time_series": {
"get": {
"tags": [
"Free"
],
"summary": "Time Series",
"description": "This API call returns meta and time series for the requested instrument. Metaobject consists of general information about the requested symbol. Time series is the array of objects ordered by time descending with Open, High, Low, Close prices. Non-currency instruments also include volume information.",
"operationId": "time-series",
"parameters": [
{
"name": "symbol",
"in": "query",
"description": "Symbol ticker of the instrument e.g. AAPL, EUR/USD, ETH/BTC",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "interval",
"in": "query",
"description": "Interval between two consecutive points in time series. Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 1day, 1week, 1month",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "exchange",
"in": "query",
"description": "Exchange where instrument is traded",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "mic_code",
"in": "query",
"description": "Market Identifier Code (MIC) under ISO 10383 standard",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeSeries"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
}
},
"components": {
"schemas": {
"TimeSeries": {
"type": "object",
"properties": {
"datetime": {
"type": "string",
"description": "earliest datetime, the format depends on interval"
},
"unix_time": {
"type": "integer",
"description": "datetime converted to UNIX timestamp"
}
}
}
},
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "apikey",
"in": "query"
}
}
}
}