Querying the Data
Here is an example of an API call that you can use to access 5 years of company fundamentals data for Apple (AAPL)
The query is made up of four distinct sections, the findl endpoint, the table, the API key and the query parameters. Click on each of the sections for more information about them.
https://api.findl.com/v1.0/data/ fundamentals ?apiKey=test-api-key &from=2019-06-20&ticker=AAPL&format=csvOnce you've selected a table that you'd like to query, the first three sections of the API call will not change. The fourth section determines what data is returned from the table and in what format. Common query parameters are outlined below. Each tables specific parameters are covered in more detail under the Data Tables section.
ticker
Used to specify the ticker or tickers to return data for. When returning data for multiple tickers, use a comma to separate the values.
ticker=TSLAticker=AAPL,GOOGLticker=MSFTfrom
The date from which to return results. Must be in the format YYYY-MM-DD
from=2023-01-01to
The date until which results should be returned. If this parameter is not specified, the query will return data to the current date. Must be in the format YYYY-MM-DD
to=2023-01-31fields
Used to specify the table fields/columns that should be returned. If this parameter is not specified, the query will return all table fields/columns.
fields=date,ticker,dimension,revenue,corsort
Used to sort the results by the specified column in ascending (.asc) or descending order (.desc). You can add multiple sort criteria by separating them with a comma. If this parameter is not specified, the results will be sorted by date in descending order by default.
sort=date.ascsort=ticker.ascsort=revenue.desc,date.asclimit
Used to specify the maximum number of rows to return in the query. The default is 1000 and the maximum is 10000.
limit=5000skip
Used to skip the first number of specified rows in the results. If this parameter is not specified, no rows will be skipped.
skip=100format
Used to specify the format that the results should be returned in (csv or json). If this is not specified, the results are returned in csv format by default.
format=csvformat=jsonYou can also use operators on the querystring parameters. This allows you to query the data where specific conditions are true. A full list of the operators and their format are provided below.
=
equals
ticker=TSLA.gt=
greater than
calendardate.gt=2023-01-01.gte=
greater than or equal to
calendardate.gte=2023-01-31.lt=
less than
calendardate.lt=2023-01-01.lte=
less than or equal to
calendardate.lte=2023-01-31Putting it all together. You can tailor your query using the above parameters to ensure that it returns the data you're looking for. Here is an example of a query using all the parameters above.
Copyright © findl 2024. All rights reserved.