PublicFunctions/Get-FMPFinancialStatementGrowth.ps1
|
function Get-FMPFinancialStatementGrowth { <# .SYNOPSIS Retrieves financial statement growth data for a specified company using the Financial Modeling Prep API. .DESCRIPTION The Get-FMPFinancialStatementGrowth function fetches detailed growth rates for financial statement items across income statements, balance sheets, and cash flow statements. This helps investors track a company's financial growth trends over time. Users can specify which reporting period to retrieve growth data for and limit the number of results. If no API key is provided, the function attempts to retrieve it using the Get-FMPCredential function. .PARAMETER Symbol Specifies the stock symbol for which to retrieve financial statement growth data (e.g., AAPL). This parameter is mandatory. .PARAMETER Period Specifies the reporting period type. Valid values are "Q1", "Q2", "Q3", "Q4", or "FY". The default value is "FY". .PARAMETER Limit Specifies the maximum number of growth records to retrieve. The default value is 5. .PARAMETER ApiKey Specifies your Financial Modeling Prep API key. If omitted, the function attempts to retrieve it using Get-FMPCredential. .EXAMPLE Get-FMPFinancialStatementGrowth -Symbol AAPL -Period FY -Limit 5 This example retrieves the 5 most recent annual income statement growth records for Apple Inc. .EXAMPLE Get-FMPFinancialStatementGrowth -Symbol MSFT -Period Q1 -Limit 10 This example retrieves the 10 most recent Q1 quarterly balance sheet growth records for Microsoft Corporation. .EXAMPLE Get-FMPFinancialStatementGrowth -Symbol GOOG -Period FY -Limit 3 This example retrieves the 3 most recent annual cash flow statement growth records for Alphabet Inc. .NOTES This function utilizes the Financial Modeling Prep API's Financial Statement Growth endpoints. For more information, visit: https://site.financialmodelingprep.com/developer/docs/stable/financial-statement-growth #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [string] $Symbol, [Parameter(Mandatory = $false)] [ValidateSet("Q1", "Q2", "Q3", "Q4", "FY")] [string] $Period = "FY", [Parameter(Mandatory = $false)] [int] $Limit = 5, [Parameter(Mandatory = $false)] [string] $ApiKey = (Get-FMPCredential) ) Begin { if (-not $ApiKey) { $ApiKey = Read-Host "Please enter your Financial Modeling Prep API key" } $baseUrl = "https://financialmodelingprep.com/stable/financial-growth" } Process { $url = "{0}?symbol={1}&period={2}&limit={3}&apikey={4}" -f $baseUrl, $Symbol, $Period, $Limit, $ApiKey $headers = @{ "Upgrade-Insecure-Requests" = "1" } try { $response = Invoke-RestMethod -Uri $url -Method Get -Headers $headers -ErrorAction Stop return $response } catch { throw "Error retrieving financial statement growth data: $_" } } }; |