io.coinapi.rest

Class Symbol

java.lang.Object

io.coinapi.rest.Symbol

public class Symbol
extends Object

Stores all the state for a symbol, as described in https://docs.coinapi.io/#list-all-symbols.

This class is multithread safe: it is immutable. In particular, it is always properly constructed, all of its fields are final, and none of their state can be changed after construction. See p. 53 of Java Concurrency In Practice for more discussion.

Constructor Summary

Constructors

Constructor and Description

Symbol(String symbol_id, String exchange_id, String symbol_type, String asset_id_base, String asset_id_quote, String asset_id_unit, String data_start, String data_end, Double volume_1hrs, Double volume_1hrs_usd, Double volume_1day, Double volume_1day_usd, Double volume_1mth, Double volume_1mth_usd, String index_id, String index_display_name, String index_display_description, Instant future_delivery_time, Integer future_contract_unit, String future_contract_unit_asset, Boolean option_type_is_call, Double option_strike_price, Double option_contract_unit, String option_exercise_style, Instant option_expiration_time)

Method Summary

Modifier and Type	Method and Description
String	get_asset_id_base()
String	get_asset_id_quote()
String	get_asset_id_unit()
String	get_data_end()
String	get_data_start()
String	get_exchange_id()
String	get_future_contract_unit_asset()
Integer	get_future_contract_unit()
Instant	get_future_delivery_time()
String	get_index_display_description()
String	get_index_display_name()
String	get_index_id()
Boolean	get_is_option_type_is_call()
Double	get_option_contract_unit()
String	get_option_exercise_style()
Instant	get_option_expiration_time()
Double	get_option_strike_price()
String	get_symbol_id()
String	get_symbol_type()
Double	get_volume_1day_usd()
Double	get_volume_1day()
Double	get_volume_1hrs_usd()
Double	get_volume_1hrs()
Double	get_volume_1mth_usd()
Double	get_volume_1mth()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Symbol

public Symbol(String symbol_id,
              String exchange_id,
              String symbol_type,
              String asset_id_base,
              String asset_id_quote,
              String asset_id_unit,
              String data_start,
              String data_end,
              Double volume_1hrs,
              Double volume_1hrs_usd,
              Double volume_1day,
              Double volume_1day_usd,
              Double volume_1mth,
              Double volume_1mth_usd,
              String index_id,
              String index_display_name,
              String index_display_description,
              Instant future_delivery_time,
              Integer future_contract_unit,
              String future_contract_unit_asset,
              Boolean option_type_is_call,
              Double option_strike_price,
              Double option_contract_unit,
              String option_exercise_style,
              Instant option_expiration_time)

Method Detail

get_symbol_id

public String get_symbol_id()

get_exchange_id

public String get_exchange_id()

get_symbol_type

public String get_symbol_type()

get_asset_id_base

public String get_asset_id_base()

get_asset_id_quote

public String get_asset_id_quote()

get_asset_id_unit

public String get_asset_id_unit()

get_data_start

public String get_data_start()

get_data_end

public String get_data_end()

get_volume_1hrs

public Double get_volume_1hrs()

get_volume_1hrs_usd

public Double get_volume_1hrs_usd()

get_volume_1day

public Double get_volume_1day()

get_volume_1day_usd

public Double get_volume_1day_usd()

get_volume_1mth

public Double get_volume_1mth()

get_volume_1mth_usd

public Double get_volume_1mth_usd()

get_index_id

public String get_index_id()

get_index_display_name

public String get_index_display_name()

get_index_display_description

public String get_index_display_description()

get_future_delivery_time

public Instant get_future_delivery_time()

get_future_contract_unit

public Integer get_future_contract_unit()

get_future_contract_unit_asset

public String get_future_contract_unit_asset()

get_is_option_type_is_call

public Boolean get_is_option_type_is_call()

get_option_strike_price

public Double get_option_strike_price()

get_option_contract_unit

public Double get_option_contract_unit()

get_option_exercise_style

public String get_option_exercise_style()

get_option_expiration_time

public Instant get_option_expiration_time()