Candlestick
Candlestick is a laravel package that helps to analyze various patterns, structures and trends in candlesticks
Features
- Use it with Facade or as a library
- Change various thresholds and multipliers in config/candlestick.php file
- Includes patterns for single candle, dual candles and triple candles
Detectable Patterns
Single Candle Patterns
- DOJI
- MARUBOZU
- CLOSING_MARUBOZU
- OPENING_MARUBOZU
- HAMMER_OR_HANGING_MAN
- INVERTED_HAMMER_OR_SHOOTING_STAR
- DRAGONFLY_DOJI
- GRAVESTONE_DOJI
- SPINNING_TOP
Dual Candle Patterns
- BULLISH_KICKER
- BEARISH_KICKER
- BULLISH_ENGULFING
- BEARISH_ENGULFING
- BULLISH_HARAMI
- BEARISH_HARAMI
- BEARISH_HARAMI
- PIERCING_LINE
- DARK_CLOUD_COVER
- TWEEZER_BOTTOM
- TWEEZER_TOP
Triple Candle Patterns
- MORNING_STAR
- EVENING_STAR
- THREE_WHITE_SOLDIERS
- THREE_BLACK_CROWS
- THREE_OUTSIDE_UP
- THREE_OUTSIDE_DOWN
- THREE_INSIDE_UP
- THREE_INSIDE_DOWN
- DARK_CLOUD_COVER_CONFIRMED
Installing Candlestick
The recommended way to install Candlestick is through Composer.
composer require reccur/candlestick
Laravel without auto-discovery:
If you don’t use auto-discovery, add the ServiceProvider to the providers array in config/app.php
Reccur\Candlestick\CandlestickServiceProvider::class,
If you want to use the facade, add this to your facades in app.php:
'Candlestick' => Reccur\Candlestick\Facades\Candlestick::class,
Config
Copy the package config to your local config with the publish command:
php artisan vendor:publish --provider="Reccur\Candlestick\CandlestickServiceProvider"
You may change the following settings in the published config/candlestick.php file
'MARUBOZU_WICKS_THRESHOLD' => 5,
'HAMMER_SHORTER_WICK_THRESHOLD' => 5,
'HAMMER_LONGER_WICK_MULTIPLIER' => 2.5,
'DOJI_SHORTER_WICK_THRESHOLD' => 2,
'DOJI_WICK_MULTIPLIER' => 15,
'SPINNING_TOP_WICKS_MULTIPLIER' => 5,
'SPINNING_TOP_WICKS_DIFFERENCE_THRESHOLD' => 5,
Usage
Single Candlestick
$candle = Candlestick::single([
'date' => '2022-01-02',
'o' => 300.00,
'h' => 300.00,
'l' => 292.00,
'c' => 292.10,
'volume' => 15623,
]);
$candle->color();
// Output: RED
$candle->pattern();
// Output: OPENING_MARUBOZU
Or use laravel Method Chaining
$pattern = Candlestick::single([
'date' => '2022-01-03',
'o' => 1784.00,
'h' => 1785.00,
'l' => 1750.00,
'c' => 1777.00,
'volume' => 120,
])->pattern();
// Output: HAMMER_OR_HANGING_MAN
Getters
Getter | Method |
---|---|
Date | ->date() |
Open | ->o() |
High | ->h() |
Low | ->l() |
Close | ->c() |
Volume | ->volume() |
Color | ->color() |
Upper Wick (%) | ->upper_wick() |
Body (%) | ->body() |
Lower Wick (%) | ->lower_wick() |
Wicks (%) | ->wicks() |
Pattern | ->pattern() |
Dual Candlesticks
$candle1 = Candlestick::single([
'date' => '2022-01-31',
'o' => 508.00,
'h' => 508.00,
'l' => 491.00,
'c' => 502.00,
'volume' => 25171,
]);
$candle2 = Candlestick::single([
'date' => '2022-02-01',
'o' => 500.00,
'h' => 527.00,
'l' => 491.00,
'c' => 520.00,
'volume' => 75030,
]);
Candlestick::dual($candle1, $candle2)->pattern();
// Output: BULLISH_ENGULFING
Triple Candlesticks
Candlestick::triple($candle1, $candle2, $candle3)->pattern();
// Output: THREE_BLACK_CROWS
License
Candlestick is made available under the MIT License (MIT). Please see License File for more information.