#Financial API Guide
#⚠️ Important! API endpoints will no longer be available starting January 15, 2025.
Our API provides access to financial data in JSON format, which can be utilized to analyze companies directly from our code editor or from outside the website (a python script for example).
#Table of Contents
- ⚠️ Important! API endpoints will no longer be available starting January 15, 2025.
- Table of Contents
- Getting an API Key
- Using your API key
- API Endpoints
- Finding Companies
- Income Statements
- Balance Sheet Statements
- Cash Flow Statements
- Financial Ratios
- Key Metrics
- Company Profile
- Market Quotes
- Share Price History
- Enterprise Value History
- Market Capitalization History
- Dividend History
- Revenue Breakdown
- Earnings Call Transcripts
- SEC Filings
- Stock Ownership
- Analyst Estimates
- Earnings Results and Estimations
- Stock News
- Top Gainers and Losers
- Equity Risk Premium
- U.S. Treasury Yields
- Macroeconomics
- Latest Forex Quotes
- Commodities
- ETF - Exchange Traded Funds
- Request Rate Limiting
- Accessing API Data Externally
- Premium Data
#Getting an API Key
An API key gives you access to the API endpoints whenever you are making requests from outside the website.
Get your key now by choosing one of our plans.
#Using your API key
To use your key, add "key=your_key" as a parameter in your request URL. Parameters always start with "?" and are separated by "&".
#Example of a request with "key" as a single parameter:
#Example of a request with "key" within multiple parameters:
/api/income-statement/?ticker=AAPL&key=your_key
#API Endpoints
#Finding Companies
#Searching by Keyword
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Keywords can be any string that is included in the name of the company or its symbol. For example, if you are looking for Apple Inc., you could search for "Apple" or "AAPL".
URL Example: /api/search/?keyword=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
keyword |
String keyword to search for | *Required |
length |
[1, 2, ... ] | Optional (Defaults to full length) |
Endpoint Sample:
[
{
"symbol":"AAPL",
"name":"Apple Inc.",
"currency":"USD",
"stockExchange":"NASDAQ Global Select",
"exchangeShortName":"NASDAQ"
},
{
"symbol":"AAPL.L",
"name":"LEVERAGE SHARES PUBLIC LIMITED ",
"currency":"GBp",
"stockExchange":"London Stock Exchange",
"exchangeShortName":"LSE"
}
]
#Stock Screener
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Filter stocks using various criteria such as market cap, price, volume, beta, sector, country, and more.
URL Example: /api/stock-screener/?key=your_key
Parameter | Value |
---|---|
marketCapMoreThan | 1000000000 |
marketCapLowerThan | 1000000000 |
priceMoreThan | 100 |
priceLowerThan | 100 |
betaMoreThan | 1 |
betaLowerThan | 1 |
volumeMoreThan | 10000 |
volumeLowerThan | 10000 |
dividendMoreThan | 1 |
dividendLowerThan | 1 |
isEtf | [true, false] |
isFund | [true, false] |
isActivelyTrading | [true, false] |
sector | [Consumer Cyclical, Energy, Technology, Industrials, Financial Services, Basic Materials, Communication Services, Consumer Defensive, Healthcare, Real Estate, Utilities, Industrial Goods, Financial, Services, Conglomerates] |
industry | [Autos, Banks, Banks Diversified, Software, Banks Regional, Beverages Alcoholic, Beverages Brewers, Beverages Non-Alcoholic] |
country | [US, UK, MX, BR, RU, HK, CA] |
exchange | [nyse, nasdaq, amex, euronext, tsx, etf, mutual_fund] |
length | [1, 2, ... ] |
Endpoint Sample:
[
{
"symbol":"AAPL",
"companyName":"Apple Inc.",
"marketCap":3335013409000,
"sector":"Technology",
"industry":"Consumer Electronics",
"beta":1.244,
"price":217.49,
"lastAnnualDividend":1,
"volume":51233438,
"exchange":"NASDAQ Global Select",
"exchangeShortName":"NASDAQ",
"country":"US",
"isEtf":false,
"isFund":false,
"isActivelyTrading":true
},
{
"symbol":"MSFT",
"companyName":"Microsoft Corporation",
"marketCap":3109678504000,
"sector":"Technology",
"industry":"Software - Infrastructure",
"beta":0.894,
"price":418.4,
"lastAnnualDividend":3,
"volume":29396859,
"exchange":"NASDAQ Global Select",
"exchangeShortName":"NASDAQ",
"country":"US",
"isEtf":false,
"isFund":false,
"isActivelyTrading":true
}
]
#List of All Available Symbols
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
This endpoint provides the complete list of available symbols. Note that the dataset is quite large (over 12MB of data).
URL Example: /api/symbol-list/?key=your_key
Endpoint Sample:
[
{
"symbol":"AAPL",
"name":"Apple Inc.",
"price":234.405,
"exchange":"NASDAQ Global Select",
"exchangeShortName":"NASDAQ",
"type":"stock"
},
{
"symbol":"GIS",
"name":"General Mills, Inc.",
"price":62.74,
"exchange":"New York Stock Exchange",
"exchangeShortName":"NYSE",
"type":"stock"
}
]
#Income Statements
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Learn more on our example income statements page.
URL Example: /api/income-statement/?ticker=AAPL&period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[annual, quarterly, ltm] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"date":"2023-09-30",
"symbol":"AAPL",
"cik":"0000320193",
"fillingDate":"2023-11-03",
"acceptedDate":"2023-11-02 18:08:27",
"calendarYear":"2023",
"period":"FY",
"revenue":383285000000,
"costOfRevenue":214137000000,
"grossProfit":169148000000,
"grossProfitRatio":0.4413112958,
"researchAndDevelopmentExpenses":29915000000,
"generalAndAdministrativeExpenses":0,
"sellingAndMarketingExpenses":0,
"sellingGeneralAndAdministrativeExpenses":24932000000,
"otherExpenses":382000000,
"operatingExpenses":55229000000,
"costAndExpenses":269366000000,
"interestIncome":3750000000,
"interestExpense":3933000000,
"depreciationAndAmortization":11519000000,
"ebitda":125820000000,
"ebitdaratio":0.3282674772,
"operatingIncome":114301000000,
"operatingIncomeRatio":0.2982141227,
"totalOtherIncomeExpensesNet":-565000000,
"incomeBeforeTax":113736000000,
"incomeBeforeTaxRatio":0.2967400237,
"incomeTaxExpense":16741000000,
"netIncome":96995000000,
"netIncomeRatio":0.2530623426,
"eps":6.16,
"epsdiluted":6.13,
"weightedAverageShsOut":15744231000,
"weightedAverageShsOutDil":15812547000,
"link":"https://www.sec.gov/Archives/edgar/data/320193/000032019323000106/0000320193-23-000106-index.htm",
"finalLink":"https://www.sec.gov/Archives/edgar/data/320193/000032019323000106/aapl-20230930.htm",
"calculatedOtherExpenses":0,
"calculatedOperatingExpenses":54847000000,
"calculatedNetInterest":-183000000,
"calculatedOtherIncome":-382000000,
"calculatedIncomeNonControlling":0,
"calculatedEbitda":125820000000,
"fxRate":1,
"fxDate":"2023-09-30"
}
]
}
Older, but still compatible patterns:
- Annual:
/api/income-statement/AAPL/
- Quarterly:
/api/income-statement/quarterly/AAPL/
- Last Twelve Months:
/api/income-statement/ltm/AAPL/
#Balance Sheet Statements
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Learn more on our example balance sheet statements page.
URL Example: /api/balance-sheet-statement/?ticker=AAPL&period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[annual, quarterly] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"date":"2023-09-30",
"symbol":"AAPL",
"cik":"0000320193",
"fillingDate":"2023-11-03",
"acceptedDate":"2023-11-02 18:08:27",
"calendarYear":"2023",
"period":"FY",
"cashAndCashEquivalents":29965000000,
"shortTermInvestments":31590000000,
"cashAndShortTermInvestments":61555000000,
"netReceivables":60985000000,
"inventory":6331000000,
"otherCurrentAssets":14695000000,
"totalCurrentAssets":143566000000,
"propertyPlantEquipmentNet":43715000000,
"goodwill":0,
"intangibleAssets":0,
"goodwillAndIntangibleAssets":0,
"longTermInvestments":100544000000,
"taxAssets":17852000000,
"otherNonCurrentAssets":46906000000,
"totalNonCurrentAssets":209017000000,
"otherAssets":0,
"totalAssets":352583000000,
"accountPayables":62611000000,
"shortTermDebt":15807000000,
"taxPayables":8819000000,
"deferredRevenue":8061000000,
"otherCurrentLiabilities":58829000000,
"totalCurrentLiabilities":145308000000,
"longTermDebt":95281000000,
"deferredRevenueNonCurrent":-19454000000,
"deferredTaxLiabilitiesNonCurrent":19454000000,
"otherNonCurrentLiabilities":49848000000,
"totalNonCurrentLiabilities":145129000000,
"otherLiabilities":0,
"capitalLeaseObligations":11267000000,
"totalLiabilities":290437000000,
"preferredStock":0,
"commonStock":73812000000,
"retainedEarnings":-214000000,
"accumulatedOtherComprehensiveIncomeLoss":-11452000000,
"othertotalStockholdersEquity":0,
"totalStockholdersEquity":62146000000,
"totalEquity":62146000000,
"totalLiabilitiesAndStockholdersEquity":352583000000,
"minorityInterest":0,
"totalLiabilitiesAndTotalEquity":352583000000,
"totalInvestments":132134000000,
"totalDebt":122355000000,
"netDebt":92390000000,
"link":"https://www.sec.gov/Archives/edgar/data/320193/000032019323000106/0000320193-23-000106-index.htm",
"finalLink":"https://www.sec.gov/Archives/edgar/data/320193/000032019323000106/aapl-20230930.htm",
"calculatedOtherCurrentAssets":14695000000,
"calculatedOtherNonCurrentAssets":64758000000,
"calculatedOtherCurrentLiabilities":50010000000,
"calculatedOtherNonCurrentLiabilities":30394000000,
"fxRate":1,
"fxDate":"2023-09-30"
}
]
}
Older, but still compatible patterns:
- Annual:
/api/balance-sheet-statement/AAPL/
- Quarterly:
/api/balance-sheet-statement/quarterly/AAPL/
#Cash Flow Statements
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Learn more on our example cash flow statements page.
URL Example: /api/cash-flow-statement/?ticker=AAPL&period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[annual, quarterly, ltm] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"date":"2023-09-30",
"symbol":"AAPL",
"cik":"0000320193",
"fillingDate":"2023-11-03",
"acceptedDate":"2023-11-02 18:08:27",
"calendarYear":"2023",
"period":"FY",
"netIncome":96995000000,
"depreciationAndAmortization":11519000000,
"deferredIncomeTax":5195000000,
"stockBasedCompensation":10833000000,
"changeInWorkingCapital":-6577000000,
"accountsReceivables":-1688000000,
"inventory":-1618000000,
"accountsPayables":-1889000000,
"otherWorkingCapital":5195000000,
"otherNonCashItems":-7422000000,
"netCashProvidedByOperatingActivities":110543000000,
"investmentsInPropertyPlantAndEquipment":-10959000000,
"acquisitionsNet":0,
"purchasesOfInvestments":-29513000000,
"salesMaturitiesOfInvestments":45514000000,
"otherInvestingActivites":-1337000000,
"netCashUsedForInvestingActivites":3705000000,
"debtRepayment":-5923000000,
"commonStockIssued":0,
"commonStockRepurchased":-82981000000,
"dividendsPaid":-15025000000,
"otherFinancingActivites":-4559000000,
"netCashUsedProvidedByFinancingActivities":-108488000000,
"effectOfForexChangesOnCash":0,
"netChangeInCash":5760000000,
"cashAtEndOfPeriod":30737000000,
"cashAtBeginningOfPeriod":24977000000,
"operatingCashFlow":110543000000,
"capitalExpenditure":-10959000000,
"freeCashFlow":99584000000,
"link":"https://www.sec.gov/Archives/edgar/data/320193/000032019323000106/0000320193-23-000106-index.htm",
"finalLink":"https://www.sec.gov/Archives/edgar/data/320193/000032019323000106/aapl-20230930.htm",
"calculatedOtherWorkingCapital":-6577000000,
"fxRate":1,
"fxDate":"2023-09-30"
}
]
}
Older, but still compatible patterns:
- Annual:
/api/cash-flow-statement/AAPL/
- Quarterly:
/api/cash-flow-statement/quarterly/AAPL/
- Last Twelve Months:
/api/cash-flow-statement/ltm/AAPL/
#Financial Ratios
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Learn more about each ratio on our example financial ratios page.
URL Example: /api/ratios/?ticker=AAPL&period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[annual, quarterly, ltm] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"symbol":"AAPL",
"date":"2023-09-30",
"calendarYear":"2023",
"period":"FY",
"currentRatio":0.9880116717592975,
"quickRatio":0.8433121369780053,
"cashRatio":0.20621713876730807,
"daysOfSalesOutstanding":58.07564866874519,
"daysOfInventoryOutstanding":10.791292490321615,
"operatingCycle":68.8669411590668,
"daysOfPayablesOutstanding":106.72146803214763,
"cashConversionCycle":-37.85452687308083,
"grossProfitMargin":0.4413112957720756,
"operatingProfitMargin":0.2982141226502472,
"pretaxProfitMargin":0.296740023742124,
"netProfitMargin":0.2530623426432028,
"effectiveTaxRate":0.14719174228036858,
"returnOnAssets":0.27509834563776475,
"returnOnEquity":1.5607601454639075,
"returnOnCapitalEmployed":0.551446146423833,
"netIncomePerEBT":0.8528082577196314,
"ebtPerEbit":0.9950569111381353,
"ebitPerRevenue":0.2982141226502472,
"debtRatio":0.3150690759338936,
"debtEquityRatio":1.7875325845589418,
"longTermDebtToCapitalization":0.6052392537493568,
"totalDebtToCapitalization":0.6412597988847455,
"interestCoverage":29.062039155860667,
"cashFlowToDebtRatio":0.9950939795477459,
"companyEquityMultiplier":5.673462491552152,
"receivablesTurnover":6.284906124456834,
"payablesTurnover":3.420117870661705,
"inventoryTurnover":33.82356657716001,
"fixedAssetTurnover":8.767814251401122,
"assetTurnover":1.087077369016657,
"operatingCashFlowPerShare":7.021174930677783,
"freeCashFlowPerShare":6.325110448392176,
"cashPerShare":3.9096860303942442,
"payoutRatio":0.1549048920047425,
"operatingCashFlowSalesRatio":0.28840940814276583,
"freeCashFlowOperatingCashFlowRatio":0.9008621079579892,
"cashFlowCoverageRatios":0.9950939795477459,
"shortTermCoverageRatios":6.9932941102043396,
"capitalExpenditureCoverageRatio":-10.08696048909572,
"dividendPaidAndCapexCoverageRatio":27.187161829808165,
"dividendPayoutRatio":0.1549048920047425,
"priceBookValueRatio":43.37479145093811,
"priceToBookRatio":43.37479145093811,
"priceToSalesRatio":7.032807935374461,
"priceEarningsRatio":27.790811789370586,
"priceToFreeCashFlowsRatio":27.06830203155125,
"priceToOperatingCashFlowsRatio":24.384807626986785,
"priceCashFlowRatio":24.384807626986785,
"priceEarningsToGrowthRatio":170.91349250462116,
"priceSalesRatio":7.032807935374461,
"dividendYield":0.005573960673721321,
"enterpriseValueMultiple":22.15831973859482,
"priceFairValue":43.37479145093811,
"freeCashFlowMargin":0.25981710737440805,
"returnOnInvestedCapital":0.549753745787669,
"cashConversionRatio":1.1396773029537606,
"freeCashFlowToEarnings":1.0266920975308005,
"pricePerShare":171.20999999999998,
"earningsPerShare":6.160669263554377,
"revenuePerShare":24.344472588086386,
"dividendPerShare":0.9543178069478273,
"ebitPerShare":7.259865534239175,
"evPerShare":174.35610475417946,
"fxRate":1,
"fxDate":"2023-09-30"
}
]
}
Older, but still compatible patterns:
- Annual:
/api/ratios/AAPL/
- Quarterly:
/api/ratios/quarterly/AAPL/
- Last Twelve Months:
/api/ratios/ltm/AAPL/
#Key Metrics
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Includes metrics such as market capitalization, enterprise value, per share items and various ratios.
URL Example: /api/key-metrics/?ticker=AAPL&period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[annual, quarterly, ltm] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"symbol":"AAPL",
"date":"2023-09-30",
"calendarYear":"2023",
"period":"FY",
"revenuePerShare":24.344472588086393,
"netIncomePerShare":6.160669263554378,
"operatingCashFlowPerShare":7.021174930677783,
"freeCashFlowPerShare":6.325110448392176,
"cashPerShare":3.9096860303942442,
"bookValuePerShare":3.947223589389663,
"tangibleBookValuePerShare":3.947223589389663,
"shareholdersEquityPerShare":3.947223589389663,
"interestDebtPerShare":7.305596570578772,
"marketCap":2695569789510,
"enterpriseValue":2787959789510,
"peRatio":27.790811789370586,
"priceToSalesRatio":7.032807935374461,
"pocfratio":24.384807626986785,
"pfcfRatio":27.06830203155125,
"pbRatio":43.37479145093811,
"evToSales":7.273855719660305,
"enterpriseValueOverEBITDA":22.15831973859482,
"evToOperatingCashFlow":25.220590987308107,
"evToFreeCashFlow":27.9960615109857,
"earningsYield":0.03598311584343425,
"freeCashFlowYield":0.03694358068098929,
"debtToEquity":1.7875325845589418,
"debtToAssets":0.3150690759338936,
"netDebtToEBITDA":0.7343029725003974,
"currentRatio":0.9880116717592975,
"interestCoverage":29.062039155860667,
"incomeQuality":1.1396773029537606,
"dividendYield":0.005573960673721321,
"payoutRatio":0.1549048920047425,
"salesGeneralAndAdministrativeToRevenue":0,
"researchAndDevelopmentToRevenue":0.07804897139204509,
"intangiblesToTotalAssets":0,
"capexToOperatingCashFlow":-0.0991378920420108,
"capexToRevenue":-0.02859230076835775,
"capexToDepreciation":-0.9513846688080563,
"stockBasedCompensationToRevenue":0.028263563666723196,
"grahamNumber":23.391122856319186,
"roic":0.5626888293615087,
"returnOnTangibleAssets":0.27509834563776475,
"workingCapital":-1742000000,
"tangibleAssetValue":62146000000,
"netCurrentAssetValue":-146871000000,
"investedCapital":1.7875325845589418,
"averageReceivables":60958500000,
"averagePayables":63363000000,
"averageInventory":5638500000,
"daysSalesOutstanding":58.07564866874519,
"daysPayablesOutstanding":106.72146803214763,
"daysOfInventoryOnHand":10.791292490321615,
"receivablesTurnover":6.284906124456834,
"payablesTurnover":3.420117870661705,
"inventoryTurnover":33.82356657716001,
"roe":1.5607601454639075,
"capexPerShare":-0.6960644822856067,
"fxRate":1,
"fxDate":"2023-09-30"
}
]
}
#Company Profile
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Learn more on our example profile page.
URL Example: /api/profile/?ticker=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"symbol":"AAPL",
"price":230.54,
"beta":1.244,
"volAvg":68445513,
"mktCap":3535123414000,
"lastDiv":1,
"range":"164.08-233.08",
"changes":2.97,
"companyName":"Apple Inc.",
"cik":"0000320193",
"isin":"US0378331005",
"cusip":"037833100",
"exchange":"NASDAQ Global Select",
"exchangeShortName":"NASDAQ",
"industry":"Consumer Electronics",
"website":"https://www.apple.com",
"description":"Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide...",
"ceo":"Mr. Timothy D. Cook",
"sector":"Technology",
"country":"US",
"fullTimeEmployees":"150000",
"phone":"408 996 1010",
"address":"One Apple Park Way",
"city":"Cupertino",
"state":"CA",
"zip":"95014",
"image":"https://financialmodelingprep.com/image-stock/AAPL.png",
"ipoDate":"1980-12-12",
"defaultImage":false,
"isEtf":false,
"isActivelyTrading":true,
"isAdr":false,
"isFund":false,
"rangeMin":164.08,
"rangeMax":233.08,
"fxRate":1,
"fxDate":"2024-07-15"
}
]
}
Older, but still compatible patterns:
/api/profile/AAPL/
#Market Quotes
#Trading Hours Quote
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/quotes/?tickers=AAPL,MSFT,KO&key=your_key
Parameter | Value | Details |
---|---|---|
tickers |
AAPL,MSFT,KO | *Required (Multiple symbols allowed separated by ',') |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
[
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":{
"symbol":"AAPL",
"name":"Apple Inc.",
"price":229.73,
"changesPercentage":1.7539,
"change":3.96,
"dayLow":224.83,
"dayHigh":229.75,
"yearHigh":237.23,
"yearLow":164.08,
"marketCap":3492837893000,
"priceAvg50":222.9,
"priceAvg200":198.2306,
"exchange":"NASDAQ",
"volume":25560523,
"avgVolume":53486071,
"open":225.23,
"previousClose":225.77,
"eps":6.57,
"pe":34.97,
"earningsAnnouncement":"2024-10-31T20:00:00.000+0000",
"sharesOutstanding":15204100000,
"timestamp":1728503946,
"fxRate":1,
"fxDate":"2024-10-09"
}
}
]
#After Hours Quote
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/pre-post-market/?ticker=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":{
"symbol":"AAPL",
"price":234.6005,
"size":300,
"timestamp":1721161091194,
"fxRate":1,
"fxDate":"2024-07-16"
}
}
#Is the U.S. Market Open
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/is-market-open/?key=your_key
Endpoint Sample:
{
"stockExchangeName":"New York Stock Exchange",
"stockMarketHours":{
"openingHour":"09:30 a.m. EDT",
"closingHour":"04:00 p.m. EDT"
},
"stockMarketHolidays":[
{
"year":2023,
"New Years Day":"2023-01-02",
"Martin Luther King, Jr. Day":"2023-01-16",
"Washington's Birthday":"2023-02-20",
"Good Friday":"2023-04-07",
"Memorial Day":"2023-05-29",
"Juneteenth National Independence Day":"2023-06-19",
"Independence Day":"2023-07-04",
"Labor Day":"2023-09-04",
"Thanksgiving Day":"2023-11-23",
"Christmas":"2023-12-25"
},
{
"year":2024,
"New Years Day":"2024-01-01",
"Martin Luther King, Jr. Day":"2024-01-15",
"Washington's Birthday":"2024-02-19",
"Good Friday":"2024-03-29",
"Memorial Day":"2024-05-27",
"Juneteenth National Independence Day":"2024-06-19",
"Independence Day":"2024-07-04",
"Labor Day":"2024-09-02",
"Thanksgiving Day":"2024-11-28",
"Christmas":"2024-12-25"
}
],
"isTheStockMarketOpen":false,
"isTheEuronextMarketOpen":false,
"isTheForexMarketOpen":true,
"isTheCryptoMarketOpen":true
}
#Share Price History
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/prices/?ticker=AAPL&period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[1min, 5min, 15min, 30min, 1hour, 4hour, daily, annual] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"date":"LTM",
"close":234.1,
"fxRate":1,
"fxDate":"2024-07-15"
},
{
"date":"2024-07-15",
"close":234.1,
"fxRate":1,
"fxDate":"2024-07-15"
},
{
"date":"2023-12-29",
"close":192.5,
"fxRate":1,
"fxDate":"2023-12-29"
}
]
}
Older, but still compatible patterns:
/api/prices/timestamp/1hour/AAPL/
(Timestamp - 1min, 5min, 15min, 30min, 1hour, 4hour)/api/prices/daily/AAPL/
/api/prices/annual/AAPL/
#Enterprise Value History
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Annual and quarterly enterprise value figures.
URL Example: /api/enterprise-value/?ticker=AAPL&period=quarterly&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[annual, quarterly] | Optional (Defaults to annual) |
length |
[1, 2, ... ] | Optional (Defaults to full length) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
[
{
"symbol": "AAPL",
"date": "2024-06-29",
"stockPrice": 210.62,
"numberOfShares": 15287521000,
"marketCapitalization": 3219857673020,
"minusCashAndCashEquivalents": 25565000000,
"addTotalDebt": 101304000000,
"enterpriseValue": 3295596673020,
"fxRate": 1,
"fxDate": "2024-06-29"
},
{
"symbol": "AAPL",
"date": "2024-03-30",
"stockPrice": 171.48,
"numberOfShares": 15405856000,
"marketCapitalization": 2641796186880,
"minusCashAndCashEquivalents": 32695000000,
"addTotalDebt": 104590000000,
"enterpriseValue": 2713691186880,
"fxRate": 1,
"fxDate": "2024-03-30"
}
]
#Market Capitalization History
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Shows daily market capitalization numbers in a maximum span of 5 years.
URL Example: /api/market-capitalization/?ticker=AAPL&from=2023-12-31&to=2024-01-03&key=your_key
Please Note: If you need to fetch older data, please specify both from and to dates.
URL Example: /api/market-capitalization/?ticker=AAPL&from=2015-01-01&to=2020-01-01&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
from |
YYYY-MM-DD | Optional (Defaults to 5 years ago) |
to |
YYYY-MM-DD | Optional (Defaults to today) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"symbol":"AAPL",
"date":"2024-01-03",
"marketCap":2838528968000,
"fxRate":1,
"fxDate":"2024-01-03"
},
{
"symbol":"AAPL",
"date":"2024-01-02",
"marketCap":2859943107840,
"fxRate":1,
"fxDate":"2024-01-02"
}
]
}
#Dividend History
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/dividends/?ticker=AAPL&period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[annual, quarterly, reported] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"date":"LTM",
"year":"2024",
"adjDividend":0.97,
"isLtmEqualToLastYear":false,
"fxRate":1,
"fxDate":"2024-07-15"
},
{
"date":"2023-11-10",
"year":"2023",
"adjDividend":0.95,
"fxRate":1,
"fxDate":"2023-11-10"
},
{
"date":"2022-11-04",
"year":"2022",
"adjDividend":0.91,
"fxRate":1,
"fxDate":"2022-11-04"
},
{
"date":"2021-11-05",
"year":"2021",
"adjDividend":0.865,
"fxRate":1,
"fxDate":"2021-11-05"
}
]
}
Older, but still compatible patterns:
/api/dividends/AAPL/
/api/dividends/quarterly/AAPL/
/api/dividends/reported/AAPL/
#Revenue Breakdown
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Data is premium only. Accessing it requires an active subscription.
URL Example: /api/revenue-analysis/?ticker=AAPL&period=annual&segment=geographic&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
segment |
[geographic, product] | Optional (Defaults to product) |
period |
[annual, quarterly] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"Americas Segment":162560000000,
"Europe Segment":94294000000,
"Greater China Segment":72559000000,
"Japan Segment":24257000000,
"Rest of Asia Pacific Segment":29615000000,
"date":"2023-09-30",
"fxRate":1,
"fxDate":"2023-09-30"
},
{
"Americas Segment":169658000000,
"Europe Segment":95118000000,
"Greater China Segment":74200000000,
"Japan Segment":25977000000,
"Rest of Asia Pacific Segment":29375000000,
"date":"2022-09-24",
"fxRate":1,
"fxDate":"2022-09-24"
},
{
"Americas Segment":153306000000,
"Europe Segment":89307000000,
"Greater China Segment":68366000000,
"Japan Segment":28482000000,
"Rest of Asia Pacific Segment":26356000000,
"date":"2021-09-25",
"fxRate":1,
"fxDate":"2021-09-25"
}
]
}
Older, but still compatible patterns:
-
Annual Geographic Breakdown: /api/revenue-analysis/AAPL/geographic/
-
Quarterly Geographic Breakdown: /api/revenue-analysis/AAPL/geographic/quarter/
-
Annual Product Breakdown: /api/revenue-analysis/AAPL/product/
-
Quarterly Product Breakdown: /api/revenue-analysis/AAPL/product/quarter/
#Earnings Call Transcripts
#List of Available Transcripts
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
This is a list of all available earnings call transcripts for the selected company.
URL Example: /api/transcript/list/?ticker=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
Endpoint Sample:
Each element consists of the quarter index, the year, and the time of the earnings call.
[
[
2,
2024,
"2024-05-02 20:30:10"
],
[
1,
2024,
"2024-02-01 20:17:02"
],
[
4,
2023,
"2023-11-02 21:32:21"
],
[
3,
2023,
"2023-08-03 21:47:09"
],
[
2,
2023,
"2023-05-04 21:35:32"
],
[
1,
2023,
"2023-02-02 21:33:03"
],
[
4,
2022,
"2022-10-27 19:46:03"
],
[
3,
2022,
"2022-07-28 21:11:05"
],
[
2,
2022,
"2022-04-28 19:21:03"
],
[
1,
2022,
"2022-01-27 20:19:05"
]
]
#Transcript Report
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/transcript/?ticker=AAPL&quarter=Q4&year=2023&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
quarter |
[Q1, Q2, Q3, Q4] | *Required |
year |
[2024, 2023, ... ] | *Required |
Endpoint Sample:
[
{
"symbol":"AAPL",
"quarter":4,
"year":2023,
"date":"2023-11-02 21:32:21",
"content":"Operator: Good day, and welcome to the Apple Q4 Fiscal Year 2023 Earnings Conference Call..."
}
]
Older, but still compatible patterns:
#SEC Filings
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/sec-filings/?ticker=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
Endpoint Sample:
[
{
"symbol":"AAPL",
"filingDate":"2024-06-03 00:00:00",
"acceptedDate":"2024-06-03 18:31:26",
"cik":"0000320193",
"type":"4",
"link":"https://www.sec.gov/Archives/edgar/data/320193/000032019324000075/0000320193-24-000075-index.htm",
"finalLink":"https://www.sec.gov/Archives/edgar/data/320193/000032019324000075/xslF345X05/wk-form4_1717453877.xml"
}
]
Older, but still compatible patterns:
#Stock Ownership
#Insider Trading
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/insider/?ticker=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
length |
[1, 2, ... , 100 ] | Optional (Defaults to 100, which is the maximum) |
Endpoint Sample:
[
{
"symbol":"AAPL",
"filingDate":"2024-06-03 18:31:26",
"transactionDate":"2024-05-30",
"reportingCik":"0001214128",
"transactionType":"S-Sale",
"securitiesOwned":4359576,
"companyCik":"0000320193",
"reportingName":"LEVINSON ARTHUR D",
"typeOfOwner":"director",
"acquistionOrDisposition":"D",
"formType":"4",
"securitiesTransacted":75000,
"price":191.58,
"securityName":"Common Stock",
"link":"https://www.sec.gov/Archives/edgar/data/320193/000032019324000075/0000320193-24-000075-index.htm"
}
]
Older, but still compatible patterns:
#Institutional Holders
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/institutional-holders/?ticker=AAPL&date=2023-06-30&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
date |
YYYY-MM-DD | *Required (Report filing date) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"date":"2023-06-30",
"cik":"0000102909",
"filingDate":"2023-08-14",
"investorName":"VANGUARD GROUP INC",
"symbol":"AAPL",
"securityName":"APPLE INC",
"typeOfSecurity":"COM",
"securityCusip":"037833100",
"sharesType":"SH",
"putCallShare":"Share",
"investmentDiscretion":"SOLE",
"industryTitle":"ELECTRONIC COMPUTERS",
"weight":5.996,
"lastWeight":5.4489,
"changeInWeight":0.547,
"changeInWeightPercentage":10.0393,
"marketValue":252876459509,
"lastMarketValue":215999028631,
"changeInMarketValue":36877430878,
"changeInMarketValuePercentage":17.073,
"sharesNumber":1303688506,
"lastSharesNumber":1309878888,
"changeInSharesNumber":-6190382,
"changeInSharesNumberPercentage":-0.4726,
"quarterEndPrice":193.97,
"avgPricePaid":26.36,
"isNew":false,
"isSoldOut":false,
"ownership":8.2579,
"lastOwnership":8.2971,
"changeInOwnership":-0.0392,
"changeInOwnershipPercentage":-0.4726,
"holdingPeriod":41,
"firstAdded":"2013-06-30",
"performance":38078179274,
"performancePercentage":17.6289,
"lastPerformance":44700421313,
"changeInPerformance":-6622242038,
"isCountedForPerformance":true,
"fxRate":1,
"fxDate":"2023-06-30"
}
]
}
Older, but still compatible patterns:
/api/institutional-holders/AAPL/2023-06-30/
#Senate Trading
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/senate-trading/?ticker=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
Endpoint Sample:
[
{
"firstName":"Shelley",
"lastName":"Moore Capito",
"office":"Shelley Moore Capito",
"link":"https://efdsearch.senate.gov/search/view/ptr/d079ab57-5156-4bf5-93a8-bbb556cf3a69/",
"dateRecieved":"2024-05-12",
"transactionDate":"2024-04-09",
"owner":"Spouse",
"assetDescription":"Apple Inc",
"assetType":"Stock",
"type":"Sale (Partial)",
"amount":"$1,001 - $15,000",
"comment":"--",
"symbol":"AAPL"
}
]
#Executive Compensation
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/executive-compensation/?ticker=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
Endpoint Sample:
[
{
"cik":"0000320193",
"symbol":"AAPL",
"companyName":"Apple Inc.",
"industryTitle":"ELECTRONIC COMPUTERS",
"filingDate":"2024-01-11",
"acceptedDate":"2024-01-11 16:30:29",
"nameAndPosition":"Jeff Williams Chief Operating Officer",
"year":2022,
"salary":1000000,
"bonus":0,
"stock_award":22132015,
"incentive_plan_compensation":4000000,
"all_other_compensation":18337,
"total":27150352,
"url":"https://www.sec.gov/Archives/edgar/data/320193/000130817924000010/0001308179-24-000010-index.htm"
}
]
#Analyst Estimates
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/analyst-estimates/?ticker=AAPL&period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
period |
[annual, quarterly] | Optional (Defaults to annual) |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"symbol":"AAPL",
"date":"2028-09-30",
"estimatedRevenueLow":428454928941,
"estimatedRevenueHigh":456333926939,
"estimatedRevenueAvg":440858000000,
"estimatedEbitdaLow":133993059525,
"estimatedEbitdaHigh":142711811454,
"estimatedEbitdaAvg":137871939954,
"estimatedEbitLow":118777874164,
"estimatedEbitHigh":126506594018,
"estimatedEbitAvg":122216299804,
"estimatedNetIncomeLow":115018411254,
"estimatedNetIncomeHigh":124832942926,
"estimatedNetIncomeAvg":119384729857,
"estimatedSgaExpenseLow":28400310425,
"estimatedSgaExpenseHigh":30248281224,
"estimatedSgaExpenseAvg":29222453069,
"estimatedEpsAvg":7.55,
"estimatedEpsHigh":7.89455,
"estimatedEpsLow":7.27387,
"numberAnalystEstimatedRevenue":8,
"numberAnalystsEstimatedEps":14
}
]
}
#Earnings Results and Estimations
#Single Company Earnings Results and Estimations
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
This endpoint provides estimated and actual earnings results for past and future quarters of a given company (ticker).
URL Example: /api/earnings/?ticker=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | *Required |
currency |
[USD, EUR, ... ] | Optional (Defaults to original currency) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"date":"2025-04-30",
"symbol":"AAPL",
"eps":null,
"epsEstimated":null,
"time":"amc",
"revenue":null,
"revenueEstimated":null,
"updatedFromDate":"2024-07-22",
"fiscalDateEnding":"2025-03-30",
"fxRate":1,
"fxDate":"2024-07-22"
},
{
"date":"2025-01-30",
"symbol":"AAPL",
"eps":null,
"epsEstimated":null,
"time":"amc",
"revenue":null,
"revenueEstimated":null,
"updatedFromDate":"2024-07-22",
"fiscalDateEnding":"2024-12-30",
"fxRate":1,
"fxDate":"2024-07-22"
},
{
"date":"2024-10-31",
"symbol":"AAPL",
"eps":null,
"epsEstimated":null,
"time":"amc",
"revenue":null,
"revenueEstimated":null,
"updatedFromDate":"2024-07-22",
"fiscalDateEnding":"2024-09-30",
"fxRate":1,
"fxDate":"2024-07-22"
},
{
"date":"2024-08-01",
"symbol":"AAPL",
"eps":null,
"epsEstimated":1.33,
"time":"amc",
"revenue":null,
"revenueEstimated":84285200000,
"updatedFromDate":"2024-07-22",
"fiscalDateEnding":"2024-06-30",
"fxRate":1,
"fxDate":"2024-07-22"
},
{
"date":"2024-05-02",
"symbol":"AAPL",
"eps":1.53,
"epsEstimated":1.5,
"time":"amc",
"revenue":90753000000,
"revenueEstimated":90366105851,
"updatedFromDate":"2024-07-22",
"fiscalDateEnding":"2024-03-30",
"fxRate":1,
"fxDate":"2024-05-02"
}
]
}
#Earnings Calendar
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/earnings-calendar/?key=your_key
Endpoint Sample:
[
{
"date":"2024-07-15",
"symbol":"PREKF",
"eps":0.2523,
"epsEstimated":null,
"time":"bmo",
"revenue":135600000,
"revenueEstimated":null,
"fiscalDateEnding":"2024-06-30",
"updatedFromDate":"2024-07-21"
},
{
"date":"2024-07-15",
"symbol":"TMOAF",
"eps":null,
"epsEstimated":null,
"time":"bmo",
"revenue":null,
"revenueEstimated":null,
"fiscalDateEnding":"2024-06-30",
"updatedFromDate":"2024-06-17"
}
]
#Stock News
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/news/?tickers=AAPL,MSFT,KO&page=2&length=15&key=your_key
Parameter | Value | Details |
---|---|---|
tickers |
AAPL,MSFT,KO | *Required (Multiple symbols allowed separated by ',') |
page |
[0, 1, 2, ... ] | Optional (Defaults to 0 which is the first page ) |
length |
[1, 2, ... ] | Optional (Defaults to 10 news per page) |
Endpoint Sample:
[
{
"symbol":"AAPL",
"publishedDate":"2024-07-15 15:21:50",
"title":"Apple (AAPL) Could Be Consumer's Generative A.I. “Base Camp”",
"image":"https://cdn.snapi.dev/images/v1/7/p/apple-aapl-could-be-consumers-generative-ai-base-camp-2525404.jpg",
"site":"youtube.com",
"text":"Apple (AAPL) shares hit a new all-time high after Loop Capital upgraded the stock to buy and raised its price target. The analyst notes that Apple has the opportunity in the next few years to solidify itself consumer's generative A.I.",
"url":"https://www.youtube.com/watch?v=-seL2sihwQ8"
},
{
"symbol":"AAPL",
"publishedDate":"2024-07-15 14:11:37",
"title":"Apple Stock Hits Record High as Analysts Hike Price Targets on AI Optimism",
"image":"https://cdn.snapi.dev/images/v1/g/r/aapl21-2479281-2525203.jpg",
"site":"investopedia.com",
"text":"Apple (AAPL) stock touched a record high in intraday trading Monday as the tech giant received price-target increases from analysts who cited the company's strong position for the future of artificial intelligence (AI) use on smartphones.",
"url":"https://www.investopedia.com/apple-stock-price-record-high-analysts-targets-ai-8678016"
}
]
Older, but still compatible patterns:
#Top Gainers and Losers
#Top Gainers
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/gainers/?key=your_key
#Top Losers
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/losers/?key=your_key
Endpoint Sample:
[
{
"ticker":"RIOT",
"changes":1.08,
"price":"12.03",
"changesPercentage":"9.863",
"companyName":"Riot Blockchain, Inc."
},
{
"ticker":"SER",
"changes":0.87,
"price":"9.71",
"changesPercentage":"9.8416",
"companyName":"Serina Therapeutics Inc"
},
{
"ticker":"MIGI",
"changes":0.16,
"price":"1.79",
"changesPercentage":"9.8159",
"companyName":"Mawson Infrastructure Group, Inc."
}
]
#Equity Risk Premium
This endpoint covers equity risk for all countries.
URL Example for a Company: /api/risk-premium/?ticker=AAPL&key=your_key
URL Example for all Countries: /api/risk-premium/?key=your_key
Parameter | Value | Details |
---|---|---|
ticker |
[AAPL, MSFT, ... ] | Optional (Returns all countries if not specified) |
Endpoint Sample:
[
{
"country":"United Kingdom",
"defaultSpread":0.65,
"totalEquityRiskPremium":5.48,
"countryRiskPremium":0.88,
"corporateTaxRate":25,
"moodysRating":"Aa3",
"sovereignCDSSpread":0.51
},
{
"country":"United States",
"defaultSpread":0,
"totalEquityRiskPremium":4.6,
"countryRiskPremium":0,
"corporateTaxRate":25,
"moodysRating":"Aaa",
"sovereignCDSSpread":0.58
}
]
Older, but still compatible patterns:
/api/risk-premium/AAPL/
#U.S. Treasury Yields
URL Example: /api/treasury/?period=annual&key=your_key
Parameter | Value | Details |
---|---|---|
period |
[annual, monthly, daily] | Optional (Defaults to the latest curve available) |
length |
[1, 2, ... ] | Optional (Defaults to full length) |
Endpoint Sample:
[
{
"date":"LTM",
"month1":5.47,
"month2":5.52,
"month3":5.43,
"month6":5.23,
"year1":4.87,
"year2":4.45,
"year3":4.22,
"year5":4.1,
"year7":4.13,
"year10":4.18,
"year20":4.5,
"year30":4.39
},
{
"date":"2023-12-29",
"month1":5.6,
"month2":5.59,
"month3":5.4,
"month6":5.26,
"year1":4.79,
"year2":4.23,
"year3":4.01,
"year5":3.84,
"year7":3.88,
"year10":3.88,
"year20":4.2,
"year30":4.03
}
]
Older, but still compatible patterns:
/api/treasury/annual/5/
#Macroeconomics
#Economic Indicators
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/economic/?period=annual&indicator=CPI&key=your_key
Parameter | Value | Details |
---|---|---|
period |
[annual, original] | Optional (Defaults to annual) |
indicator |
[CPI] | Optional (Defaults to CPI) |
Endpoint Sample:
[
{
"date":"LTM",
"value":313.0
},
{
"date":"2024-06-01",
"value":313.0
},
{
"date":"2023-12-01",
"value":308.7
},
{
"date":"2022-12-01",
"value":298.8
}
]
Older, but still compatible patterns:
/api/economic/annual/CPI/
#Economic Calendar
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/economic-calendar/?key=your_key
Endpoint Sample:
[
{
"date":"2024-07-22 13:00:00",
"country":"FR",
"event":"12-Month BTF Auction",
"currency":"EUR",
"previous":3.355,
"estimate":null,
"actual":3.341,
"change":-0.014,
"impact":"Low",
"changePercentage":-0.417,
"unit":"%"
},
{
"date":"2024-07-22 13:00:00",
"country":"FR",
"event":"6-Month BTF Auction",
"currency":"EUR",
"previous":3.537,
"estimate":null,
"actual":3.54,
"change":0.003,
"impact":"Low",
"changePercentage":0.085,
"unit":"%"
}
]
#Latest Forex Quotes
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
This endpoint covers all currency pairs.
URL Example: /api/fx/?key=your_key
Endpoint Sample:
[
{
"symbol":"USDEUR",
"name":"USD/EUR",
"price":0.91716,
"changesPercentage":0.06109535,
"change":0.00056,
"dayLow":0.9153,
"dayHigh":0.9189,
"yearHigh":0.95695,
"yearLow":0.88686,
"marketCap":null,
"priceAvg50":0.92646,
"priceAvg200":0.92577,
"exchange":"FOREX",
"volume":46802,
"avgVolume":null,
"open":0.9162,
"previousClose":0.9166,
"eps":null,
"pe":null,
"earningsAnnouncement":null,
"sharesOutstanding":null,
"timestamp":1721060020
},
{
"symbol":"USDFJD",
"name":"USD/FJD",
"price":2.22425,
"changesPercentage":-0.13245,
"change":-0.00295001,
"dayLow":2.2095,
"dayHigh":2.2272,
"yearHigh":2.2962,
"yearLow":2.1673,
"marketCap":null,
"priceAvg50":2.23961,
"priceAvg200":2.23967,
"exchange":"FOREX",
"volume":23,
"avgVolume":null,
"open":2.2272,
"previousClose":2.2272,
"eps":null,
"pe":null,
"earningsAnnouncement":null,
"sharesOutstanding":null,
"timestamp":1721059636
}
]
#Commodities
#Full List of Available Commodities
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/commodities/list/?key=your_key
Endpoint Sample:
[
{
"symbol":"ZMUSD",
"name":"Soybean Meal Futures",
"stockExchange":"CME",
"exchangeShortName":"COMMODITY"
},
{
"symbol":"ZQUSD",
"name":"30 Day Fed Fund Futures",
"stockExchange":"CBOE",
"exchangeShortName":"COMMODITY"
},
{
"symbol":"ALIUSD",
"name":"Aluminum Futures",
"stockExchange":"COMEX",
"exchangeShortName":"COMMODITY"
}
]
#Commodities Quotes
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Data is split into free and premium data. Accessing premium data requires an active subscription.
Daily data is as follows:
- Free plan: Only the latest quote
- Any Subscription: 5 years of daily quotes
Intraday data (1min, 5min, 15min, 30min, 1hour, 4hour) is premium only.
URL Example: /api/commodities/?symbol=GCUSD&period=1hour&key=your_key
Parameter | Value | Details |
---|---|---|
symbol |
[GCUSD, SIUSD, ... ] | *Required |
period |
[1min, 5min, 15min, 30min, 1hour, 4hour, daily] | Optional (Defaults to daily) |
Endpoint Sample:
{
"originalCurrency":"USD",
"convertedCurrency":"USD",
"report":[
{
"date":"2024-07-15 16:00:00",
"open":2426.1,
"low":2425.5,
"high":2427.5,
"close":2427.4,
"volume":1578,
"fxRate":1,
"fxDate":"2024-07-15"
},
{
"date":"2024-07-15 15:00:00",
"open":2427,
"low":2424.8,
"high":2428,
"close":2426,
"volume":5241,
"fxRate":1,
"fxDate":"2024-07-15"
},
{
"date":"2024-07-15 14:00:00",
"open":2426.3,
"low":2424.5,
"high":2429.5,
"close":2427.1,
"volume":7001,
"fxRate":1,
"fxDate":"2024-07-15"
}
]
}
Older, but still compatible patterns:
/api/commodities/intraday/GCUSD/
#ETF - Exchange Traded Funds
A complete list (+2.1MB in size) of ETFs can be found by querying our stock screener with parameters: isEtf=true&length=10000
#ETF Holdings Update Dates
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
This endpoint provides a list of dates on which ETF holdings are updated.
URL Example: /api/etf/holdings/dates/?symbol=SPY&key=your_key
Parameter | Value | Details |
---|---|---|
symbol |
[SPY, DIA, ... ] | *Required |
Endpoint Sample:
[
{
"date":"2024-03-31"
},
{
"date":"2023-12-31"
},
{
"date":"2023-09-30"
},
{
"date":"2023-06-30"
},
{
"date":"2023-03-31"
}
]
#ETF List of Holdings
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Available to Essential and Ultimate users.
This endpoint provides a comprehensive list of the holdings within an ETF. For each asset, it includes detailed information such as the total number of shares, the weight percentage, and the market value.
URL Example: /api/etf/holdings/?symbol=SPY&date=latest&key=your_key
Parameter | Value | Details |
---|---|---|
symbol |
[SPY, DIA, ... ] | *Required |
date |
[latest, 2024-03-31, ... ] | Optional (Defaults to latest) |
Endpoint Sample:
[
{
"symbol":"MSFT",
"name":"MICROSOFT CORP",
"isin":"US5949181045",
"cusip":"594918104",
"sharesNumber":89777297,
"weightPercentage":6.973,
"marketValue":38659899634.14,
"updated":"2024-07-24"
},
{
"symbol":"AAPL",
"name":"APPLE INC",
"isin":"US0378331005",
"cusip":"037833100",
"sharesNumber":174108888,
"weightPercentage":6.854,
"marketValue":38001005894.88,
"updated":"2024-07-24"
}
]
#Stock Exposure by ETF
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
Available to Essential and Ultimate users.
URL Example: /api/etf/stock-exposure/?symbol=AAPL&key=your_key
Parameter | Value | Details |
---|---|---|
symbol |
[AAPL, MSFT, ... ] | *Required |
Endpoint Sample:
[
{
"etfSymbol":"ZECP",
"assetExposure":"AAPL",
"sharesNumber":5482,
"weightPercentage":5.86,
"marketValue":0
},
{
"etfSymbol":"XYLG",
"assetExposure":"AAPL",
"sharesNumber":19056,
"weightPercentage":7,
"marketValue":4287790.56
}
]
#ETF Details
⚠️ Important! This endpoint will no longer be available starting January 15, 2025.
URL Example: /api/etf/holdings/details/?symbol=SPY&key=your_key
Parameter | Value | Details |
---|---|---|
symbol |
[SPY, DIA, ... ] | *Required |
Endpoint Sample:
[
{
"symbol":"SPY",
"assetClass":"Equity",
"aum":568184825232,
"avgVolume":49474280,
"cusip":"78462F103",
"description":"The Trust seeks to achieve its investment objective by holding a portfolio of the common stocks that are included in the index (the \u201cPortfolio\u201d), with the weight of each stock in the Portfolio substantially corresponding to the weight of such stock in the index.",
"domicile":"US",
"etfCompany":"SPDR",
"expenseRatio":0.0945,
"inceptionDate":"1993-01-22",
"isin":"US78462F1030",
"name":"SPDR S&P 500 ETF Trust",
"nav":553.8,
"navCurrency":"USD",
"sectorsList":[
{
"industry":"Basic Materials",
"exposure":2.1145288166641434
},
{
"industry":"Communication Services",
"exposure":8.763415704736769
},
{
"industry":"Consumer Cyclical",
"exposure":10.536241591302112
},
{
"industry":"Consumer Defensive",
"exposure":5.948598640197488
},
{
"industry":"Energy",
"exposure":3.7346574357327778
},
{
"industry":"Financial Services",
"exposure":12.40747883467618
},
{
"industry":"Healthcare",
"exposure":12.538061325500951
},
{
"industry":"Industrials",
"exposure":8.288022082583502
},
{
"industry":"Other",
"exposure":0.16394585275212475
},
{
"industry":"Real Estate",
"exposure":2.3177881595591714
},
{
"industry":"Technology",
"exposure":31.037968935345518
},
{
"industry":"Utilities",
"exposure":2.1492926209490903
}
],
"website":"https://www.ssga.com/us/en/institutional/etfs/funds/spdr-sp-500-etf-trust-spy",
"holdingsCount":503
}
]
#Request Rate Limiting
A request limit is enforced for each individual API endpoint based on the following user types:
- Unauthenticated - No key: 250 requests per hour.
- Authenticated - Free: 500 requests per hour.
- Essential: 15,000 requests per hour.
- Ultimate: Unlimited requests.
If the API request limit is reached, any additional requests will result in an HTTP 403 Forbidden Response for the respective API endpoint.
#Accessing API Data Externally
API data can be accessed externally, such as in your Python projects, using a uniquely generated sharing key. Your account's request limit is also shared when using the sharing key. Keep your sharing key secure and only share it with trusted individuals, as misuse can temporarily block your account's API access.
Here are the steps to access data externally:
- Go to your User profile.
- Press "Generate a New Key".
- Each endpoint in this guide should now have your API key included.
#Premium Data
Premium data is only available to Essential and Ultimate plans and it refers to the following data:
- Income Statement Quarterly
- Balance Sheet Statement Quarterly
- Cash Flow Statement Quarterly
- Financial Ratios Quarterly
- Key Metrics Quarterly
- Analyst Estimates Quarterly
- Revenue Breakdown - All Data
- Commodities - Intraday Data
- ETF List of Holdings
- Stock Exposure by ETF
For Free or Unauthenticated users, only the most recent 6 quarters are accessible. All other quarters are categorized as premium data, and their values will be marked as null.