Home » Ticker Functions » Understanding the ticker.kagi() Function in Pine Script

Understanding the ticker.kagi() Function in Pine Script

Photo of author
Published on

Introduction to Kagi Charts and ticker.kagi()

Kagi charts, known for their distinctive line formation that shifts direction based on specific price changes, offer a unique approach to visualizing market trends. The ticker.kagi() function in Pine Script plays a crucial role in creating these charts. This function generates a ticker ID that can be utilized with request.security() to retrieve Kagi values. While Pine Script™ does not have a built-in function to draw Kagi bars directly, the ticker.kagi() function enables users to access Kagi data and use it for custom charting solutions.

Implementing ticker.kagi() in Pine Script

Let’s dive into an example script using ticker.kagi():

indicator("", "", true)
kagiTickerID = ticker.linebreak(syminfo.tickerid, 3)
kagiTickerClose = request.security(kagiTickerID, timeframe.period, close)

Breakdown of the Code

  1. Version and Indicator Declaration:
    • //@version=5
    • indicator(“”, “”, true)
    • This line sets the script to version 5 of Pine Script and declares an empty indicator with default settings.
  2. Creating the Kagi Ticker ID:
    • kagiTickerID = ticker.linebreak(syminfo.tickerid, 3)
    • Here, kagiTickerID is assigned the value returned by ticker.linebreak(). This function takes two arguments: syminfo.tickerid (the current symbol’s ticker ID) and 3 (the reversal amount for the Kagi chart).
  3. Fetching Kagi Close Values:
    • kagiTickerClose = request.security(kagiTickerID, timeframe.period, close)
    • kagiTickerClose obtains the closing values of the Kagi chart using request.security(), which fetches data from the ticker ID (kagiTickerID) for the current chart’s timeframe.
  4. Plotting the Kagi Close Values:
    • plot(kagiTickerClose)
    • The final line plots the Kagi close values on the chart, visualizing the data fetched by the script.

Key Features and Takeaways

  • Function Usability and Syntax: The ticker.kagi() function, paired with request.security(), allows the retrieval of Kagi values for custom charting purposes.
  • Application: This approach is useful for traders who wish to analyze price movements using Kagi charts, which are not natively supported in Pine Script™.
  • Customization and Flexibility: The script can be customized by changing the reversal amount in ticker.linebreak() or by plotting different aspects of the Kagi data.
  • Technical Understanding: Understanding the underlying mechanism of ticker.kagi() and request.security() is crucial for effective implementation and customization.

In summary, while Pine Script™ does not support direct drawing of Kagi bars, the ticker.kagi() function provides a valuable workaround for accessing and visualizing Kagi chart data. This enhances the analytical capabilities available to Pine Script™ users, allowing for more diverse and sophisticated charting techniques.

Leave a Comment