SMC Toolkit
A simple, fast, and vectorized Python library for Smart Money Concept (SMC) analysis, perfect for local feature extraction, strategy backtesting, and quantitative analysis.
This toolkit is designed for traders and developers who need to programmatically identify SMC structures without relying on third-party charting platforms. Its vectorized nature (powered by Pandas and NumPy) ensures high performance, making it suitable for processing large historical datasets for tasks like training Reinforcement Learning agents.
Features
- Vectorized & Fast: Leverages Pandas and NumPy for efficient calculations.
- Core SMC Concepts: Accurately identifies:
- Swing Highs & Lows
- Break of Structure (BOS)
- Change of Character (CHoCH)
- Order Blocks (OB)
- Fair Value Gaps (FVG)
- Multi-Structure Analysis: Differentiates between primary (main) and internal market structures.
- Built-in Visualization: Includes a ready-to-use Matplotlib function to instantly plot and verify results.
Installation
pip install smc-toolkit
Quickstart
Here is a brief example of how to analyze the NASDAQ index data from Yahoo Finance.
import pandas as pd
import smc_toolkit as smc # alias for easier usage
# === Load sample OHLCV data ===
df = pd.read_csv("assets/data_example.csv", parse_dates=['date'])
df = df.rename(columns=str.lower) # ensure lowercase
df.set_index(['code', 'date'], inplace=True)
# === Step 1: Extract structure including internal swing points ===
structure = df.groupby('code', group_keys=False).apply(
smc.process_smc_with_internal,
swing_size=50, # swing detection window (external)
internal_size=5 # smaller window for internal structure
)
# === Step 2: Extract Order Blocks ===
ob_df = structure.groupby('code').apply(smc.extract_ob_blocks).reset_index(drop=True)
# === Step 3: Extract Fair Value Gaps ===
fvg_df = structure.groupby('code').apply(smc.extract_fvg).reset_index(drop=True)
# === Step 4: Plot results ===
smc.plot_smc_structure(
code='000001.XSHE',
result_df=structure,
ob_df=ob_df,
fvg_df=fvg_df,
show_internal=True
)
Running the code above will generate a plot similar to this:
Output DataFrames
structure DataFrame
This is the main DataFrame with all candles and their calculated SMC attributes.
| Column | Description |
|---|---|
swing_h_l |
1 for a new Swing Low, -1 for a new Swing High. |
bos |
1 for a bullish BOS, -1 for a bearish BOS. |
bos_level |
The price level of the swing point that was broken. |
choch |
2 for a bullish CHoCH, -2 for a bearish CHoCH. |
choch_level |
The price level of the swing point that was broken to cause the CHoCH. |
int_... |
The same columns prefixed with int_ for the internal structure. |
ob_df (Order Blocks) DataFrame
Contains the identified Order Blocks.
| Column | Description |
|---|---|
ob_time |
Timestamp of the candle that forms the Order Block. |
start_time |
Start time of the price leg that led to the CHoCH. |
end_time |
End time of the price leg (timestamp of the CHoCH). |
ob_top |
Top price level of the Order Block. |
ob_bottom |
Bottom price level of the Order Block. |
ob_type |
bullish or bearish. |
fvg_df (Fair Value Gaps) DataFrame
Contains the identified Fair Value Gaps.
| Column | Description |
|---|---|
fvg_type |
bullish or bearish. |
fvg_top |
Top price level of the FVG. |
fvg_bottom |
Bottom price level of the FVG. |
fvg_mid |
Mid-point price of the FVG. |
mitigated |
True if the price has returned to the FVG's mid-point. |
start_time |
Start timestamp of the 3-bar pattern forming the FVG. |
end_time |
End timestamp of the 3-bar pattern. |
Plotting Legend
The plot_smc_structure function uses the following visual cues:
| Element | Marker / Style | Color | Meaning |
|---|---|---|---|
| Swing High | Downward Triangle (v) |
A confirmed primary swing high point. | |
| Swing Low | Upward Triangle (^) |
A confirmed primary swing low point. | |
| Bullish BOS | Dashed Horizontal Line | Break of Structure to the upside. | |
| Bearish BOS | Dashed Horizontal Line | Break of Structure to the downside. | |
| Bullish CHoCH | Solid Horizontal Line | Change of Character to bullish. | |
| Bearish CHoCH | Solid Horizontal Line | Change of Character to bearish. | |
| Bullish Order Block | Shaded Vertical Area | A bullish order block zone. | |
| Bearish Order Block | Shaded Vertical Area | A bearish order block zone. | |
| Bullish FVG | Shaded Vertical Area | A bullish Fair Value Gap. | |
| Bearish FVG | Shaded Vertical Area | A bearish Fair Value Gap. | |
| Mitigated FVG | Hatched Shaded Area | An FVG that has been at least 50% filled. | |
| Internal Structures | Smaller markers / Lighter lines | All of the above for internal structure. |
License
This project is licensed under the MIT License.
Metadata
Release files for smc-toolkit 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| smc-toolkit-0.1.0.tar.gz | 4.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| smc_toolkit-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.0 kB
Release files / smc-toolkit-0.1.0.tar.gz
| Download URL | smc-toolkit-0.1.0.tar.gz |
|---|---|
| Size | 4.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9af7f3b1d66e05ee489565b1726bf02acc41ec2d860e3ab1f8729e4a286e948a
|
|
BLAKE2b-256 checksum How to use checksums |
7b0456df6b0dfc95cb3cca21f27f5ea444dd5eeaa92af4cb1c0941766783e429
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.7.12
|
Release files / smc_toolkit-0.1.0-py3-none-any.whl
| Download URL | smc_toolkit-0.1.0-py3-none-any.whl |
|---|---|
| Size | 4.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
21f5e0ed5876f1889004b1208d53734a9bc0d9ffebe37783f90afc28b0cbed25
|
|
BLAKE2b-256 checksum How to use checksums |
a664e5ca79df2e80e940d8acdd56a5f0b1c8329e6975280b857ab3210abbf884
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.7.12
|