Skip to content

Commit 7eac063

Browse files
TexasCodingTexasCoding
committed
update
1 parent 95c517b commit 7eac063

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

‎.grok/settings.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"model": "grok-4-latest"
3+
}

‎README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848

4949
## Overview
5050

51-
### V2.0.0 is not compatible with previous versions.
51+
### Version 2.x is not compatible with previous versions.
5252
Use the [V1.0.3](https://github.com/TexasCoding/py-alpaca-api/tree/master) branch for the previous version.
5353

5454
The py-alpaca-api project provides a comprehensive Python interface for executing financial trading operations via the Alpaca API. It enables the management of watchlists, account positions, market data, and stock portfolios. It includes functionalities for order processing, stock screening, and predictive analytics leveraging historical data, enhancing market analysis and trading efficiencies. By abstracting complex API interactions into user-friendly Python modules, the project supports streamlined, data-driven trading decisions, making it a valuable tool for both developers and traders aiming for effective financial market engagement.
@@ -91,11 +91,13 @@ This project is mainly for fun and my personal use. Hopefully others find it hel
9191
│ │ ├── model_utils.py
9292
│ │ ├── order_model.py
9393
│ │ ├── position_model.py
94+
│ │ ├── quote_model.py
9495
│ │ └── watchlist_model.py
9596
│ ├── stock
9697
│ │ ├── __init__.py
9798
│ │ ├── assets.py
9899
│ │ ├── history.py
100+
│ │ ├── latest_quote.py
99101
│ │ ├── predictor.py
100102
│ │ └── screener.py
101103
│ └── trading
@@ -156,7 +158,7 @@ This project is mainly for fun and my personal use. Hopefully others find it hel
156158
| [watchlists.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/trading/watchlists.py) | Facilitates complete management of watchlists in the trading module, handling operations such as retrieval, creation, updating, deletion, and manipulation of assets, seamlessly integrating with HTTP requests and watchlist model handling for comprehensive API interaction. Part of a structured trading architecture within the py-alpaca-api repository. |
157159
| [recommendations.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/trading/recommendations.py) | Provide stock recommendations and generate sentiment analysis for given symbols, integrating with external APIs and popular stock data sources like Yahoo Finance. Enhance trading strategy modules in the parent repositorys architecture, supporting informed investment decisions for users. |
158160
| [positions.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/trading/positions.py) | Manage user positions, providing retrieval and organization of Alpaca trading account positions. Enhance data with comprehensive market details, sorting capabilities, and support for tracking cash positions alongside asset positions, ensuring accurate portfolio analysis and streamlined access to current trading statuses. |
159-
| [orders.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/trading/orders.py) | Py-alpaca-api/src/py_alpaca_api/http/requests.py`The `requests.py` file is a critical component within the `py_alpaca_api` package of the repository. This file primarily handles the HTTP requests specific to the Alpaca API, facilitating communication between the user's application and Alpaca's endpoint services. It encapsulates the necessary methods to perform various operations such as querying market data, submitting orders, and retrieving account information. By abstracting and managing these interactions, `requests.py` serves as a foundational module that enables other parts of the repository, such as models and higher-level structures, to function seamlessly without directly managing the complexities of HTTP transactions. Overall, it plays a pivotal role in ensuring that the API communicates effectively and reliably with Alpacas systems, serving as an backbone for the integration functionalities of the entire `py-alpaca-api` repository. |
161+
| [orders.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/trading/orders.py) | Facilitates the creation, retrieval, updating, and deletion of trading orders via the Alpaca API, providing comprehensive order management functionalities including various order types and statuses for effective trading operations. |
160162
| [news.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/trading/news.py) | Retrieves and processes financial news articles related to specific market symbols from sources like Yahoo Finance and Benzinga, integrating them into the trading module to provide real-time, relevant news updates. Enables article scraping, HTML stripping, content truncation, and organized presentation with options to filter by date and content presence. |
161163
| [market.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/trading/market.py) | Facilitates interaction with the market data endpoints. Provides methods to retrieve the current market clock and market calendar within a specified date range, returning structured data. This is essential for ensuring the core trading functionality operates with accurate market timing, enhancing decision-making and automation capabilities. |
162164
| [account.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/trading/account.py) | Manage user account information, activities, and portfolio history within the Alpaca API trading module. Offer seamless data retrieval, including user account details, activity logs filtered by type and date, and detailed portfolio history with configurable periods, timeframes, and intraday reporting, presented in a structured and analyzable format. |
@@ -170,6 +172,7 @@ This project is mainly for fun and my personal use. Hopefully others find it hel
170172
| [screener.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/stock/screener.py) | Streamlines the identification and filtering of stock market gainers and losers based on specific criteria such as price, change, volume, and trade count. Leverages Alpaca Data API to retrieve and evaluate stocks, efficiently categorizing them for further decision-making processes in trading applications. |
171173
| [predictor.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/stock/predictor.py) | Predicts future stock gainers by leveraging historical stock data and the Prophet model for forecasting. Collects data on previous day losers, trains a model, and generates a forecast to identify stocks expected to yield high future returns, aiding in strategic stock trading decisions. |
172174
| [history.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/stock/history.py) | Retrieve and preprocess historical stock data, ensuring the asset is a valid stock before fetching. Offer end-users rich, structured financial data in customizable parameters to aid in stock analysis within the overarching Alpaca API-based trading platform architecture. |
175+
| [latest_quote.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/stock/latest_quote.py) | Retrieves the latest quote data for specified stock symbols from the Alpaca API, including ask and bid prices, sizes, and timestamps, enabling real-time market monitoring. |
173176
| [assets.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/stock/assets.py) | Provide functionality for retrieving asset information from the Alpaca API. Supports fetching individual asset details and obtaining a filtered DataFrame of multiple assets, focusing on active, fractionable, and tradable US equities while excluding specified exchanges. Integrates with asset models to ensure data consistency. |
174177

175178
</details>
@@ -186,6 +189,7 @@ This project is mainly for fun and my personal use. Hopefully others find it hel
186189
| [asset_model.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/models/asset_model.py) | Provide a structured abstraction for financial asset data, utilizing dataclass to define essential asset attributes. Facilitate transformation of data dictionaries to asset model instances, aiding in seamless interaction and manipulation within the broader trading API ecosystem. Boosts integration efficiency with other models and API endpoints. |
187190
| [account_model.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/models/account_model.py) | Define and structure the properties and behavior of account-related data within the context of the API. Enables conversion of dictionary data into AccountModel instances for seamless data management and interaction with Alpaca’s trading platform. |
188191
| [account_activity_model.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/models/account_activity_model.py) | Models account activity data in a structured format, enabling easy conversion from dictionary inputs. Facilitates efficient data encapsulation and retrieval for handling account-related events within the trading application. Integrates with existing model utilities for standardized processing and consistency within the repository’s architecture. |
192+
| [quote_model.py](https://github.com/TexasCoding/py-alpaca-api/blob/master/src/py_alpaca_api/models/quote_model.py) | Defines a data model for stock quotes, encapsulating attributes such as ask price, bid price, and timestamps, with functions to convert dictionary data into QuoteModel instances for structured data handling. |
189193

190194
</details>
191195

@@ -243,7 +247,7 @@ This project is mainly for fun and my personal use. Hopefully others find it hel
243247
> from py_alpaca_api import PyAlpacaAPI
244248
>
245249
> api_key = os.environ.get("ALPACA_API_KEY")
246-
> api_key = os.environ.get("ALPACA_SECRET_KEY")
250+
> api_secret = os.environ.get("ALPACA_SECRET_KEY")
247251
>
248252
> api = PyAlpacaAPI(api_key=api_key, api_secret=api_secret)
249253
>

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "py-alpaca-api"
3-
version = "0.1.0"
3+
version = "2.1.10"
44
description = "Add your description here"
55
readme = "README.md"
66
requires-python = ">=3.10"

0 commit comments

Comments
 (0)