apiverve-cashflowstatement 1.2.2__tar.gz

apiverve_cashflowstatement-1.2.2/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 APIVerve and EvlarSoft LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

apiverve_cashflowstatement-1.2.2/PKG-INFO

@@ -0,0 +1,337 @@
+Metadata-Version: 2.4
+Name: apiverve-cashflowstatement
+Version: 1.2.2
+Summary: Cash Flow Statement returns operating, investing and financing cash flows for a US public company by ticker - straight from SEC filings, with free cash flow, FCF margin and cash-conversion metrics calculated for you.
+Author-email: APIVerve <hello@apiverve.com>
+License: MIT
+Project-URL: Homepage, https://apiverve.com/marketplace/cashflow?utm_source=pypi&utm_medium=referral&utm_content=homepage
+Project-URL: Documentation, https://docs.apiverve.com/ref/cashflow?utm_source=pypi&utm_medium=referral&utm_content=docs
+Project-URL: Repository, https://github.com/apiverve/cashflow-api
+Project-URL: Twitter, https://twitter.com/apivervehq
+Keywords: cash flow api,cash flow statement api,free cash flow api,fcf api,operating cash flow api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Natural Language :: English
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Dynamic: license-file
+
+Cash Flow Statement API
+============
+
+Cash Flow Statement returns operating, investing and financing cash flows for a US public company by ticker - straight from SEC filings, with free cash flow, FCF margin and cash-conversion metrics calculated for you.
+
+
+[![PyPI version](https://img.shields.io/pypi/v/apiverve-cashflowstatement.svg)](https://pypi.org/project/apiverve-cashflowstatement/)
+
+This is a Python wrapper for the [Cash Flow Statement API](https://apiverve.com/marketplace/cashflow?utm_source=pypi&utm_medium=referral&utm_content=readme)
+
+---
+
+## Installation
+
+Using `pip`:
+
+```bash
+pip install apiverve-cashflowstatement
+```
+
+Using `pip3`:
+
+```bash
+pip3 install apiverve-cashflowstatement
+```
+
+---
+
+## Configuration
+
+Before using the Cash Flow Statement API client, you have to setup your account and obtain your API Key.
+You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=referral&utm_content=readme)
+
+---
+
+## Quick Start
+
+Here's a simple example to get you started quickly:
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient
+
+# Initialize the client with your APIVerve API key
+api = CashflowAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+try:
+    # Make the API call
+    result = api.execute(query)
+
+    # Print the result
+    print(result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+---
+
+## Usage
+
+The Cash Flow Statement API documentation is found here: [https://docs.apiverve.com/ref/cashflow](https://docs.apiverve.com/ref/cashflow?utm_source=pypi&utm_medium=referral&utm_content=readme).
+You can find parameters, example responses, and status codes documented here.
+
+### Setup
+
+```python
+# Import the client module
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient
+
+# Initialize the client with your APIVerve API key
+api = CashflowAPIClient("[YOUR_API_KEY]")
+```
+
+---
+
+## Perform Request
+
+Using the API client, you can perform requests to the API.
+
+###### Define Query
+
+```python
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+```
+
+###### Simple Request
+
+```python
+# Make a request to the API
+result = api.execute(query)
+
+# Print the result
+print(result)
+```
+
+###### Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "ticker": "AAPL",
+    "company": "Apple Inc.",
+    "cik": "0000320193",
+    "fiscalYear": 2025,
+    "fiscalQuarter": 4,
+    "filingType": "10-K",
+    "filingDate": "2025-10-31",
+    "periodEnd": "2025-09-27",
+    "cashFlow": {
+      "operatingCashFlow": 111482000000,
+      "capitalExpenditures": 12715000000,
+      "investingCashFlow": 15195000000,
+      "financingCashFlow": -120686000000,
+      "dividendsPaid": 15421000000,
+      "shareRepurchases": 90711000000,
+      "freeCashFlow": 98767000000
+    },
+    "metrics": {
+      "fcfMargin": 23.73,
+      "operatingCashFlowMargin": 26.79,
+      "capexToRevenue": 3.06,
+      "cashFlowToNetIncome": 1,
+      "dividendPayoutRatio": 13.77,
+      "fcfPerShare": 6.5824
+    },
+    "formatted": {
+      "operatingCashFlow": "$111.48B",
+      "freeCashFlow": "$98.77B",
+      "capitalExpenditures": "$12.71B"
+    }
+  }
+}
+```
+
+---
+
+## Error Handling
+
+The API client provides comprehensive error handling through the `CashflowAPIClientError` exception. Here are some examples:
+
+### Basic Error Handling
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient, CashflowAPIClientError
+
+api = CashflowAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+try:
+    result = api.execute(query)
+    print("Success!")
+    print(result)
+except CashflowAPIClientError as e:
+    print(f"API Error: {e.message}")
+    if e.status_code:
+        print(f"Status Code: {e.status_code}")
+    if e.response:
+        print(f"Response: {e.response}")
+```
+
+### Handling Specific Error Types
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient, CashflowAPIClientError
+
+api = CashflowAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+try:
+    result = api.execute(query)
+
+    # Check for successful response
+    if result.get('status') == 'success':
+        print("Request successful!")
+        print(result.get('data'))
+    else:
+        print(f"API returned an error: {result.get('error')}")
+
+except CashflowAPIClientError as e:
+    # Handle API client errors
+    if e.status_code == 401:
+        print("Unauthorized: Invalid API key")
+    elif e.status_code == 429:
+        print("Rate limit exceeded")
+    elif e.status_code >= 500:
+        print("Server error - please try again later")
+    else:
+        print(f"API error: {e.message}")
+except Exception as e:
+    # Handle unexpected errors
+    print(f"Unexpected error: {str(e)}")
+```
+
+### Using Context Manager (Recommended)
+
+The client supports the context manager protocol for automatic resource cleanup:
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient, CashflowAPIClientError
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+# Using context manager ensures proper cleanup
+with CashflowAPIClient("[YOUR_API_KEY]") as api:
+    try:
+        result = api.execute(query)
+        print(result)
+    except CashflowAPIClientError as e:
+        print(f"Error: {e.message}")
+# Session is automatically closed here
+```
+
+---
+
+## Advanced Features
+
+### Debug Mode
+
+Enable debug logging to see detailed request and response information:
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient
+
+# Enable debug mode
+api = CashflowAPIClient("[YOUR_API_KEY]", debug=True)
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+# Debug information will be printed to console
+result = api.execute(query)
+```
+
+### Manual Session Management
+
+If you need to manually manage the session lifecycle:
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient
+
+api = CashflowAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+try:
+    result = api.execute(query)
+    print(result)
+finally:
+    # Manually close the session when done
+    api.close()
+```
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=referral&utm_content=readme).
+
+---
+
+## Updates
+Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
+
+---
+
+## Legal
+
+All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=pypi&utm_medium=referral&utm_content=readme) and all legal documents and agreements.
+
+---
+
+## License
+Licensed under the MIT License (MIT)
+
+Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

apiverve_cashflowstatement-1.2.2/README.md

@@ -0,0 +1,313 @@
+Cash Flow Statement API
+============
+
+Cash Flow Statement returns operating, investing and financing cash flows for a US public company by ticker - straight from SEC filings, with free cash flow, FCF margin and cash-conversion metrics calculated for you.
+
+
+[![PyPI version](https://img.shields.io/pypi/v/apiverve-cashflowstatement.svg)](https://pypi.org/project/apiverve-cashflowstatement/)
+
+This is a Python wrapper for the [Cash Flow Statement API](https://apiverve.com/marketplace/cashflow?utm_source=pypi&utm_medium=referral&utm_content=readme)
+
+---
+
+## Installation
+
+Using `pip`:
+
+```bash
+pip install apiverve-cashflowstatement
+```
+
+Using `pip3`:
+
+```bash
+pip3 install apiverve-cashflowstatement
+```
+
+---
+
+## Configuration
+
+Before using the Cash Flow Statement API client, you have to setup your account and obtain your API Key.
+You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=referral&utm_content=readme)
+
+---
+
+## Quick Start
+
+Here's a simple example to get you started quickly:
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient
+
+# Initialize the client with your APIVerve API key
+api = CashflowAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+try:
+    # Make the API call
+    result = api.execute(query)
+
+    # Print the result
+    print(result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+---
+
+## Usage
+
+The Cash Flow Statement API documentation is found here: [https://docs.apiverve.com/ref/cashflow](https://docs.apiverve.com/ref/cashflow?utm_source=pypi&utm_medium=referral&utm_content=readme).
+You can find parameters, example responses, and status codes documented here.
+
+### Setup
+
+```python
+# Import the client module
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient
+
+# Initialize the client with your APIVerve API key
+api = CashflowAPIClient("[YOUR_API_KEY]")
+```
+
+---
+
+## Perform Request
+
+Using the API client, you can perform requests to the API.
+
+###### Define Query
+
+```python
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+```
+
+###### Simple Request
+
+```python
+# Make a request to the API
+result = api.execute(query)
+
+# Print the result
+print(result)
+```
+
+###### Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "ticker": "AAPL",
+    "company": "Apple Inc.",
+    "cik": "0000320193",
+    "fiscalYear": 2025,
+    "fiscalQuarter": 4,
+    "filingType": "10-K",
+    "filingDate": "2025-10-31",
+    "periodEnd": "2025-09-27",
+    "cashFlow": {
+      "operatingCashFlow": 111482000000,
+      "capitalExpenditures": 12715000000,
+      "investingCashFlow": 15195000000,
+      "financingCashFlow": -120686000000,
+      "dividendsPaid": 15421000000,
+      "shareRepurchases": 90711000000,
+      "freeCashFlow": 98767000000
+    },
+    "metrics": {
+      "fcfMargin": 23.73,
+      "operatingCashFlowMargin": 26.79,
+      "capexToRevenue": 3.06,
+      "cashFlowToNetIncome": 1,
+      "dividendPayoutRatio": 13.77,
+      "fcfPerShare": 6.5824
+    },
+    "formatted": {
+      "operatingCashFlow": "$111.48B",
+      "freeCashFlow": "$98.77B",
+      "capitalExpenditures": "$12.71B"
+    }
+  }
+}
+```
+
+---
+
+## Error Handling
+
+The API client provides comprehensive error handling through the `CashflowAPIClientError` exception. Here are some examples:
+
+### Basic Error Handling
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient, CashflowAPIClientError
+
+api = CashflowAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+try:
+    result = api.execute(query)
+    print("Success!")
+    print(result)
+except CashflowAPIClientError as e:
+    print(f"API Error: {e.message}")
+    if e.status_code:
+        print(f"Status Code: {e.status_code}")
+    if e.response:
+        print(f"Response: {e.response}")
+```
+
+### Handling Specific Error Types
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient, CashflowAPIClientError
+
+api = CashflowAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+try:
+    result = api.execute(query)
+
+    # Check for successful response
+    if result.get('status') == 'success':
+        print("Request successful!")
+        print(result.get('data'))
+    else:
+        print(f"API returned an error: {result.get('error')}")
+
+except CashflowAPIClientError as e:
+    # Handle API client errors
+    if e.status_code == 401:
+        print("Unauthorized: Invalid API key")
+    elif e.status_code == 429:
+        print("Rate limit exceeded")
+    elif e.status_code >= 500:
+        print("Server error - please try again later")
+    else:
+        print(f"API error: {e.message}")
+except Exception as e:
+    # Handle unexpected errors
+    print(f"Unexpected error: {str(e)}")
+```
+
+### Using Context Manager (Recommended)
+
+The client supports the context manager protocol for automatic resource cleanup:
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient, CashflowAPIClientError
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+# Using context manager ensures proper cleanup
+with CashflowAPIClient("[YOUR_API_KEY]") as api:
+    try:
+        result = api.execute(query)
+        print(result)
+    except CashflowAPIClientError as e:
+        print(f"Error: {e.message}")
+# Session is automatically closed here
+```
+
+---
+
+## Advanced Features
+
+### Debug Mode
+
+Enable debug logging to see detailed request and response information:
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient
+
+# Enable debug mode
+api = CashflowAPIClient("[YOUR_API_KEY]", debug=True)
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+# Debug information will be printed to console
+result = api.execute(query)
+```
+
+### Manual Session Management
+
+If you need to manually manage the session lifecycle:
+
+```python
+from apiverve_cashflowstatement.apiClient import CashflowAPIClient
+
+api = CashflowAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "ticker": "AAPL",
+    "year": 0,
+    "quarter": 0
+}
+
+try:
+    result = api.execute(query)
+    print(result)
+finally:
+    # Manually close the session when done
+    api.close()
+```
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=referral&utm_content=readme).
+
+---
+
+## Updates
+Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
+
+---
+
+## Legal
+
+All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=pypi&utm_medium=referral&utm_content=readme) and all legal documents and agreements.
+
+---
+
+## License
+Licensed under the MIT License (MIT)
+
+Copyright (©) 2026 APIVerve, and EvlarSoft LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

apiverve_cashflowstatement-1.2.2/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "apiverve-cashflowstatement"
+version = "1.2.2"
+authors = [
+  { name="APIVerve", email="hello@apiverve.com" },
+]
+description = "Cash Flow Statement returns operating, investing and financing cash flows for a US public company by ticker - straight from SEC filings, with free cash flow, FCF margin and cash-conversion metrics calculated for you."
+keywords = ["cash flow api", "cash flow statement api", "free cash flow api", "fcf api", "operating cash flow api"]
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+dependencies = [
+    "requests>=2.25.0"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Natural Language :: English",
+]
+
+[project.urls]
+Homepage = "https://apiverve.com/marketplace/cashflow?utm_source=pypi&utm_medium=referral&utm_content=homepage"
+Documentation = "https://docs.apiverve.com/ref/cashflow?utm_source=pypi&utm_medium=referral&utm_content=docs"
+Repository = "https://github.com/apiverve/cashflow-api"
+Twitter = "https://twitter.com/apivervehq"

apiverve_cashflowstatement-1.2.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

apiverve_cashflowstatement-1.2.2/src/apiverve_cashflowstatement/__init__.py

@@ -0,0 +1,3 @@
+from .apiClient import CashflowAPIClient, CashflowAPIClientError
+
+__all__ = ['CashflowAPIClient', 'CashflowAPIClientError']