alpaca-py-nopandas 0.1.0__tar.gz

alpaca_py_nopandas-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+         Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+         stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+         that You distribute, all copyright, patent, trademark, and
+         attribution notices from the Source form of the Work,
+         excluding those notices that do not pertain to any part of
+         the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+         distribution, then any Derivative Works that You distribute must
+         include a readable copy of the attribution notices contained
+         within such NOTICE file, excluding those notices that do not
+         pertain to any part of the Derivative Works, in at least one
+         of the following places: within a NOTICE text file distributed
+         as part of the Derivative Works; within the Source form or
+         documentation, if provided along with the Derivative Works; or,
+         within a display generated by the Derivative Works, if and
+         wherever such third-party notices normally appear. The contents
+         of the NOTICE file are for informational purposes only and
+         do not modify the License. You may add Your own attribution
+         notices within Derivative Works that You distribute, alongside
+         or as an addendum to the NOTICE text from the Work, provided
+         that such additional attribution notices cannot be construed
+         as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2022 Alpaca
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

alpaca_py_nopandas-0.1.0/PKG-INFO

@@ -0,0 +1,299 @@
+Metadata-Version: 2.3
+Name: alpaca-py-nopandas
+Version: 0.1.0
+Summary: A forked Python SDK for Alpaca APIs (with Pandas removed)
+License: Apache-2.0
+Author: Will Tesler
+Author-email: willtesler@gmail.com
+Requires-Python: >=3.8.0,<4.0.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: msgpack (>=1.0.3,<2.0.0)
+Requires-Dist: pydantic (>=2.0.3,<3.0.0)
+Requires-Dist: requests (>=2.30.0,<3.0.0)
+Requires-Dist: sseclient-py (>=1.7.2,<2.0.0)
+Requires-Dist: websockets (>=10.4)
+Project-URL: Documentation, https://alpaca.markets/docs/python-sdk/
+Project-URL: Repository, https://github.com/wtesler/alpaca-py-nopandas
+Description-Content-Type: text/markdown
+
+[![Alpaca-py](https://github.com/alpacahq/alpaca-py/blob/master/docs/images/alpaca-py-banner.png?raw=true)](https://alpaca.markets/docs/python-sdk)
+
+[![Downloads](https://pepy.tech/badge/alpaca-py/month)](https://pepy.tech/project/alpaca-py)
+[![Python Versions](https://img.shields.io/pypi/pyversions/alpaca-py.svg?logo=python&logoColor=white)](https://pypi.org/project/alpaca-py)
+[![GitHub](https://img.shields.io/github/license/alpacahq/alpaca-py?color=blue)](https://github.com/alpacahq/alpaca-py/blob/master/LICENSE.md)
+[![PyPI](https://img.shields.io/pypi/v/alpaca-py?color=blue)](https://pypi.org/project/alpaca-py/)
+
+## Table of Contents
+
+- [About](#about)
+- [Documentation](#documentation)
+- [Installation](#installation)
+- [Update](#update)
+- [What's New?](#whats-new)
+  1.  [Broker API](#broker-api-new)
+  2.  [OOP Design](#oop-design)
+  3.  [Data Validation](#data-validation)
+  4.  [Many Clients](#many-clients)
+- [API Keys](#api-keys)
+  1.  [Trading and Market Data API Keys](#trading-api-keys)
+  2.  [Broker API Keys](#trading-api-keys)
+- [Usage](#usage)
+  1.  [Broker API Example](#broker-api-example)
+  2.  [Trading API Example](#trading-api-example)
+  3.  [Market Data API Example](#data-api-example)
+- [Contributing](https://github.com/alpacahq/alpaca-py/blob/master/CONTRIBUTING.md)
+- [License](https://github.com/alpacahq/alpaca-py/blob/master/LICENSE)
+
+## About <a name="about"></a>
+
+Alpaca-py provides an interface for interacting with the API products Alpaca offers. These API products are provided as various REST, WebSocket and SSE endpoints that allow you to do everything from streaming market data to creating your own investment apps.
+
+Learn more about the API products Alpaca offers at https://alpaca.markets.
+
+## Documentation <a name="documentation"></a>
+
+Alpaca-py has a supplementary documentation site which contains references for all clients, methods and models found in this codebase. The documentation
+also contains examples to get started with alpaca-py.
+
+You can find the documentation site here: https://alpaca.markets/sdks/python/getting_started.html
+
+You can also find the API Reference of Alpaca APIs: https://docs.alpaca.markets/reference
+
+## Installation <a name="installation"></a>
+
+Alpaca-py is supported on Python 3.8+.  You can install Alpaca-py using pip.
+
+Run the following command in your terminal.
+
+```shell
+  pip install alpaca-py
+```
+
+## Update <a name="update"></a>
+
+If you already have Alpaca-py installed, and would like to use the latest version available...
+
+Run the following command in your terminal:
+
+```shell
+  pip install alpaca-py --upgrade
+```
+
+## What’s New? <a name="whats-new"></a>
+
+If you’ve used the previous python SDK alpaca-trade-api, there are a few key differences to be aware of.
+
+### Broker API <a name="broker-api-new"></a>
+
+Alpaca-py lets you use Broker API to start building your investment apps! Learn more at the [Broker](https://docs.alpaca.markets/docs/about-broker-api) page.
+
+### OOP Design <a name="oop-design"></a>
+
+Alpaca-py uses a more OOP approach to submitting requests compared to the previous SDK. To submit a request, you will most likely need to create a request object containing the desired request data. Generally, there is a unique request model for each method.
+
+Some examples of request models corresponding to methods:
+
+- `GetOrdersRequest` for `TradingClient.get_orders()`
+- `CryptoLatestOrderbookRequest` for `CryptoHistoricalDataClient.get_crypto_latest_orderbook()`
+
+**Request Models Usage Example**
+
+To get historical bar data for crypto, you will need to provide a `CryptoBarsRequest` object.
+
+```python
+from alpaca.data.historical import CryptoHistoricalDataClient
+from alpaca.data.requests import CryptoBarsRequest
+from alpaca.data.timeframe import TimeFrame
+from datetime import datetime
+
+# no keys required for crypto data
+client = CryptoHistoricalDataClient()
+
+request_params = CryptoBarsRequest(
+                        symbol_or_symbols=["BTC/USD", "ETH/USD"],
+                        timeframe=TimeFrame.Day,
+                        start=datetime(2022, 7, 1)
+                 )
+
+bars = client.get_crypto_bars(request_params)
+```
+
+### Data Validation <a name="data-validation"></a>
+
+Alpaca-py uses _pydantic_ to validate data models at run-time. This means if you are receiving request data via JSON from a client. You can handle parsing and validation through Alpaca’s request models. All request models can be instantiated by passing in data in dictionary format.
+
+Here is a rough example of what is possible.
+
+```python
+
+ @app.route('/post_json', methods=['POST'])
+ def do_trade():
+     # ...
+
+     order_data_json = request.get_json()
+
+     # validate data
+     MarketOrderRequest(**order_data_json)
+
+     # ...
+```
+
+### Many Clients <a name="many-clients"></a>
+
+Alpaca-py has a lot of client classes. There is a client for each API and even asset class specific clients (`StockHistoricalDataClient`, `CryptoDataStream`, `OptionHistoricalDataClient`). This requires you to pick and choose clients based on your needs.
+
+**Broker API:** `BrokerClient`
+
+**Trading API:** `TradingClient`
+
+**Market Data API:** `StockHistoricalDataClient`, `CryptoHistoricalDataClient`, `NewsClient`, `OptionHistoricalDataClient`, `CryptoDataStream`, `StockDataStream`, `NewsDataStream`, `OptionDataStream`
+
+## API Keys <a name="api-keys"></a>
+
+### Trading and Market Data API <a name="trading-api-keys"></a>
+
+In order to use Alpaca’s services you’ll need to sign up for an Alpaca account and retrieve your API keys. Signing up is completely free and takes only a few minutes. Sandbox environments are available to test out the API. To use the sandbox environment, you will need to provide sandbox/paper keys. API keys are passed into Alpaca-py through either `TradingClient`, `StockHistoricalDataClient`, `CryptoHistoricalDataClient`, `NewsClient`, `OptionHistoricalDataClient`, `StockDataStream`, `CryptoDataStream`,`NewsDataStream`, or `OptionDataStream`.
+
+### Broker API <a name="broker-api-keys"></a>
+
+To use the Broker API, you will need to sign up for a broker account and retrieve your Broker API keys. The API keys can be found on the dashboard once you’ve logged in. Alpaca also provides a sandbox environment to test out Broker API. To use the sandbox mode, provide your sandbox keys. Once you have your keys, you can pass them into `BrokerClient` to get started.
+
+## Usage <a name="usage"></a>
+
+Alpaca’s APIs allow you to do everything from building algorithmic trading strategies to building a full brokerage experience for your own end users. Here are some things you can do with Alpaca-py.
+
+To view full descriptions and examples view the [documentation page](https://alpaca.markets/sdks/python/).
+
+**Market Data API**: Access live and historical market data for 5000+ stocks, 20+ crypto, and options.
+
+**Trading API**: Trade stock and crypto with lightning fast execution speeds.
+
+**Broker API & Connect**: Build investment apps - from robo-advisors to brokerages.
+
+### Broker API Example <a name="broker-api-example"></a>
+
+**Listing All Accounts**
+
+The `BrokerClient.list_accounts` method allows you to list all the brokerage accounts under your management. The method takes an optional parameter `search_parameters` which requires a `ListAccountsRequest` object. This parameter allows you to filter the list of accounts returned.
+
+```python
+from alpaca.broker.client import BrokerClient
+from alpaca.broker.requests import ListAccountsRequest
+from alpaca.broker.enums import AccountEntities
+
+broker_client = BrokerClient('api-key', 'secret-key')
+
+# search for accounts created after January 30th 2022.
+# Response should contain Contact and Identity fields for each account.
+filter = ListAccountsRequest(
+                    created_after=datetime.datetime.strptime("2022-01-30", "%Y-%m-%d"),
+                    entities=[AccountEntities.CONTACT, AccountEntities.IDENTITY]
+                    )
+
+accounts = broker_client.list_accounts(search_parameters=filter)
+```
+
+### Trading API Example <a name="trading-api-example"></a>
+
+**Submitting an Order**
+
+To create an order on Alpaca-py you must use an `OrderRequest` object. There are different `OrderRequest` objects based on the type of order you want to make. For market orders, there is `MarketOrderRequest`, limit orders have `LimitOrderRequest`, stop orders `StopOrderRequest`, and trailing stop orders have `TrailingStopOrderRequest`. Each order type have their own required parameters for a successful order.
+
+```python
+from alpaca.trading.client import TradingClient
+from alpaca.trading.requests import MarketOrderRequest
+from alpaca.trading.enums import OrderSide, TimeInForce
+
+trading_client = TradingClient('api-key', 'secret-key')
+
+
+# preparing order data
+market_order_data = MarketOrderRequest(
+                      symbol="BTC/USD",
+                      qty=0.0001,
+                      side=OrderSide.BUY,
+                      time_in_force=TimeInForce.DAY
+                  )
+
+# Market order
+market_order = trading_client.submit_order(
+                order_data=market_order_data
+                )
+```
+
+### Market Data API Example <a name="data-api-example"></a>
+
+**Querying Historical Bar Data**
+
+You can request bar data via the HistoricalDataClients. In this example, we query daily bar data for “BTC/USD” and “ETH/USD” since July 1st 2022. You can convert the response to a multi-index pandas dataframe using the `.df` property. There are `StockHistoricalDataClient` and `OptionHistoricalDataClient` that you also could use to fetch equity/options historical data.
+
+```python
+from alpaca.data.historical import CryptoHistoricalDataClient
+from alpaca.data.requests import CryptoBarsRequest
+from alpaca.data.timeframe import TimeFrame
+from datetime import datetime
+
+# no keys required for crypto data
+client = CryptoHistoricalDataClient()
+
+request_params = CryptoBarsRequest(
+                        symbol_or_symbols=["BTC/USD", "ETH/USD"],
+                        timeframe=TimeFrame.Day,
+                        start=datetime.strptime("2022-07-01", '%Y-%m-%d')
+                        )
+
+bars = client.get_crypto_bars(request_params)
+
+# convert to dataframe
+bars.df
+
+```
+
+**Querying News Data** <a name="news-client-example"></a>
+
+You can query news data via the NewsClient. In this example, we query news data for “TSLA” since July 1st 2022. You can convert the response to a pandas dataframe using the `.df` property.
+
+```python
+from alpaca.data.historical.news import NewsClient
+from alpaca.data.requests import NewsRequest
+from datetime import datetime
+
+# no keys required for news data
+client = NewsClient()
+
+request_params = NewsRequest(
+                        symbols="TSLA",
+                        start=datetime.strptime("2022-07-01", '%Y-%m-%d')
+                        )
+
+news = client.get_news(request_params)
+
+# convert to dataframe
+news.df
+
+```
+
+### Options Trading <a name="options-trading"></a>
+
+We're excited to support options trading! Use this section to read up on Alpaca's options trading capabilities.
+For more details, please refer to [our documentation page for options trading](https://docs.alpaca.markets/docs/options-trading)
+
+There is an example jupyter notebook to explain methods of alpaca-py for options trading.
+
+* [jupyter notebook: options trading basic example with alpaca-py](https://github.com/alpacahq/alpaca-py/blob/master/examples/options/options-trading-basic.ipynb)
+
+### Jupyter Notebook Library <a name="colab-library"></a>
+
+Explore examples for stocks, options, and crypto using alpaca-py. Notebooks for each asset class are provided in their respective directories!
+
+* [Stocks](https://github.com/alpacahq/alpaca-py/blob/master/examples/stocks/README.md)
+* [Crypto](https://github.com/alpacahq/alpaca-py/blob/master/examples/crypto/README.md)
+* [Options](https://github.com/alpacahq/alpaca-py/blob/master/examples/options/README.md)
+* [Multi-Leg Options](https://github.com/alpacahq/alpaca-py/blob/master/examples/options/README.md)