Refactor FinancialDatasetAPI integration and add configuration classes for API setup. #42
+326
−187
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tion classes for API setup.
anhquan075
changed the title
|
Awesome |
| **data, | ||
| "prices": prices, | ||
| "start_date": start_date, | ||
| **data, |
There was a problem hiding this comment.
3.9+ syntax is preferred, i.e. data | { ... }, rather than { **data, ... }
| from .config import FinancialDatasetAPIConfig | ||
|
|
||
|
|
||
| class Period(str, Enum): |
| def _get_headers(self) -> Dict[str, str]: | ||
| return {"X-API-KEY": self.config.api_key} | ||
|
|
||
| def _handle_response(self, response: requests.Response) -> Dict[str, Any]: |
There was a problem hiding this comment.
use dict instead of Dict. I would add a type alias for dict[str, Any] in an appropriate file, since it's used so often (arguably too often)
|
|
||
| return df.sort_index() | ||
|
|
||
| def get_financial_metrics( |
There was a problem hiding this comment.
public methods usually come before private methods
| return response.json() | ||
|
|
||
| @staticmethod | ||
| def prices_to_df(prices: List[Dict[str, Any]]) -> pd.DataFrame: |
| ) | ||
|
|
||
| def get_insider_trades( | ||
| self, ticker: str, end_date: Union[str, datetime], limit: int = 5 |
There was a problem hiding this comment.
instead of Union, use str | datetime
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request focuses on refactoring the codebase to use a new
FinancialDatasetAPIclass for accessing financial data, replacing individual API functions. The changes involve using this new class, removing the old API functions, and implementing a base API client class for better structure and error handling.Refactoring to use
FinancialDatasetAPI:src/agents/market_data.py: Replaced individual API function calls with methods from the newFinancialDatasetAPIclass. Adjusted the import statements accordingly.src/agents/risk_manager.py,src/agents/technicals.py,src/backtester.py: Updated to useFinancialDatasetAPI.prices_to_dffor converting price data to a DataFrame.Removal of old API functions:
src/tools/api.py: Removed all old API functions such asget_financial_metrics,search_line_items,get_insider_trades,get_market_cap,get_prices, andprices_to_df.Implementation of base API client:
src/tools/api/base.py: Made an abstract base classBaseAPIClientto handle common API client functionality such as making requests and handling responses.src/tools/api/config.py: Added configuration classesBaseAPIConfigandFinancialDatasetAPIConfigfor managing API configuration.src/tools/api/financial_dataset.py: Created theFinancialDatasetAPIclass extendingBaseAPIClient, implementing methods for fetching financial metrics, insider trades, market cap, and price data.