Ichimoku (ta.ichimoku)

View Markdown

Provide conversion, base, and same-index cloud lines; no future extension or lagging line is output.

Indicator catalog · How to use indicators

Run this example

This complete script uses bundled data. It observes the selected output without placing trades.

import numpy as np
from openbacktesting import Backtest, Strategy
from openbacktesting.test import GOOG

data = GOOG.copy()

class Example(Strategy):
    def init(self):
        self.value = self.ta.ichimoku()
        self.latest_value = None

    def next(self):
        channel = self.value.span_a
        if channel.valid[-1]:
            self.latest_value = float(channel[-1])

result = Backtest(data, Example).run()
print(result["_strategy"].latest_value)

Call and parameters

self.ta.ichimoku(*, tenkan=9, kijun=26, senkou=52, inputs=None, backend=None, required_outputs=None)

Register in init(). Read the returned channel in next() after checking valid[-1].

Parameter	Meaning	Type	Default	Allowed values
tenkan	Conversion-line lookback in bars.	int	9	Minimum: 1
kijun	Base-line lookback in bars.	int	26	Minimum: 1
senkou	Long-span lookback; outputs remain on the input index.	int	52	Minimum: 1

source/named source arguments accept a column name or same-run single-channel handle. Alternatively, inputs maps each input below to a column or handle. backend selects a supported implementation; required_outputs selects channels for readiness diagnostics. See shared arguments and handles.

Inputs and outputs

Required inputs: high, low, close.

Channel	Meaning
span_a	Span A on the current input index
span_b	Span B on the current input index
tenkan	Conversion line
kijun	Base line

Reading values safely

Insufficient history or missing inputs can make a channel invalid. Check that channel's valid mask; ready is diagnostic and never suppresses next(). Multi-output results may have different valid channels on the same bar.

Outputs remain on the input index; Chikou and future extension are disabled.

Indicator catalog · Custom calculations