Sdílet prostřednictvím


Aletheia

Aletheia is an online web service providing financial data through an easily accessible HTTP REST API. Access stock data, SEC filings, Insider Trades, earnings calls, and more.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Aletheia Support
URL https://aletheiaapi.com
Email support@aletheiaapi.com
Connector Metadata
Publisher Aletheia
Website https://aletheiaapi.com
Privacy policy https://aletheiaapi.com/privacy
Categories Finance;Data

The Aletheia web service provides a wide variety of financial data including real time stock data, SEC filings, insider trading history and monitoring, analysis of financials, and more. With the addition of Aletheia in your apps and workflows, you can now do things like

  • Create a stock research app using live stock quotes and accompanying data (Market Cap, P/E, debt-to-equity, etc.)
  • Set up stock price alerts (for example, if a TSLA stock surpasses $825, send me a text reminder)
  • Research insider trading at a company and alert users of C-level executives purchasing stock in their own organization
  • Quickly evaluate fundamentals (i.e. revenue, income, net margin, cash flows, etc) and compare this to history or to another company
  • Determine the insiders for any particular company, the value of their ownership, and how this has changed with history

Prerequisites

  • A developer account with Aletheia. You can register for a free account at https://aletheiaapi.com/login/
  • After registering for the account, you will be given an API key. Use this API key to authenticate with the connector

How to get an Aletheia API Key

  1. Navigate to https://aletheiaapi.com/login/
  2. Click on "New User".
  3. Enter in the required information.
  4. Verify your email when prompted to do so.
  5. You will see your new API key under the "My API Keys" section. Press the "COPY" button next to your key to save it to your clipboard for later use.

Getting Started with the Aletheia Connector

We will briefly explore the steps to setting up a Power Automate flow that will send us the closing price of Microsoft (MSFT) stock at market close each day:

  1. Create a new scheduled workflow that will trigger once per day at 4:30 PM
  2. Click on "+ New step" beneath the flow trigger ("Recurrence")
  3. Select the Aletheia connector
  4. From the list of actions within the Aletheia connector, select "Get Stock Data"
  5. If this is your first time using the Aletheia connector, it will prompt you to enter in your connection information. Enter as such:
  6. Give this connection a name (i.e. "Tim's Aletheia Connection") and paste in the API key you received while making a new account earlier.
  7. Click on "Create" to save the connection details.
  8. Enter in "MSFT" in the symbol line and flip the "Include summary data" option to "Yes"
  9. Click again on "+ New step" and search for the "Variable" connector. Select "Initialize a variable"
  10. Name the variable "Price" and select "String" as the type
  11. Plug in the "Price" value from the dynamic content that was created under the "Get Stock Data" Aletheia action
  12. Click on "+ New step" and select the "Mail" connector. Choose the "Send an email notification" action.
  13. Enter in your email and a subject line of your choosing.
  14. For the body, enter in "Here is the closing price of Microsoft stock: ", and then plug in your variable using dynamic content.

Save your flow an ensure it is turned on. You are ready to go! Your workflow will now trigger each day at 4:30 PM, retrieve the closing price of Microsoft (MSFT) stock, and email it to you. You can replace Microsoft stock with any security of your choosing, including cryptocurrency, options, bonds, and more.

Known Issues and Limitations

When using the 'Get Filing' action, please note that this will not get any SEC filing, but rather will pull details of any insider trading related filing that has already been processed and save by our servers. As such, the focus of the returned data payload will include insider trading related data such as issuing company and trading owner. We are working on a separate action to access any SEC filing on-demand.

The same behavior above also applies to the 'Get Entity' endpoint. This is limited to the entities that the have been processed and saved by our servers. At the time of writing, there are over 40,000 entities we have stored, but this is not exhaustive in comparison to the broader market.

Common Errors and Remedies

Due to the compute and I/O intensive nature of the following actions, please anticipate a more substantial response time when using this action.

  • 'Latest Transactions' action - In testing, we have found the response times to be between 1 second and 4 seconds on average
  • 'Open Common Financials' action - In testing, we have found the response times to be between 2 seconds and 20 seconds. This is because of the massive amounts of data that have to be ingested and read at runtime.

FAQ

How can I easily find filing URL's to provide to the 'Open Form 4' and 'Open Common Financials' actions?

You can find change in ownership documents (form 3, 4, and 5) and financial result filings (form 10-K and 10-Q) by using the 'Entity Filings' action.
You can supply the 'Entity Filings' action with a organization of your choice and filter to specific forms like 3, 4, and 5 for insider trading and 10-K or 10-Q for annual or quarterly financial results respectively. This action returns a list of filings and each filing's associated documents URL. Use the supplied documents URL in the 'Open Form 4' and 'Open Common Financials' action.

How do I find the CIK value for a person or company?

You can use the 'Search Entities' action to search through our database of companies and people. This action will return a list of search results including each entities name and CIK value.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Crypto Quote

Get pricing and activity data for virtually any cryptocurrency

Earnings Call Highlights

Get the most important and notable remarks that were made on any publicly traded company's earnings call

Earnings Call Transcript Content

Get content from an earnings call transcript for any publicly traded company

Get Common Financials

Access a set of financial statements for any publicly traded company in simple form

Get Entity

Get information about an entity like CIK, name, and trading symbol

Get Filing

Get details of a particular SEC filing that has already been processed by Aletheia systems

Get Financial Fact Trend

Examine the trend in a fundamental financial data point. For example, get all annual revenue since 2013 for Apple

Get Stock Data (V2)

Access stock data for any US-based publicly traded equity security

Get Stock Data [DEPRECATED]

This action has been deprecated. Please use Get Stock Data (V2) instead.

Access stock data for any US-based publicly traded equity security (deprecated)

Latest Insider Transactions

Get the latest insider transactions for a person or company

List Affiliated Owners

List the owners who in the past have had transactions with a particular company's securities

List an entity's SEC filings

Request a list of latest SEC filings for an entity (company or person)

Open Common Financial Statements

Open financial statements from a 10-K or 10-Q filing

Open Form 4

Parse a Form 4 (changes in ownership) document

Search Earnings Call Transcripts

Search the database for available earnings call transcripts for any publicly traded company

Search Entities

Search the Aletheia database for an entity. An entity represents either a company (serving as an security issuer) or a person (serving as a security owner).

Crypto Quote

Get pricing and activity data for virtually any cryptocurrency

Parameters

Name Key Required Type Description
Cryptocurrency Symbol
symbol True string

Trading symbol of the cryptocurrency. For example, "BTC" for Bitcoin

Returns

Name Path Type Description
Symbol
Symbol string

Trading symbol of the queried cryptocurrency

Cryptocurrency Name
Name string

Name of the cryptocurrency. For example, "Bitcoin".

Price
Price float

Last traded price of the cryptocurrency.

Dollar Change
DollarChange float

The change in the price of the cryptocurrency during today.

Percent Change
PercentChange float

The percent change in the price of the cryptocurrency during today.

Day Low
DayLow float

The lowest price the cryptocurrency has reached during today's trading.

Day High
DayHigh float

The highest price the cryptocurrency has reached during today's trading.

Year Low
YearLow float

The lowest price the cryptocurrency has reached in the past year of trading.

Year High
YearHigh float

The highest price the cryptocurrency has reached in the past year of trading.

Market Cap
MarketCap double

The total value of all units of the cryptocurrency

Volume
Volume integer

Volume

Data Collected
DataCollected date-time

The date and time the data provided was collected

Earnings Call Highlights

Get the most important and notable remarks that were made on any publicly traded company's earnings call

Parameters

Name Key Required Type Description
Trading symbol
company True string

Trading symbol of the company you are reuqesting highlights for

Fiscal year
year True integer

Fiscal year of the earnings call you are requesting

Fiscal quarter
quarter True string

Fiscal quarter of the earnings call you are requesting

Highlight category
category integer

Category you are requesting highlights for. See https://aletheiaapi.com/docs/#earnings-call-highlights for the available category ID's

Max number of highlights
top integer

Maximum number of highlights to return

Returns

Name Path Type Description
array of object
Remark ID
Id string

Unique ID of the spoken remark

Remark
Remark string

The spoken remark (what was said)

Participant ID
SpokenBy.Id string

Unique ID of the participant who made the remark

Name
SpokenBy.Name string

Name of the participant who made this remark

Participant Title
SpokenBy.Title string

The title of the participant who spoke this remark

Is External
SpokenBy.IsExternal boolean

Indicates if the participant who spoke this remark is external to the company (not an employee. For example, an analyst from an investment bank)

Highlights
Highlights array of object

Highlights

BeginPosition
Highlights.BeginPosition integer

BeginPosition

EndPosition
Highlights.EndPosition integer

EndPosition

Category
Highlights.Category integer

Category

Rating
Highlights.Rating integer

Rating

Earnings Call Transcript Content

Get content from an earnings call transcript for any publicly traded company

Parameters

Name Key Required Type Description
Ticker Symbol
company True string

Ticker symbol of the company

Fiscal year
year integer

Fiscal year of the earnings call you are requesting

Fiscal quarter
quarter string

Q1, Q2, Q3, or Q4. Fiscal period of the earnings call you are requesting

Beginning at
begin integer

Beginning remark to retrieve

Ending at
end integer

Ending remark to retrieve

Returns

Name Path Type Description
Earnings call ID
Id string

Unique ID of this earnings call

Fiscal year
Year integer

The fiscal year of this earnings call

Quarter
Period integer

0 = Q1, 1 = Q2, 2 = Q3, 3 = Q4. The fiscal quarter this earnings call pertains to

Company ID
Company.Id string

Unique ID of the company this earnings call pertains to

Company name
Company.Name string

The name of the company this earnings call pertains to

Trading Symbol
Company.TradingSymbol string

Ticker symbol of the company this earnings call pertains to

Remarks
Remarks array of object

Remarks

Sequence Number
Remarks.SequenceNumber integer

The order in which this remark was spoken, relative to the other remarks

Remark
Remarks.Remark string

The spoken remark of the call participant (text)

Participant ID
Remarks.SpokenBy.Id string

Unique ID of the call participant who spoke this remark

Participant name
Remarks.SpokenBy.Name string

Name of the call participant who spoke this remark

Participant title
Remarks.SpokenBy.Title string

The title of the participant who spoke this remark

Is External?
Remarks.SpokenBy.IsExternal boolean

Indicates if the participant who spoke this remark is external to the company (not an employee. For example, an analyst from an investment bank)

Get Common Financials

Access a set of financial statements for any publicly traded company in simple form

Parameters

Name Key Required Type Description
Entity CIK or trading symbol
id True string

The CIK or trading symbol of the entity you are requesting filings for

Period type
period integer

0 = Annual results, 1 = Quarterly results

Get the most recent financial statements before this date YYYYMMDD format.
before string

Before date

Returns

Name Path Type Description
Period Start
PeriodStart date

Period start date

Period End
PeriodEnd date

Period end date

Retained Earnings
Facts.RetainedEarnings float

The historically (since inception) cumulative amount of net income left over for the business after it has paid out dividends to its shareholders

Operating Income
Facts.OperatingIncome float

Profit or loss from the company's operations directly related to their core business

Revenue
Facts.Revenue float

Income generated from normal business operations minus discounts and deductions for returned merchandise

Selling, General, and Administrative Expenses
Facts.SellingGeneralAndAdministrativeExpense float

Sum of all direct and indirect selling expenses and all general and administrative expenses (G&A) of the company

Research and Development Expense
Facts.ResearchAndDevelopmentExpense float

Sum of money spent on activities that the company undertook to innovate and introduce new products and services

Assets
Facts.Assets float

The sum of total Assets on the company's balance sheet

Net Income
Facts.NetIncome float

The company's bottom line profit or loss. Defined as sales minus cost of goods sold, selling, general and administrative expenses, operating expenses, depreciation, interest, taxes, and other expenses

Proceeds from Debt Issuance
Facts.ProceedsFromIssuanceOfDebt float

The amount of cash the company received from issuing debt in the fiscal period

Operating Cash Flows
Facts.OperatingCashFlows float

Net flow of cash from the past fiscal period involving transactions related to operations

Current Liabilities
Facts.CurrentLiabilities float

The liabilities that are intended to be settled within 12 months

Equity
Facts.Equity float

The equity (assets minus liabilities) on the company's balance sheet

Dividends Paid
Facts.DividendsPaid float

The payments of common stock dividends in the past fiscal period

Liabilities
Facts.Liabilities float

The sum of total Liabilities on the company's balance sheet

Common Stock Shares Outstanding
Facts.CommonStockSharesOutstanding float

The number of common stock shares outstanding

Current Assets
Facts.CurrentAssets float

The assets that are intended to be disposed of within 12 months

Investing Cash Flows
Facts.InvestingCashFlows float

Net flow of cash from the past fiscal period involving cash generated from or spent related to investing activities

Financing Cash Flows
Facts.FinancingCashFlows float

Net flow of cash from the past fiscal period involving transactions related to debt, equity, or dividends

Cash
Facts.Cash float

Balance of cash on the company's balance sheet

Get Entity

Get information about an entity like CIK, name, and trading symbol

Parameters

Name Key Required Type Description
Company ID
id True string

Either the CIK or trading symbol of the entity

Returns

Name Path Type Description
CIK
Cik integer

The unique identifier of the entity assigned by the SEC

Name
Name string

The name of the entity (company name or person's full name)

Trading Symbol
TradingSymbol string

If the entity is a company, the trading symbol of the company's equity securities on a stock exchange

Get Filing

Get details of a particular SEC filing that has already been processed by Aletheia systems

Parameters

Name Key Required Type Description
Filing ID
id string

The Aletheia-assigned unique ID of the filing

Filing URL
url string

The URL of the filing with the SEC

Returns

Name Path Type Description
ID
Id string

The Aletheia-assigned unique ID for this filing in our database

Filing URL
FilingUrl string

The URL to the filing with the SEC

Accession Number Part 1
AccessionP1 integer

The first portion of the SEC-assigned unique ID for this filing

Accession Number Part 2
AccessionP2 integer

The second portion of the SEC-assigned unique ID for this filing

Accession Number Part 3
AccessionP3 integer

The third portion of the SEC-assigned unique ID for this filing

Filing Type
FilingType integer

The Filing Type ID for this filing

Reported On
ReportedOn date

The date this filing was filed with the SEC

Issuer CIK
Issuer integer

The CIK of the issuing company

_Issuer
_Issuer string

_Issuer

Owner CIK
Owner integer

The CIK of the owner

_Owner
_Owner string

_Owner

Get Financial Fact Trend

Examine the trend in a fundamental financial data point. For example, get all annual revenue since 2013 for Apple

Parameters

Name Key Required Type Description
Entity CIK or trading symbol
id True string

The CIK or trading symbol of the entity you are requesting filings for

Fact type
label True integer

The data fact you are trying to see. See https://aletheiaapi.com/api/#ep_FinancialFactTrend for the available fact list.

Period type
period integer

0 = Annual results only, 1 = quarterly results only

After date
after string

Filter facts to only after a specific date. YYYYMMDD format.

Before date
before string

Filter facts to only before a specific date. YYYYMMDD format.

Returns

Name Path Type Description
array of object
Period Start
PeriodStart date

Period start date for this data point

Period End
PeriodEnd date

Period end date for this data point

Value
Value float

The data point value

Get Stock Data (V2)

Access stock data for any US-based publicly traded equity security

Parameters

Name Key Required Type Description
Symbol
symbol True string

The stock symbol (ticker) of the equity you are requesting data for

Only Include Fields
fields string

If you would only like certain fields returned, specify them by name (separated by comma)

Returns

Name Path Type Description
Symbol
Symbol string

The trading symbol (ticker) of the company

Full Time Employees
FullTimeEmployees integer

The number of full time employees the company has

Sector
Sector string

The sector the company competes in

Industry
Industry string

The industry the company competes in

Open
Open float

The opening price of this security at the beginning of the trading session

Average Volume, 90 Day
AverageVolume90Day integer

The average number of shares that are traded in a given trading session, for the past 90 days

Exchange
Exchange string

The exchange the security trades on

Day High
DayHigh float

The highest price the security has been traded for during today's trading session

Short Name
ShortName string

The name of the company, in short format

Long Name
LongName string

The company name, in long format

Change
Change float

The change in price since the opening of the trading session

Previous Close
PreviousClose float

The closing price of the previous trading session

Price
Price float

The laste traded price of the security

Curreny
Currency string

The currency this security is traded in (i.e. USD)

Volume
Volume integer

The number of shares that have been traded so far in the current trading session

Market Cap
MarketCap float

The market value of the organization's outstanding shares

Change Percent
ChangePercent float

The change in price, expressed as a percentage, since the opening of the trading session

Day Low
DayLow float

The lowest price the security has been traded for during today's trading session

Bid Price
BidPrice float

The highest price a buyer will pay to buy the specified bid quantity number of shares

Bid Quantity
BidQuantity integer

The number of shares a buyer will pay to buy at the specified bid price

Ask Price
AskPrice float

The security price a market maker is willing to spend to purchase one share

Ask Quantity
AskQuantity integer

The amount of a security a market maker is willing to purchase at the given ask price

Average Volume, 10 Day
AverageVolume10Day integer

The average number of shares that are traded in a given trading session, for the past 10 days

Year Low
YearLow float

The stock price low over the past 12 months

Year High
YearHigh float

The stock price high over the past 12 months

Beta
Beta float

The Beta of the stock. Beta reflects market volatility.

Price Earnings Ratio
PriceEarningsRatio float

Price-to-Earnings Ratio of the company

Earnings Per Share
EarningsPerShare float

The EPS of the most recent fiscal year

Earnings Date
EarningsDate string

The next upcoming earnings date

Forward Dividend
ForwardDividend float

The anticipated next dividend payment per share

Forward Dividend Yield
ForwardDividendYield float

The anticipated total dividend payout, as a percentage yield, over the next 12 months

Ex-Dividend Date
ExDividendDate string

The latest date at which one must own the stock to be included in the next dividend payment

Year Target Estimate
YearTargetEstimate float

The price target at which analysts are predicting the price of one share to be in 12 months time

Last Fiscal Year End
LastFiscalYearEnd string

The end date of the most recent fiscal year

Last Fiscal Quarter End
LastFiscalQuarterEnd string

The end date of the most recent quarter

Profit Margin
ProfitMargin float

The profit margin in the most recent fiscal period

Operating Margin
OperatingMargin float

The operating margin of the company in the most recent fiscal period

Return on Assets
ReturnOnAssets float

Net income expressed as a percentage of assets

Return on Equity
ReturnOnEquity float

Net income expressed as a percentage of equity

Revenue
Revenue float

Revenue of the company in the most recent fiscal year

Revenue per Share
RevenuePerShare float

Revenue per share in the most recent fiscal year

Quarterly Revenue Growth
QuarterlyRevenueGrowth float

The growth rate in quarterly revenue

Gross Profit
GrossProfit float

The profit a company makes after deducting the costs associated with providing services

EBITDA
EDBITDA float

Earnings before interest, tax, depreciation, and amortization

Earnings Available to Common
NetIncomeAvailableToCommon float

The net earnings available to common shareholders (after tax and preferred dividends)

Quarterly Earnings Growth
QuarterlyEarningsGrowth float

The growth rate in quarterly earnings

Cash
Cash float

The amount of cash the company has in it's possession

Cash per share
CashPerShare float

The amount of cash the company has divided by the number of shares

Debt
Debt float

The total debt of a company (liabilities)

Debt to Equity Ratio
DebtToEquityRatio float

The companies debt/equity ratio (liabilities/equity)

Current Ratio
CurrentRatio float

Ratio of current assets to current liabilities. Reflects short term liquidity

Book value per share
BookValuePerShare float

Net equity on a per-share basis

Operating Cash Flow
OperatingCashFlow float

Net cash generated from or used by operating activities

Levered Free Cash Flow
LeveredFreeCashFlow float

The remaining earnings after paying financial obligations

Year Change Percent
YearChangePercent float

The change in the price over the past 12 months, expressed as a percentage

S&P 500 Annual Return
SP500YearChangePercent float

The trailing 12 month return of the S&P 500 (for comparison purposes)

Moving Average, 50 Day
MovingAverage50Day float

The average number of shares that are traded in a given trading session, for the past 50 days

Moving Average, 200 Day
MovingAverage200Day float

The average number of shares that are traded in a given trading session, for the past 200 days

Shares Outstanding
SharesOutstanding float

The number of shares available for trade in the market

Float
Float float

The number of shares being traded in the market

Percent Held By Insiders
PercentHeldByInsiders float

The percentage of shares held by insiders at the company

Percent Held By Institutions
PercentHeldByInstitutions float

The percentage of shares held by institutions

Shares Short
SharesShort float

The number of shares currently under short sale

Short Ratio
ShortRatio float

The number of days it takes short sellers on average to cover their positions

Short Percent of Float
ShortPercentOfFloat float

The percentage of shares (float) that are currently being shorted

Short Percent of Shares Outstanding
ShortPercentOfSharesOutstanding float

The percentage of shares outstanding that are currently being shorted

Forward Annual Dividend
ForwardAnnualDividend float

The projected dividend of one share over the next 12 months

Forward Annual Dividend Yield
ForwardAnnualDividendYield float

The projected dividend yield of one share over the next 12 months at the current share price

Trailing Annual Dividend
TrailingAnnualDividend float

Sum of the paid dividends over the past 12 months

Trailing Annual Dividend Yield
TrailingAnnualDividendYield float

Sum of the paid dividends over the past 12 months, expressed as a yield

Average Dividend Yield - 5 Year
FiveYearAverageDividendYield float

The average dividend yield over the past five years

Dividend Payout Ratio
DividendPayoutRatio float

The proportion of earnings a company is paying out as dividends, expressed as a percentage

Dividend Date
DividendDate string

The dividend payment date (if a dividend is offered)

Last Split Factor
LastSplitFactor string

The factor by which the stock was split at the last split

Last Split Date
LastSplitDate string

The last time the stock was split or reverse split

Get Stock Data [DEPRECATED]

This action has been deprecated. Please use Get Stock Data (V2) instead.

Access stock data for any US-based publicly traded equity security (deprecated)

Parameters

Name Key Required Type Description
Symbol
symbol True string

The trading symbol of the security

Include summary data
summary boolean

Includes summary data like price, volume, open, and more

Include statistical data
statistics boolean

Includes data like current ratio, moving averages, and more

Returns

Name Path Type Description
Symbol
Symbol string

The symbol that data was requested for

Company Name
Summary.Name string

The name of the issuing company

Stock Symbol
Summary.StockSymbol string

The registered trading symbol of the security

Price
Summary.Price float

The last trade price of the security

Price Change
Summary.DollarChange float

The change in price since the opening of today's trading session

Percent Change
Summary.PercentChange float

The change in price, expressed as a percentage, since the opening of today's trading session

Previous Close
Summary.PreviousClose float

The closing price of the previous trading session

Open
Summary.Open float

The opening price of this security at the opening of the trading session

Bid Price
Summary.BidPrice float

The highest price a buyer will pay to buy the specified bid quantity number of shares

Bid Quantity
Summary.BidQuantity integer

The number of shares a buyer will pay to buy at the specified bid price

Ask Price
Summary.AskPrice float

The security price a market maker is willing to spend to purchase one share

Ask Quantity
Summary.AskQuantity integer

The amount of a security a market maker is willing to purchase at the given ask price

Day Low
Summary.DayRangeLow float

The lowest price the security has been traded for during today's trading session

Day High
Summary.DayRangeHigh float

The highest price the security has been traded for during today's trading session

Year Low
Summary.YearRangeLow float

The stock price low over the past 12 months (from summary data)

Year High
Summary.YearRangeHigh float

The stock price high over the past 12 months (from summary data)

Volume
Summary.Volume integer

The number of shares that have been traded so far in the trading session

Average Volume
Summary.AverageVolume integer

The average number of shares that are traded in a given trading session (1 day)

Market Capitalization
Summary.MarketCap float

The market value of the organization's outstanding shares

Beta
Summary.Beta float

The Beta of the stock. Beta reflects market volatility.

Price Earnings Ratio
Summary.PriceEarningsRatio float

The P/E ratio (if one exists)

Earnings Per Share
Summary.EarningsPerShare float

The EPS of the most recent fiscal year

Earnings Date
Summary.EarningsDate string

The next upcoming earnings date

Forward Dividend
Summary.ForwardDividend float

The anticipated total dividend payout over the next 12 months

Forward Dividend Yield
Summary.ForwardDividendYield float

The anticipated total dividend payout, as a percentage yield, over the next 12 months

Ex-Dividend Date
Summary.ExDividendDate string

The latest date at which one must own the stock to be included in the next dividend payment

Year Target Estimate
Summary.YearTargetEstimate float

The price target at which analysts are predicting the price of one share to be in 12 months time

Queried Symbol (summary)
Summary.QueriedSymbol string

The symbol corresponding to the summary data

Summary Data Collected On
Summary.DataCollectedOn string

The date and time stamp at which the summary data was collected

Fiscal Year Ends
Statistics.FiscalYearEnds string

The end of the company's fiscal year

Most Recent Quarter
Statistics.MostRecentQuarter string

The end date of the most recent fiscal quarter

Profit Margin
Statistics.ProfitMargin float

The profit margin in the most recent fiscal period

Operating Margin
Statistics.OperatingMargin float

The operating margin of the company in the most recent fiscal period

Return on Assets
Statistics.ReturnOnAssets float

Net income expressed as a percentage of assets

Return on Equity
Statistics.ReturnOnEquity float

Net income expressed as a percentage of equity

Revenue
Statistics.Revenue integer

Revenue of the company in the most recent fiscal year

Revenue Per Share
Statistics.RevenuePerShare float

Revenue per share in the most recent fiscal year

Quarterly Revenue Growth
Statistics.QuarterlyRevenueGrowth float

The growth rate in quarterly revenue

Gross Profit
Statistics.GrossProfit integer

The profit a company makes after deducting the costs associated with providing services

EBITDA
Statistics.EBITDA float

Earnings before interest, tax, depreciation, and amortization

Earnings available to Common
Statistics.NetIncomeAvailableToCommon integer

The net earnings available to common shareholders (after tax and preferred dividends)

Diluted EPS
Statistics.DilutedEps float

Earnings per share on a diluted basis (if all convertible securities were converted to equity)

Quarterly Earnings Growth
Statistics.QuarterlyEarningsGrowth float

The growth rate in quarterly earnings

Total Cash
Statistics.TotalCash integer

The total amount of cash the company has on hand

Total Cash Per Share
Statistics.TotalCashPerShare float

The total cash the company has on hand at a per-share basis

Total Debt
Statistics.TotalDebt integer

The total debt of a company (liabilities)

Debt/Equity Ratio
Statistics.TotalDebtEquityRatio float

The companies debt/equity ratio (liabilities/equity)

Current Ratio
Statistics.CurrentRatio float

Ratio of current assets to current liabilities. Reflects short term liquidity.

Book value per share
Statistics.BookValuePerShare float

Net equity on a per-share basis

Operating Cash Flow
Statistics.OperatingCashFlow integer

Net cash generated from or used by operating activities

Levered Free Cash Flow
Statistics.LeveredFreeCashFlow integer

The remaining earnings after paying financial obligations

Beta
Statistics.Beta float

The Beta of the stock. Beta reflects market volatility.

Year Change
Statistics.YearChange float

The percent change in the stock price over the past 12 month period

S&P 500 Return
Statistics.SP500YearChange float

The trailing 12 month return of the S&P 500 (for comparison purposes)

Year High
Statistics.YearHigh float

The stock price high over the past 12 months (from statistics data)

Year Low
Statistics.YearLow float

The stock price low over the past 12 months (from statistics data)

50 Day Moving Average
Statistics.MovingAverage50Day float

The average share price over the past 50 days

200 Day Moving Average
Statistics.MovingAverage200Day float

The average share price over the past 200 days

Average Volume - 90 Days
Statistics.AverageVolume3Month integer

The average volume of the last 90 days

Average Volume - 10 Day
Statistics.AverageVolume10Day integer

The average volume of the past ten days

Shares Outstanding
Statistics.SharesOutstanding integer

The number of shares available for trade in the market

Float
Statistics.Float integer

The number of shares being traded in the market

Percent Held by Insiders
Statistics.PercentHeldByInsiders float

The percentage of shares held by insiders at the company

Percent Held by Institutions
Statistics.PercentHeldByInstitutions float

The percentage of shares held by institutions

Shares Short
Statistics.SharesShort integer

The number of shares currently under short sale

Short Ratio
Statistics.ShortRatio float

The number of days it takes short sellers on average to cover their positions

Short Percent of Float
Statistics.ShortPercentOfFloat float

The percentage of shares (float) that are currently being shorted

Short Percent of Shares Outstanding
Statistics.ShortPercentOfSharesOutstanding float

The percentage of shares outstanding that are currently being shorted

Forward Annual Dividend
Statistics.ForwardAnnualDividend float

The projected dividend of one share over the next 12 months

Forward Annual Dividend Yield
Statistics.ForwardAnnualDividendYield float

The projected dividend yield of one share over the next 12 months at the current share price

Trailing Annual Dividend
Statistics.TrailingAnnualDividend float

Sum of the paid dividends over the past 12 months

Trailing Annual Dividend Yield
Statistics.TrailingAnnualDividendYield float

Sum of the paid dividends over the past 12 months, expressed as a yield

Average Dividend Yield - 5 Year
Statistics.FiveYearAverageDividendYield float

The average dividend yield over the past five years

Dividend Payout Ratio
Statistics.DividendPayoutRatio float

The proportion of earnings a company is paying out as dividends, expressed as a percentage

Dividend Date
Statistics.DividendDate string

The dividend payment date (if a dividend is offered)

Ex-dividend Date
Statistics.ExDividendDate string

The latest date at which one must own the stock to be included in the next dividend payment

Last Split Factor
Statistics.LastSplitFactor string

The factor by which the stock was split at the last split

Last Split Date
Statistics.LastSplitDate string

The last time the stock was split or reverse split

Queried Symbol (statistics)
Statistics.QueriedSymbol string

The symbol corresponding to the statistics data

Statistical data collected
Statistics.DataCollectedOn string

The specific date and time the statistical data was colllected

Latest Insider Transactions

Get the latest insider transactions for a person or company

Parameters

Name Key Required Type Description
Issuer CIK or trading symbol
issuer string

The CIK or trading symbol of the issuing company

Owner CIK
owner integer

The CIK of the owner (person) involved as the owner in transactions

Top Number of Records
top integer

The number of transactions to limit the search to. Default is 20.

Before
before string

Filter transactions to before a particular date (YYYYMMDD format)

Security Type
securitytype integer

Filter to a security type. 0 = Equity, 1 = Derivative

Transaction Type
transactiontype integer

Filter to a particular transaction type

Cascade
cascade boolean

Also include related records (entity and filing data)

Returns

Name Path Type Description
array of object
Transaction ID
Id string

The ID of the transaction in the Aletheia database

From Filing (ID)
FromFiling string

The ID of the filing from which this transaction originated from

Filing ID
_FromFiling.Id string

The ID of the filing from which the transaction originated from

Filing URL
_FromFiling.FilingUrl string

The URL of filing form which the transaction originated from

Accession Number Part 1
_FromFiling.AccessionP1 integer

The first portion of the SEC-assigned unique ID for this filing

Accession Number Part 2
_FromFiling.AccessionP2 integer

The second portion of the SEC-assigned unique ID for this filing

Accession Number Part 3
_FromFiling.AccessionP3 integer

The third portion of the SEC-assigned unique ID for this filing

Filing Type
_FromFiling.FilingType string

The type of filing the transaction originated from (i.e. "4")

Reported On
_FromFiling.ReportedOn date

The date on which the originating filing was filed with the SEC

Issuer CIK
_FromFiling.Issuer integer

The CIK of the company that issued the securities involved in this transaction

Issuer CIK
_FromFiling._Issuer.Cik integer

The CIK of the company that issued the securities involved in this transaction

Issuer Name
_FromFiling._Issuer.Name string

The name of the issuing company

Issuer Trading Symbol
_FromFiling._Issuer.TradingSymbol string

The trading symbol of the issuing company

Owner CIK
_FromFiling.Owner integer

The CIK of the owner (insider) involved in this transaction

Owner CIK
_FromFiling._Owner.Cik integer

The CIK of the owner involved in this transaction

Owner Name
_FromFiling._Owner.Name string

The name of the owner involved in this transaction

Trading Symbol
_FromFiling._Owner.TradingSymbol string

The trading symbol of the owner (if it is a company)

Entry Type
EntryType integer

0 = A new transaction, 1 = Reporting a holding

Quantity Owned Following Transaction
QuantityOwnedFollowingTransaction float

The number of securities of this type owned after the transaction

Direct or Indirect Ownership
DirectIndirect integer

The ownership nature of the security. 0 = Direct, 1 = Indirect

Security Title
SecurityTitle string

The title of the subject security in this transaction or holding record

Security Type
SecurityType integer

The type of security. 0 = equity, 1 = derivative

Acquired or Disposed
AcquiredDisposed integer

Whether it was an acquisition or disposition. 0 = Acquisition, 1 = Disposition

Quantity
Quantity float

The number of securities involved in this transaction or holding

Price per Security
PricePerSecurity float

The price at which the security was acquired or disposed

Transaction Date
TransactionDate date

The effective date of the transaction

Transaction Code
TransactionCode integer

Code representing the type of transaction

Conversion or Exercise Price
ConversionOrExercisePrice float

The exercise price of this derivative security

Exercisable Date
ExercisableDate date

The exercisable date of the derivative security

Expiration Date
ExpirationDate date

The expiration date of the derivative security

Underlying Security Title
UnderlyingSecurityTitle string

If the transaction is derivative, the title of the underlying security

Underlying Security Quantity
UnderlyingSecurityQuantity float

If the transaction is derivative, the quantity of the underlying security

List Affiliated Owners

List the owners who in the past have had transactions with a particular company's securities

Parameters

Name Key Required Type Description
Company ID
id True string

Either the CIK or the trading symbol of the company you are requesting. Provide the CIK for faster performance.

Returns

Name Path Type Description
array of object
CIK
Cik integer

The SEC-assigned CIK (ID) of this owner

Name
Name string

The full name of the owner

List an entity's SEC filings

Request a list of latest SEC filings for an entity (company or person)

Parameters

Name Key Required Type Description
Entity CIK or Trading Symbol
id True string

The CIK or trading symbol of the entity you are requesting filings for

Filing Type
filing string

Filter to a specific filing type, for example "10-K" or "10-Q"

Filter to filings only before a particular date in time
before integer

YYYYMMDD format, for example 20151231

Returns

Name Path Type Description
array of object
Interactive Data URL
InteractiveDataUrl string

If the filing includes XBRL information (for example, 10-K filings), a link to the interactive data of the filing

Filing Type
Filing string

The filing type, for example "10-K" or "10-Q"

Filing URL
DocumentsUrl string

A URL to the filing with the SEC

Description
Description string

A description of the filing

Filing Date
FilingDate date

The date the filing was filed with the SEC

Open Common Financial Statements

Open financial statements from a 10-K or 10-Q filing

Parameters

Name Key Required Type Description
Filing URL
filingurl True string

The URL to the SEC 10-K or 10-Q filing

Returns

Name Path Type Description
Period Start
PeriodStart date

The start date of this fiscal period

Period End
PeriodEnd date

The end date of this fiscal period

Revenue
Revenue float

The company's revenue in the fiscal period

Selling, General, and Administrative Expenses
SellingGeneralAndAdministrativeExpense float

The summation of SG&A expenses in the fiscal period

Research and Development Expenses
ResearchAndDevelopmentExpense float

The R&D expenses in the fiscal period

Operating Income
OperatingIncome float

The operating income or loss of the company on the income statement

Net Income
NetIncome float

The net income or loss in this fiscal period

Assets
Assets float

The summation of assets on the balance sheet

Liabilities
Liabilities float

The summation of liabilities on the balance sheet

Equity
Equity float

The summation of equity on the balance sheet

Cash
Cash float

The cash on the balance sheet

Current Assets
CurrentAssets float

The summation of current assets on the balance sheet (assets that will be disposed of within 12 months)

Current Liabilities
CurrentLiabilities float

The summation of current liabilities on the balance sheet (liabilities that will be settled within 12 months)

Retained Earnings
RetainedEarnings float

The balance of retained earnings or retained deficit at the end of the fiscal period

Common Stock Shares Outstanding
CommonStockSharesOutstanding float

The number of shares outstanding

Operating Cash Flows
OperatingCashFlows float

Cash flows generated from or used by operating activities (i.e. payments to suppliers)

Investing Cash Flows
InvestingCashFlows float

Cash flows generated from or used by investing activities (i.e. purchases of assets)

Financing Cash Flows
FinancingCashFlows float

Cash flows generated from or used by financing activities (i.e. payment/issuance of debt)

Proceeds from Issuance of Debt
ProceedsFromIssuanceOfDebt float

The cash gained from issuances of debt in the fiscal period

Payments of Debt
PaymentsOfDebt float

The total payments of debt the company made in this fiscal period

Dividends Paid
DividendsPaid float

The total dividends paid out during this fiscal period

Open Form 4

Parse a Form 4 (changes in ownership) document

Parameters

Name Key Required Type Description
Filing URL
filingurl True string

The URL to the form 4 SEC Filing

Returns

Name Path Type Description
Schema Version
SchemaVersion string

The schema version of the data document

Period of Report
PeriodOfReport date

The date at which the document was prepared and reported

Document Type
DocumentType string

The document type of this statement (i.e. "4", "3", "5")

Issuer CIK
IssuerCik string

The issuing company's CIK (identification number) that has been assigned by the SEC

Issuer Name
IssuerName string

The name of the issuing company involved in this transaction

Issuer Trading Symbol
IssuerTradingSymbol string

The trading symbol of the issuing company involved in this transaction

Owner Name
OwnerName string

The name of the owner

Owner CIK
OwnerCik string

The owner's CIK (identification number) that has been assigned by the SEC

Owner Street Address Line 1
OwnerStreet1 string
Owner Street Address Line 2
OwnerStreet2 string
Owner Address City
OwnerCity string

The owner's city

Owner Address State Code
OwnerStateCode string

The owner's state code, i.e. "FL" or "GA"

Owner Zip Code
OwnerZipCode string

The zip code of the owner's address

Owner is Officer
OwnerIsOfficer boolean

If the owner is specified as an officer of the issuing company

Owner Officer Title
OwnerOfficerTitle string

If the owner is a titled officer, their position title

NonDerivativeTransactions
NonDerivativeTransactions array of object

NonDerivativeTransactions

Security Title (Non-Derivative)
NonDerivativeTransactions.SecurityTitle string

The title of the non-derivative security involved in the transaction

Securities Owned Following Transaction (Non-Derivative)
NonDerivativeTransactions.SecuritiesOwnedFollowingTransaction float

The number of non-derivative securities the filing owner owns following the transaction

Direct or Indirect Ownership (Non-Derivative)
NonDerivativeTransactions.DirectOrIndirectOwnership integer

The ownership nature of the security. 0 = Direct, 1 = Indirect

Transaction Date (Non-Derivative)
NonDerivativeTransactions.TransactionDate date

The date of the non-derivative transaction

Transaction Code (Non-Derivative)
NonDerivativeTransactions.TransactionCode integer

The ID of the transaction code for this non-derivative transaction

Transaction Quantity (Non-Derivative)
NonDerivativeTransactions.TransactionQuantity float

The number of securities in the non-derivative transaction (number of shares)

Transaction Price per Security (Non-Derivative)
NonDerivativeTransactions.TransactionPricePerSecurity float

The price per non-derivative security

Acquired or Disposed (Non-Derivative)
NonDerivativeTransactions.AcquiredOrDisposed integer

0 = Acquisition, 1 = Disposal

DerivativeTransactions
DerivativeTransactions array of object

DerivativeTransactions

Conversion or Exercise Price
DerivativeTransactions.ConversionOrExercisePrice float

The exercise price of this derivative security

Exercisable On
DerivativeTransactions.Exersisable date

The date this derivative security is exercisable by the owner

Expiration Date
DerivativeTransactions.Expiration date

The expiration date of the derivative security involved in this transaction

Underlying Security Title
DerivativeTransactions.UnderlyingSecurityTitle string

The title of the derivative security's underlying equity security

Underlying Security Quantity
DerivativeTransactions.UnderlyingSecurityQuantity float

The quantity of the underlying securities in this derivative transaction

Security Title (Derivative)
DerivativeTransactions.SecurityTitle string

The title of the derivative security involved in the transaction

Securities Owned Following Transaction (Derivative)
DerivativeTransactions.SecuritiesOwnedFollowingTransaction float

The number of derivative securities the filing owner owns following the transaction

Direct or Indirect Ownership (Derivative)
DerivativeTransactions.DirectOrIndirectOwnership integer

The ownership nature of the security. 0 = Direct, 1 = Indirect

Transaction Date (Derivative)
DerivativeTransactions.TransactionDate date

The date of this derivative transaction

Transaction Code (Derivative)
DerivativeTransactions.TransactionCode integer

The ID of the transaction code for this non-derivative transaction

Transaction Quantity (Derivative)
DerivativeTransactions.TransactionQuantity float

The number of securities involved in this derivative transaction

Transaction Price per Security (Derivative)
DerivativeTransactions.TransactionPricePerSecurity float

The price per derivative security in this transaction

Acquired or Disposed (Derivative)
DerivativeTransactions.AcquiredOrDisposed integer

0 = Acquisition, 1 = Disposal

Search Earnings Call Transcripts

Search the database for available earnings call transcripts for any publicly traded company

Parameters

Name Key Required Type Description
Search for an earnings call transcript
company string

Ticker symbol of the company you are searching for

Fiscal year
year integer

The fiscal year of the earnings call you are searching for

Fiscal quarter
quarter string

Q1, Q2, Q3, or Q4. The fiscal quarter of the earnings call you are searching for.

Max number of results
top integer

Maximum number of results to return

Returns

Name Path Type Description
array of object
Earnings call transcript ID
Id string

The unique ID of the earnings call transcript

Company ID
Company.Id string

The unique ID of the company this earnings call pertains to

Company name
Company.Name string

Name of the company this earnings call pertains to

Trading Symbol
Company.TradingSymbol string

The ticker symbol of the company this earnings call pertains to

Period
Period integer

0 = Q1, 1 = Q2, 2 = Q3, 3 = Q4

Fiscal year
Year integer

The fiscal year in which this earnings call pertains to

Held At
HeldAt date-time

The date this earnings call was held on

Search Entities

Search the Aletheia database for an entity. An entity represents either a company (serving as an security issuer) or a person (serving as a security owner).

Parameters

Name Key Required Type Description
Search Term
term True string

The search term (i.e. company or person name).

Top number of records
top integer

Limit the search results

Returns

Name Path Type Description
array of object
CIK
Cik integer

The unique ID of the entity as assigned by the SEC

The name of the entity (company name or person's full name)
Name string

Entity Name

Trading Symbol
TradingSymbol string

If the entity is a company, the company's trading symbol from a public stock exchange

Triggers

When a new filing is filed with the SEC

Trigger a workflow when a new filing is filed with the SEC and use details from that filing

When a new insider trade is reported to the SEC

Company insiders are required to report their security transactions to the SEC. Be notified within seconds of a new insider transaction in any particular company.

When a new filing is filed with the SEC

Trigger a workflow when a new filing is filed with the SEC and use details from that filing

When a new insider trade is reported to the SEC

Company insiders are required to report their security transactions to the SEC. Be notified within seconds of a new insider transaction in any particular company.

Parameters

Name Key Required Type Description
Company
issuer string

The issuing company of the securities being traded. For example, 'MSFT' for Microsoft or 'AAPL' for Apple.

Owner
owner integer

The CIK of the insider that is trading the securities. For example, the CEO of the company. You must provide the CIK (ID) of the person. You can find the ID for any particular insider with the 'Search Entities' action.

Transaction Type
transactionType integer

Filter to only a specific transaction type, i.e. buys, sells, grants, etc. See http://aletheiaapi.com/docs/#insider-trading-webhook for the list of available transaction type codes.

Security Type
securityType integer

Filter to only a specific security type. 0 = non-derivative, 1 = derivative