Interface Tick


public interface Tick
Represents a tick (trade) that occurred.
  • Method Summary

    Modifier and Type
    Method
    Description
    long
    Gets the aggressor order's exchange order ID for this tick.
    float
    Gets the ask(offer) price when this tick occurred.
    int
    Gets the ask size (number of units offered) when this tick occurred.
    float
    Gets the ask size (number of units offered) when this tick occurred as a floating point value.
    float
    Gets the bid price when this tick occurred.
    int
    Gets the ask size (number of units bid) when this tick occurred.
    float
    Gets the bid size (number of units offered) when this tick occurred as a floating point value.
    long
    Gets the resting order's exchange order ID for this tick.
    float
    Gets the trade price for the tick.
    long
    Gets the time when this tick occurred (in milliseconds since 1970).
    int
    Gets the number of units traded.
    float
    Gets the number of units traded as a floating point value.
    boolean
    Indicates if this trade occurred at the ask price (bid price if false).
  • Method Details

    • getPrice

      float getPrice()
      Gets the trade price for the tick.
      Returns:
      trade price for the tick
    • getVolume

      int getVolume()
      Gets the number of units traded.
      Returns:
      number of units traded
    • getVolumeAsFloat

      float getVolumeAsFloat()
      Gets the number of units traded as a floating point value. This is important for crypto currencies since they can have partial volume values.
      Returns:
      number of units traded as a floating point value
    • getAskPrice

      float getAskPrice()
      Gets the ask(offer) price when this tick occurred.
      Returns:
      ask price when the tick occurred.
    • getAskSize

      int getAskSize()
      Gets the ask size (number of units offered) when this tick occurred.
      Returns:
      ask size when the tick occurred.
    • getAskSizeAsFloat

      float getAskSizeAsFloat()
      Gets the ask size (number of units offered) when this tick occurred as a floating point value. This is important for crypto currencies since they can have partial values.
      Returns:
      ask size (as a floating point value) when this tick occurred.
    • getBidPrice

      float getBidPrice()
      Gets the bid price when this tick occurred.
      Returns:
      bid price when the tick occurred.
    • getBidSize

      int getBidSize()
      Gets the ask size (number of units bid) when this tick occurred.
      Returns:
      bid size when the tick occurred.
    • getBidSizeAsFloat

      float getBidSizeAsFloat()
      Gets the bid size (number of units offered) when this tick occurred as a floating point value. This is important for crypto currencies since they can have partial values.
      Returns:
      bid size (as a floating point value) when this tick occurred.
    • getTime

      long getTime()
      Gets the time when this tick occurred (in milliseconds since 1970).
      Returns:
      the time when this tick occurred (in milliseconds since 1970).
    • isAskTick

      boolean isAskTick()
      Indicates if this trade occurred at the ask price (bid price if false).
      Returns:
      true if this trade occurred at the ask price
    • getExchOrderId

      long getExchOrderId()
      Gets the resting order's exchange order ID for this tick.
    • getAggExchOrderId

      long getAggExchOrderId()
      Gets the aggressor order's exchange order ID for this tick.