feat examples crypto: Add and refine example notebooks #589
Conversation
This file contains hidden or 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
hiohiohio
reviewed
Apr 23, 2025
examples/crypto/README.md
Outdated
|
|
||
| | Notebook | Open in Google Colab | | ||
| |:----------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | ||
| | [BTC/USD Swing Trade](crypto-btc-usd-swing-trade.ipynb) | [](https://colab.research.google.com/github/alpacahq/alpaca-py/blob/master/examples/crypto/crypto-btc-usd-swing-trade.ipynb.ipynb)| |
There was a problem hiding this comment.
typo
Suggested change
| | [BTC/USD Swing Trade](crypto-btc-usd-swing-trade.ipynb) | [](https://colab.research.google.com/github/alpacahq/alpaca-py/blob/master/examples/crypto/crypto-btc-usd-swing-trade.ipynb.ipynb)| | |
| | [BTC/USD Swing Trade](crypto-btc-usd-swing-trade.ipynb) | [](https://colab.research.google.com/github/alpacahq/alpaca-py/blob/master/examples/crypto/crypto-btc-usd-swing-trade.ipynb)| |
| @@ -11,7 +11,7 @@ | |||
| "cell_type": "markdown", | |||
| "metadata": {}, | |||
| "source": [ | |||
| "[](https://colab.research.google.com/github/alpacahq/alpaca-py/blob/master/examples/crypto-trading-basic.ipynb)" | |||
| "[](https://colab.research.google.com/github/alpacahq/alpaca-py/blob/master/examples/crypto/crypto-trading-basic.ipynb)" | |||
There was a problem hiding this comment.
Oh good catch! Could you please also update stocks-trading-basic.ipynb / options-trading-basic.ipynb / options-trading-mleg.ipynb?
Comment on lines
42
to
68
| "import pandas as pd\n", | ||
| "import pandas_ta as ta # The installment of pandas-ta may be tricky. Please find the pypi page here (https://pypi.org/project/pandas-ta/)\n", | ||
| "import numpy as np\n", | ||
| "import matplotlib.pyplot as plt\n", | ||
| "from datetime import datetime, timedelta\n", | ||
| "from zoneinfo import ZoneInfo\n", | ||
| "\n", | ||
| "import alpaca\n", | ||
| "from alpaca.data.timeframe import TimeFrame, TimeFrameUnit\n", | ||
| "from alpaca.data.historical.crypto import CryptoHistoricalDataClient\n", | ||
| "\n", | ||
| "from alpaca.data.requests import (\n", | ||
| " CryptoBarsRequest,\n", | ||
| " CryptoQuoteRequest,\n", | ||
| " CryptoTradesRequest,\n", | ||
| " CryptoLatestQuoteRequest\n", | ||
| " )\n", | ||
| "from alpaca.trading.client import TradingClient\n", | ||
| "from alpaca.trading.requests import MarketOrderRequest, LimitOrderRequest\n", | ||
| "from alpaca.trading.enums import (\n", | ||
| " AssetClass,\n", | ||
| " AssetStatus,\n", | ||
| " OrderSide,\n", | ||
| " OrderType,\n", | ||
| " TimeInForce,\n", | ||
| " QueryOrderStatus\n", | ||
| ")" |
There was a problem hiding this comment.
minor: How about applying isort?
Comment on lines
157
to
158
| "df = bars_date.copy()\n", | ||
| "df.head()" |
There was a problem hiding this comment.
How about adding a comment to explain the reason of using .copy() here?
In my understanding, if we copy here, we do not need to fetch data (i.e. bars_date) again within same session. It might make easy to change and check below codes if user want to tweak.
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "# Define EMA periods\n", |
There was a problem hiding this comment.
How about adding explanation of abbreviation for EMA similar to SMA / ATR / ADX?
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "# Get the latest price of the underlying stock\n", |
There was a problem hiding this comment.
Suggested change
| "# Get the latest price of the underlying stock\n", | |
| "# Get the estimated buying cost of BTC/USD with given qty\n", |
…wing-trade.ipynb' per review
|
Updated the notebooks and README.md per review |
hiohiohio
approved these changes
Apr 24, 2025
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.
Focus review on commit
f454485,9ad7391,anda076992,This pull request adds and refines several example notebooks in the examples/crypto directory: