Stock Data
GET
Stock Data
Crypto
GET
Crypto Quote
Insider Trading
Fundamentals
Earnings Calls
Death Cross
SEC Filings
Usage Metrics
Service Information
Authenticating
Every API call to the endpoints below requires a valid API key to be provided. This API key verifies your permission to use the service. API keys are free! Get your own by registering for an account.
How to provide your key
Your key will look like this: 333acb16de254844ab64783232d2ba66
Include your API key as a header to your request with the label 'key'
Versioning
Some of the endpoints below will have multiple versions available for consumption. To specify which version you would like to consume, use the Accept-Version header. For example, specifying you want version 2:
Accept-Version: 2
Example in Postman:
Stock Data
Access data for any publicly traded security, including stock, bonds, options, and more.
Stock Data (v1) Deprecated, please use new version
Access summary or statistical data for stocks, bonds, options, crypto, and more.
A newer version of this endpoint is available, see Stock Data v2. If you still wish to use version 1 (for backwards compatability), please specify you would like version 1 via the Accept-Version header; for more information, please see the versioning instructions.
GET
https://api.aletheiaapi.com/StockData
Parameters
Required
Optional
Optional
Example Requests
https://api.aletheiaapi.com/StockData?symbol=msft&summary=true
https://api.aletheiaapi.com/StockData?symbol=msft&summary=true&statistics=true
https://api.aletheiaapi.com/StockData?symbol=aapl&summary=false&statistics=true
+ Example Response
{
}
}
Stock Data (v2)
Access summary or statistical data for stocks, bonds, options, crypto, and more. To specify you would like to consume version 2 of this endpoint, set the Accept-Version header to 2. See the versioning instructions for more information.
The advantage of using the v2 specification is drastically reduced response times for requests that would be requesting both summary data and statistical data (as seen in version 1).
GET
https://api.aletheiaapi.com/StockData
Parameters
Required
Optional
Example Requests
https://api.aletheiaapi.com/StockData?symbol=msft
https://api.aletheiaapi.com/StockData?symbol=msft&fields=Price,MarketCap,DayHigh,DayLow
https://api.aletheiaapi.com/StockData?symbol=pg&fields=Price
+ Example Response
{
}
}
Crypto
Use these endpoints to access real-time data about cryptocurrencies.
Crypto Quote
Access pricing and trading activity data for virtually any cryptocurrency. All quotes are in U.S. Dollars.
GET
https://api.aletheiaapi.com/Crypto
Parameters
Required
Example Requests
https://api.aletheiaapi.com/Crypto?symbol=BTC
https://api.aletheiaapi.com/Crypto?symbol=DOGE
https://api.aletheiaapi.com/Crypto?symbol=XRP
+ Example Response
{
}
}
Insider Trading
Read and monitor insider transactions for any publicly traded company.
Insider Trading (Webhook)
You can subscribe your application or web service to be notified of new insider trading the moment it is reported to the SEC. You can even specify the companies, individuals, security types, or transactions you only wish to be notified of.
Step 1 - Subscribe Your Endpoint
First you must subscribe your endpoint to the insider trading webhook service. You can subscribe your endpoint by making a POST call to the URL specified below.
POST
https://api.aletheiaapi.com/SubscribeToInsiderTradingWebhook
The following is an example of the body of the POST call you will make:
{
https://www.myservice.net/myendpoint ",
MSFT ",
1513142 ,
1 ,
0
}
}
- The endpoint property is mandatory! This is where you will specify the endpoint of your API service that Aletheia will call.
- The issuer property specifies the company you only want to receive insider trading notifications for. Microsoft is the specified company (CIK 789019) in this example. You can either provide the trading symbol of the company ("MSFT" in this example) or the CIK of the company. Provide the CIK for faster performance. This property is optional.
- The owner property is the CIK of the person you only want to receive insider trading notifications on. In this example we have it set to 1513142 which is the CIK of Satya Nadella, the CEO of Microsoft This property is optional.
- The transactionType property specifies the the transaction type you only want to be notified of. Please see the transaction type property from the Latest Transactions endpoint to see the list of transaction type ID's. This property is optional.
- The securityType property specifies the security type that you only want to be notified on. This means that you will only be notified of transactions involving either non-derivative (equity) securities or derivative securities. 0 = non-derivative, 1 = derivative. This property is optional.
For any optional property that you do not specify in the POST body, the assumption will be made that you would like to subscribe your endpoint to all of the available selections. For example, if I did not specify the issuer property when subscribing my endpoint, this will in turn mean that my endpoint will be called for transactions involving any company.
The subscription endpoint will return a 201 created response. This response will include a "Location" header. The value of this header will be used to unsubscribe from this webhook, so save this for later.
Step 2 - Receive New Filings!
After subscribing your endpoint to the webhook with step 1, your endpoint will begin to receive HTTP POST requests when new qualifying insider trades become available.
The following is an example of the POST request that will be sent to your registered endpoint:
POST
(your registered endpoint)
{
}
}
You can find thorough explanations for each component of each component above in other endpoint documentation.
- SecEntity from the Get Entity endpoint
- SecFiling from the Get Filing endpoint
- The HeldOfficerPosition property will be populated if the insider in this transaction has a titled position with the company (for example CEO, CFO, Chairman, etc.)
- SecurityTransactionHolding from the Latest Transactions endpoint
Step 3 - Unsubscribe from the webhook when finished
When you wish to stop receiving posts from this webhook, be sure to formally unsubscribe your endpoint.
When you originally registered your endpoint in step 1, the returned 201 created response contained a "Location" header. The value of this header contains the endpoint that will unsubscribe your endpoint via a DELETE call. The unsubscribe endpoint will look something like this:
https://api.aletheiaapi.com/UnsubscribeWebhook?id=dd150c44-c42a-4cdd-92f5-b78a23b36c72
To unsubscribe your endpoint from this webhook, call this provided value via a DELETE call.
If you no longer have the provided unsubscribe URL (ID of your webhook to unsubscribe with) from the original subscription step, you can also unsubscribe by providing your registered endpoint URL. For example, see below:
DELETE
https://api.aletheiaapi.com/UnsubscribeWebhook?endpoint=https://www.myservice.net/myendpoint
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).
GET
https://api.aletheiaapi.com/SearchEntities
Parameters
Required
Optional
Example Requests
https://api.aletheiaapi.com/SearchEntities?term=intc
https://api.aletheiaapi.com/SearchEntities?term=amazon
https://api.aletheiaapi.com/SearchEntities?term=cook&top=3
+ Example Response
[
- The SEC assigned Central Index Key (CIK) of this person
]
]
Get Entity
Get details of a company or insider from their Central Index Key (CIK), a unique ID assigned by the Securities Exchange Commission.
GET
https://api.aletheiaapi.com/GetEntity
Parameters
Required
Example Requests
https://api.aletheiaapi.com/GetEntity?id=66740
https://api.aletheiaapi.com/GetEntity?id=mmm
https://api.aletheiaapi.com/GetEntity?id=msft
+ Example Response
{
- The SEC-assigned Central Index Key (CIK) of this company/person
- Company/person name
- If the entity is a company, the trading symbol. If a person, this will be null.
}
}
Get Filing
Get details of a particular SEC filing that has already been processed by our servers.
! Please note that this endpoint will not access any filing with the SEC, but rather only queries filings that have already been scanned and processed and thus exist in our database.
GET
https://api.aletheiaapi.com/GetFiling
Parameters
Optional
Optional
! While the above parameters are optional, you must specify at least one.
Example Requests
https://api.aletheiaapi.com/GetFiling?id=70ebab7c-af6e-47e2-963a-0000b688ca7e
https://api.aletheiaapi.com/GetFiling?id=123c236790fe4328b85800013a5f7491
https://api.aletheiaapi.com/GetFiling?url=https://www.sec.gov/Archives/edgar/data/885725/000122520815006628/0001225208-15-006628-index.htm
+ Example Response
{
- The unique ID of this filing in the Aletheia database
- URL to the filing with the SEC
- Part 1 of the accession number (SEC's ID for this filing)
- Part 2 of the accession number (SEC's ID for this filing)
- Part 3 of the accession number (SEC's ID for this filing)
- 0 = Form 4, 1 = Form 3, 2 = Form 5, 3 = 10-K, 4 = 10-Q
- the date this filing was reported on
- The CIK (SEC-assigned ID) of the issuing company
- This field will only populate if applicable (it is a form 3, 4, or 5 and thus has an associated insider making the trade)
}
}
Latest Transactions
Download the latest insider transactions for a person or company.
GET
https://api.aletheiaapi.com/LatestTransactions
Parameters
Optional
Optional
! The parameters 'issuer' and 'owner' are both optional, but you must provide at least one.
Optional
Optional
- Date supplied in format YYYYMMDD. For example, "20191231".
Optional
Optional
- 0 = purchase
- 1 = sale
- 2 = transaction voluntarily reported earlier than required
- 3 = grant or award
- 4 = sale back to issuer
- 5 = payment of exercise price or tax liability
- 6 = discretionary transaction
- 7 = exercise or conversion of derivative security
- 8 = conversion of derivative security
- 9 = expiration of short derivative position
- 10 = expiration of long derivative position
- 11 = exercise of out-of-the-money derivative
- 12 = exercise of in-the-money derivative
- 13 = bona fide gift
- 14 = small acquisition
- 15 = acquisition or disposition by will or laws
- 16 = deposit into or withdrawal from voting trust
- 17 = other acquisition or disposition
- 18 = equity swap
- 19 = disposition due to tender of shares
Optional
! Due to the larger quantity quantity of data being accessed, cascade querying may be noticeably slower.
Example Requests
https://api.aletheiaapi.com/LatestTransactions?issuer=1800&top=5
https://api.aletheiaapi.com/LatestTransactions?issuer=1800&owner=1783147&before=20181231&securitytype=0&transactiontype=3
https://api.aletheiaapi.com/LatestTransactions?owner=1783147&securitytype=1&transactiontype=0
+ Example Response
[
- The unique ID of this transaction in the Aletheia database
- The unique ID of the SEC filing in the Aletheia database which this transaction stemmed from
- 0 = Transaction, 1 = Holding (no changes, just reporting a held asset)
- The quantity of securities the owner owns following this transaction
- 0 = Direct ownership, 1 = Indirect ownership
- 0 = non-derivative (equity based), 1 = derivative (i.e. options contract)
- 0 = acquired, 1 = disposed
- The quantity of securities acquired/disposed of
- if applicable, the average acquisition or disposition price of the security
- recorded transaction date
- (see the "transactiontype" parameter above)
- if a derivative security, the exercise price of this contract
- if a derivative security, the exercisable date of this contract
- if a derivative security, the expiration date of this contract
- if a derivative security, the title of the contract's underlying security
- if a derivative security, the quantity of the contract's underlying security
]
]
Affiliated Owners
List the insiders who at some point in the time held or made transactions with a particular company.
GET
https://api.aletheiaapi.com/AffiliatedOwners
Parameters
Required
Example Requests
https://api.aletheiaapi.com/AffiliatedOwners?id=789019
https://api.aletheiaapi.com/AffiliatedOwners?id=msft
https://api.aletheiaapi.com/AffiliatedOwners?id=aapl
+ Example Response
[
- The SEC-assigned Central Index Key (unique ID) of this person
- The person's name
]
]
Fundamentals
These endpoints provide with you financial performance data for any publicly traded company. These endpoints span all three primary financial statements, including Income Statement, Balance Sheet, and State of Cash Flows.
Common Financials
Access a financial statement set for a particular company. The returned response will be a financial fact set that is presented in a commonly comparable form.
GET
https://api.aletheiaapi.com/CommonFinancials
Parameters
Required
Optional
- 0 = Annual (from a 10-K filing)
- 1 = Quarterly (from a 10-Q filing)
Optional
- If this parameter is not specified, the API will simply select the most recent financial filing that meets your criteria.
Example Requests
https://api.aletheiaapi.com/CommonFinancials?id=aapl
https://api.aletheiaapi.com/CommonFinancials?id=320193&period=1
https://api.aletheiaapi.com/CommonFinancials?id=320193&period=0&before=20150101
Example Response
+ Example Response
{
}
}
Financial Fact Trend
Examine the trend in a financial result data point for any major commonly-reported figure on an income statement, balance sheet, or statement of cash flows.
GET
https://api.aletheiaapi.com/FinancialFactTrend
Parameters
Required
Required
- Income Statement Facts
- 0 = Revenue
- 1 = Selling, General, and Administrative Expenses (SG&A)
- 2 = Research and Development Expenses
- 3 = Operating Income
- 4 = Net Income/Loss
- Balance Sheet Facts
- 5 = Assets
- 6 = Liabilities
- 7 = Equity
- 8 = Cash
- 9 = Current Assets
- 10 = Current Liabilities
- 11 = Retained Earnings/Deficit
- 12 = Number of common stock shares outstanding
- Cash Flow Statement Facts
- 13 = Operating Cash Flows
- 14 = Investing Cash Flows
- 15 = Financing Cash Flows
- 16 = Proceeds from Issuance of Debt
- 17 = Payments of Debt
- 18 = Dividends Paid
Optional
- 0 = Annual (from a 10-K filing)
- 1 = Quarterly (from a 10-Q filing)
Optional
Optional
Example Requests
https://api.aletheiaapi.com/FinancialFactTrend?id=msft&label=0&period=0
https://api.aletheiaapi.com/FinancialFactTrend?id=msft&label=8&after=20140101
https://api.aletheiaapi.com/FinancialFactTrend?id=1800&label=4&before=20150101
Example Response
+ Example Response
[
- The start date for the period this fact occured in
- The end date for the period this fact occured in
- the fact value
]
]
Earnings Calls
Aletheia continuously processes new earnings calls for many publicly traded companies on a daily basis. You can use these endpoints for accessing earnings call content and highlights from the call.
Search Earnings Calls
Search our database for available earnings call transcripts and highlights.
GET
https://api.aletheiaapi.com/SearchEarningsCalls
Parameters
Optional
Optional
Optional
Optional
Optional
Example Requests
https://api.aletheiaapi.com/SearchEarningsCalls?company=fb&year=2020
https://api.aletheiaapi.com/SearchEarningsCalls?year=2020&quarter=q3&top=8
https://api.aletheiaapi.com/SearchEarningsCalls?company=msft&year=2021&countremarks=true
Example Response
+ Example Response
[
- the unique ID of this earnings call
- the unique ID of the company
- Fiscal quarter. 0 = Q1, 1 = Q2, 2 = Q3, 3 = Q4
- the fiscal year
- date the call was held on
- the number of spoken remarks in this earnings call transcript
]
]
Earnings Call
Access contextual information and spoken content for a publicly traded company's earnings call.
GET
https://api.aletheiaapi.com/EarningsCall
Parameters
Optional
Optional
! While the company parameter is marked as optional above, it must be specified if the id parameter is NOT specified.
Optional
Optional
Optional
Optional
Optional
- kpi - Retrun a list of detected, parsed, and documented key performance indicactors in each spoken remark.
Optional
KPI Response Structure
If you do use the KPI feature of this endpoint by including it in the include parameter, each spoken remark will include a property titled KeyPerformanceIndicators. Below an example:
"KeyPerformanceIndicators": [
]
]
- The subject property contains the plain text of the subject that was refered to during the call.
- status - code indicating the action/what happened to the subject.
- 0 = "equals", "is", etc. For example, "revenue is $500,000."
- 1 = "increased"
- 2 = "decreased"
- 3 = "Is greater than", "surprassed", "exceeded", "passed", etc.
- 4 = "Is less than", "fell below", "sunk below"
- 5 = "produced", "generated", "created", "caused". For example, "iPad contributed $100M in revenue."
- value - the dollar figure, percentage, quantity, that is mentioned. If a percentage is mentioned, it will be in a percentage format (i.e. 55% would be 0.55).
- valueIsPercent - if the value is a percentage, this will be true. If not, this will be false.
- subjectOffset - start location of the subject in the spoken remark.
- subjectLength - length (number of characters) of the subject.
- statusOffset - start location of the phrase that determined the status property in the spoken remark.
- statusLength - length of the phrase that determined the status property in the spoken remark.
- valueOffset - start location of the figure (number or percentage) that determined the value property in the spoken remark.
- valueLength - length of the figure (number or percentage) that determined the value property in the spoken remark.
Example Requests
https://api.aletheiaapi.com/EarningsCall?company=DLTR&year=2019&quarter=q4&begin=0&end=10
https://api.aletheiaapi.com/EarningsCall?company=DLTR&year=2019&quarter=q4&begin=11&end=20&include=kpi
https://api.aletheiaapi.com/EarningsCall?company=msft&year=2019&quarter=q3&countremarks=true&begin=0&end=5
Example Response
+ Example Response
{
}
}
Earnings Call Highlights
Aletheia analyzes each earnings call and extracts the meaningful words, phrases, and financial figures from the calls. You can use the Earnings Call Highlights endpoint to directly request the most important remarks from the call. You can even filter this further and request the most important remarks involving a particular financial category (i.e. important remarks related to revenue, earnings per share, guidance, financial figures, etc).
GET
https://api.aletheiaapi.com/EarningsCallHighlights
Parameters
Required
Required
Required
Optional
- 0 - Revenue
- 1 - Earnings
- 2 - Cash Flow
- 3 - Other
- 4 - Growth
- 5 - Financial Figure
- 6 - Volume
- 7 - Guidance
- 8 - Management Perception of the Situation
Optional
Example Requests
https://api.aletheiaapi.com/EarningsCallHighlights?company=DLTR&year=2019&quarter=q4
https://api.aletheiaapi.com/EarningsCallHighlights?company=DLTR&year=2019&quarter=q4&category=0
https://api.aletheiaapi.com/EarningsCallHighlights?company=AAPL&year=2020&quarter=q1&category=5&top=3
Example Response
+ Example Response
[
The response will include the start position and end position of each keyword or phrase that was recognized being of interest
]
]
Death Cross
The "death cross" is a technical chart pattern indicating the potential for a major sell-off of a stock or security. The death cross appears on a chart when a stock's 50-day moving average crosses it's 200-day moving average. Use Aletheia's Death Cross service to be notified of or research historical death cross events.
Death Cross/Golden Cross (Webhook)
You can subscribe your application or web service to be notified of death cross and golden cross events via this webhook service. This service will notify you of both bearish events in which the 50-day moving average sinks below the 200-day moving average ("death cross"), and bullish events in which the 50-day moving average once again rose above the 200-day moving average ("golden cross").
Step 1 - Subscribe Your Endpoint
First you must subscribe your endpoint to the death cross webhook service.
POST
https://api.aletheiaapi.com/SubscribeToDeathCrossWebhook
The body of the post HTTP request must be in JSON format. For example:
{
}
}
The endpoint property is the only required property to include; this is your own endpoint which you would like to have called upon a death cross event occuring.
If you would only like to subscribe to death cross events of a specific stock, you can specify the stock's trading symbol via the stock property. The example above specifies Tesla (TSLA).
This service is capable of detecting both death cross and golden cross events. A bullish event is when the 50-day moving average sinks below the 200-day moving average. A bearish event occurs when the 50-day moving average rises above the 200-day moving average. Setting the crossType property to 0 means you will only be notified of death crosses, while a value of 1 filters to only golden crosses.
The subscription endpoint will return a 201 created response. This response will include a "Location" header. The value of this header will be used to unsubscribe from this webhook, so save this for later.
Step 2 - Receive death/golden cross events!
After subscribing your endpoint to the webhook with step 1, your endpoint will begin to receive HTTP POST requests when a qualifying death/golden cross event occurs.
The following is an example of the POST request that will be sent to your registered endpoint:
POST
(your registered endpoint)
{
}
}
The Stock property of the payload indicates the stock which made the death cross. The CrossType indicates the cross type - 0 = death cross, 1 = golden cross (see above for what these mean).
Step 3 - Unsubscribe frim the webhook when finished
When you initially subscribed to the death cross webhook service, a header labeled Location should have been included in the 201 (Created) response. Simply send a DELETE request to this URL to unsubscribe your endpoint. Alternatively, you can follow the same unsubscribe instructions from the New Filings webhook to unsubscribe if you no longer have this value.
SEC Filings
Access and monitor filings with the Securities Exchange Commission's EDGAR database.
New SEC Filings (Webhook)
You can subscribe your application or web service to be notified of new SEC filings with this webhook.
Step 1 - Subscribe Your Endpoint
First you must subscribe your endpoint to the new filings webhook service.
POST
https://api.aletheiaapi.com/SubscribeToNewFilingsWebhook
The body must contain the URL endpoint of your API service. The body must be in JSON format with your endpoint stored in the "endpoint" property. Example:
{"endpoint": "https://www.myservice.net/myendpoint "}
The subscription endpoint will return a 201 created response. This response will include a "Location" header. The value of this header will be used to unsubscribe from this webhook, so save this for later.
Step 2 - Receive New Filings!
After subscribing your endpoint to the webhook with step 1, your endpoint will begin to receive HTTP POST requests when a new SEC filing is available.
The following is an example of the POST request that will be sent to your registered endpoint:
POST
(your registered endpoint)
{
"EntityTitle":"BlackRock Capital Investment Corp",
"EntityCik":1326003,
"Filing":"4",
"DocumentsUrl":"https://www.sec.gov/Archives/edgar/data/1326003/000120919121008361/0001209191-21-008361-index.htm",
"Description":"Statement of changes in beneficial ownership of securities Accession Number: 0001209191-21-008361 Size: 9 KB\n",
"FilingDate":"2021-02-05T00:00:00"
}
"EntityTitle":"BlackRock Capital Investment Corp",
"EntityCik":1326003,
"Filing":"4",
"DocumentsUrl":"https://www.sec.gov/Archives/edgar/data/1326003/000120919121008361/0001209191-21-008361-index.htm",
"Description":"Statement of changes in beneficial ownership of securities Accession Number: 0001209191-21-008361 Size: 9 KB\n",
"FilingDate":"2021-02-05T00:00:00"
}
Step 3 - Unsubscribe from the webhook when finished
When you wish to stop receiving posts from this webhook, be sure to formally unsubscribe your endpoint.
When you originally registered your endpoint in step 1, the returned 201 created response contained a "Location" header. The value of this header contains the endpoint that will unsubscribe your endpoint via a DELETE call. The unsubscribe endpoint will look something like this:
https://api.aletheiaapi.com/UnsubscribeFromNewFilingsWebhookById?id=dd150c44-c42a-4cdd-92f5-b78a23b36c72
To unsubscribe your endpoint from this webhook, call this provided value via a DELETE call.
If you no longer have the provided unsubscribe URL from the original subscription step, you can also unsubscribe by providing your registered endpoint to the 'UnsubscribeFromNewFilingsWebhookByEndpoint' api. For example, see below:
DELETE
https://api.aletheiaapi.com/UnsubscribeFromNewFilingsWebhookByEndpoint?endpoint=https://www.myservice.net/myendpoint
Entity Filings
Query the latest SEC filings for a particular company or person.
GET
https://api.aletheiaapi.com/EntityFilings
Parameters
Required
Optional
Optional
Example Requests
https://api.aletheiaapi.com/EntityFilings?id=msft&filing=10-k
https://api.aletheiaapi.com/EntityFilings?id=0000050863&before=20180101
https://api.aletheiaapi.com/EntityFilings?id=pg&filing=4&before=20160701
+ Example Response
[
- Quick view of extracted data
- filing type
- URL to filing
- filing description
- Date the SEC received the filing
]
]
Open Form 4
Open a statement of change in beneficial ownership (form 4) to reveal details of insider trading
GET
https://api.aletheiaapi.com/OpenForm4
Parameters
Required
- Tip: Use the filing url of a form 4 filing that was returned via the "EntityFilings" endpoint (see above)
Example Requests
https://api.aletheiaapi.com/OpenForm4?filingurl=https://www.sec.gov/Archives/edgar/data/50863/000112760221003952/0001127602-21-003952-index.htm
https://api.aletheiaapi.com/OpenForm4?filingurl=https://www.sec.gov/Archives/edgar/data/1318605/000179056521000001/0001790565-21-000001-index.htm
+ Example Response
{
- Schema of the XBRL used in this report
- The Central Index Key (ID) of the issuing company
- Issuing company name
- Issuing company trading symbol
- Name of the insider making the trade
- The Central Index Key (ID) of the insider making the trade
- Equity (non-derivative) trades
- Derivative trades (similar format to above)
}
}
Open Common Financials
Open a financial report document (10-K or 10-Q) filing to a financial statement.
GET
https://api.aletheiaapi.com/OpenCommonFinancials
Parameters
Required
- Tip: Use the filing url of a 10-K/10-Q filing that was returned via the "EntityFilings" endpoint (see above)
Example Requests
https://api.aletheiaapi.com/OpenCommonFinancials?filingurl=https://www.sec.gov/Archives/edgar/data/789019/000156459020034944/0001564590-20-034944-index.htm
https://api.aletheiaapi.com/OpenCommonFinancials?filingurl=https://www.sec.gov/Archives/edgar/data/1326801/000132680120000084/0001326801-20-000084-index.htm
+ Example Response
{
}
}
Usage Metrics
You can use these endpoints to monitor your consumtion of the Aletheia API service.
Consumption
Count the number of API calls you have made or have been made to you (via webhook) in the current month, broken out by service. See the example below. The id property defines the ID number of the service used, the name property is the name of the service (endpoint), and the calls is the number of calls that have been made to (or from) that service in the current month. Finally, the total number of calls consumed during this month across all services is summed at the root level as property calls.
GET
https://api.aletheiaapi.com/v2/consumption
Example Response
+ Example Response
{
}
}
Service Information
These endpoints provide contextual information about the Aletheia service.
API Version
Get the actively deployed version of the Aletheia API service
GET
https://api.aletheiaapi.com/version
Count Entities
Count the number of SEC entities that have been processed and collected.
GET
https://api.aletheiaapi.com/CountSecEntities
Parameters
Optional
Count Filings
Count the number of SEC filings that have been processed and collected.
GET
https://api.aletheiaapi.com/CountSecFilings
Count Transactions
Count the number of transactions that have been processed and collected from from 3, 4, and 5's from the SEC.
GET
https://api.aletheiaapi.com/CountTransactions
Count Fact Contexts
Count the number of Fact Contexts that are available for consumption from the Fundamentals service category.
GET
https://api.aletheiaapi.com/CountFactContexts
Count Financial Facts
Count the number of financial data points that have been collected and are available for consumption from the Fundamentals service category. You can count the number of data points in overall or narrow down to data points belonging to a specific company.
GET
https://api.aletheiaapi.com/CountFinancialFacts
Parameters
Optional
Example Requests
https://api.aletheiaapi.com/CountFinancialFacts
https://api.aletheiaapi.com/CountFinancialFacts?id=MSFT
https://api.aletheiaapi.com/CountFinancialFacts?id=789019