Interface Bar


public interface Bar
Represents a historical bar.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the bar size for the bar.
    float
    Gets the close price for the bar.
    long
    Gets the end time for the bar (in milliseconds since 1970).
    float
    Gets the high price for the bar.
    float
    Gets the low price for the bar.
    float
    Gets the open price for the bar
    int
    Gets the open interest for the bar (daily bars only, if available)
    float
    Gets the settlement price for the bar (daily future bars only, if available)
    long
    Gets the start time for the bar (in milliseconds since 1970).
    int
    Gets the number of trades for this bar (if available)
    long
    Gets the volume for the bar (as a long value).
    float
    Gets the volume for the bar as a floating point value
    float
    Gets the volume weighted average price for the bar (if available).
  • Method Details

    • getBarSize

      BarSize getBarSize()
      Gets the bar size for the bar.
      Returns:
      bar size for the bar.
    • getStartTime

      long getStartTime()
      Gets the start time for the bar (in milliseconds since 1970).
      Returns:
      the start time of the bar (in milliseconds since 1970).
    • getEndTime

      long getEndTime()
      Gets the end time for the bar (in milliseconds since 1970).
      Returns:
      the end time of the bar (in milliseconds since 1970).
    • getOpen

      float getOpen()
      Gets the open price for the bar
      Returns:
      open price for the bar
    • getHigh

      float getHigh()
      Gets the high price for the bar.
      Returns:
      high price for the bar.
    • getLow

      float getLow()
      Gets the low price for the bar.
      Returns:
      low price for the bar.
    • getClose

      float getClose()
      Gets the close price for the bar.
      Returns:
      close price for the bar.
    • getVolume

      long getVolume()
      Gets the volume for the bar (as a long value).
      Returns:
      trade volume for the bar (as a long value)
    • getVolumeAsFloat

      float getVolumeAsFloat()
      Gets the volume for the bar as a floating point value
      Returns:
      trade volume for the bar (as a floating point value)
    • getOpenInterest

      int getOpenInterest()
      Gets the open interest for the bar (daily bars only, if available)
      Returns:
      open interest (daily bars only)
    • getSettlement

      float getSettlement()
      Gets the settlement price for the bar (daily future bars only, if available)
      Returns:
      settlement price (daily bars only)
    • getTrades

      int getTrades()
      Gets the number of trades for this bar (if available)
      Returns:
      number of trades for this bar.
    • getVWAP

      float getVWAP()
      Gets the volume weighted average price for the bar (if available).
      Returns:
      volume weighed average price (if available)