Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Candlestick — OHLC Time Series

Signature

sp.candlestick(title, labels, open, high, low, close, *, variant="basic", palette=None, **kwargs) -> Chart

Description

sp.candlestick() is the unified entry point for the entire candlestick-chart family. A candlestick chart shows OHLC (Open, High, Low, Close) bars over time and is the de facto standard for financial markets, crypto, commodities, energy spot prices and any time-series with intra-period spread. The variant keyword switches the visual style without touching the data — including derived views like Heikin-Ashi smoothing, close-only line, mountain area and high-low range bars.

Color convention — by default green = up (close >= open) and red = down. Override with palette=[up_color, down_color]. Bars are rendered left-to-right in input order; use sort_order="asc" to sort by close price.

Variants

Parameters

Returns

Chart — object with .html property and .show() method.


Variant "basic"Aliases basic / default / classic / filledReturns Chart

Classic OHLC candles: solid body, thin wick, green for up bars and red for down bars.

Preview
Variant "hollow"Aliases hollow / empty / japanese / white_upReturns Chart

Japanese-style hollow up candles (white fill + colored stroke) and filled down candles.

Preview
Variant "ohlc"Aliases ohlc / western / bar / tickReturns Chart

Western OHLC bars: vertical wick with left tick = open, right tick = close, no body.

Preview
Variant "heikin"Aliases heikin / heikin_ashi / ha / smoothedReturns Chart

Heikin-Ashi smoothed candles: filters market noise to highlight trends and reversals clearly.

Preview
Variant "outlined"Aliases outlined / outline / stroke / wireframeReturns Chart

Wireframe candles: translucent body with bold colored stroke; lighter visual footprint.

Preview
Variant "line"Aliases line / close / lineplot / trendReturns Chart

Close-price line chart with markers — same data, smoother trend reading without OHLC noise.

Preview
Variant "mountain"Aliases mountain / area / filled_area / shadeReturns Chart

Close-price area chart with vertical gradient under the line; great for hero / cover charts.

Preview
Variant "range"Aliases range / hl / highlow / spreadReturns Chart

High-low range bars only (no open/close), single color — pure volatility visualization.

Preview
Variant "volume"Aliases volume / crypto / with_volume / tradingReturns Chart

Candlestick + volume histogram fusion — the standard crypto/trading terminal layout. Candles fill the upper ~78% of the plot; a volume bar strip (colored by that period's up/down candle) fills the remaining band beneath, sharing the same x-axis. Pass a volume array alongside open/high/low/close.

Preview

Signature

sp.candlestick(title, labels, open, high, low, close, *, variant="basic", palette=None, **kwargs) -> Chart

Description

sp.candlestick() est le point d entree unifie pour toute la famille des chandeliers. Un graphique en chandeliers affiche des barres OHLC (Ouverture, Haut, Bas, Cloture) dans le temps et constitue le standard de fait pour les marches financiers, la crypto, les matieres premieres, le spot energie et toute serie temporelle avec spread intra-periode. Le mot-cle variant change le style sans toucher aux donnees — y compris des vues derivees comme le lissage Heikin-Ashi, la ligne de cloture, l aire mountain et les barres haut-bas.

Convention de couleur — par defaut vert = hausse (close >= open) et rouge = baisse. Surchargez avec palette=[couleur_hausse, couleur_baisse]. Les barres sont rendues de gauche a droite dans l ordre d entree ; sort_order="asc" pour trier par prix de cloture.

Variantes

Paramètres

Retour

Chart — objet avec une propriete .html et une methode .show().


Variant "basic"Aliases basic / default / classic / filledReturns Chart

Bougies OHLC classiques : corps plein, meche fine, vert pour hausse et rouge pour baisse.

Preview
Variant "hollow"Aliases hollow / empty / japanese / white_upReturns Chart

Style japonais : bougies haussieres creuses (fond blanc + contour colore) et baissieres pleines.

Preview
Variant "ohlc"Aliases ohlc / western / bar / tickReturns Chart

Barres OHLC americaines : meche verticale, tick gauche = ouverture, droit = cloture, sans corps.

Preview
Variant "heikin"Aliases heikin / heikin_ashi / ha / smoothedReturns Chart

Bougies Heikin-Ashi lissees : filtre le bruit pour mettre en evidence tendances et retournements.

Preview
Variant "outlined"Aliases outlined / outline / stroke / wireframeReturns Chart

Bougies en fil de fer : corps translucide avec contour colore epais ; rendu plus aere.

Preview
Variant "line"Aliases line / close / lineplot / trendReturns Chart

Ligne des prix de cloture avec marqueurs — meme donnee, lecture de tendance plus lisse.

Preview
Variant "mountain"Aliases mountain / area / filled_area / shadeReturns Chart

Aire des prix de cloture avec degrade vertical sous la courbe ; ideal pour visuel de couverture.

Preview
Variant "range"Aliases range / hl / highlow / spreadReturns Chart

Barres haut-bas uniquement (sans ouverture/cloture), une seule couleur — visualisation de la volatilite.

Preview
Variant "volume"Aliases volume / crypto / with_volume / tradingReturns Chart

Fusion chandelier + histogramme de volume — la mise en page standard des terminaux crypto/trading. Les chandeliers occupent les ~78% superieurs du graphique ; une bande de barres de volume (colorees selon la hausse/baisse de la periode) occupe le reste, partageant le meme axe x. Passez un tableau volume en plus de open/high/low/close.

Apercu