Class: Intrinio::ETF

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/models/etf.rb

Overview

Exchange Traded Fund (ETF) including extensive metadata

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ETF

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
# File 'lib/intrinio-sdk/models/etf.rb', line 628

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'ticker')
    self.ticker = attributes[:'ticker']
  end

  if attributes.has_key?(:'figi_ticker')
    self.figi_ticker = attributes[:'figi_ticker']
  end

  if attributes.has_key?(:'ric')
    self.ric = attributes[:'ric']
  end

  if attributes.has_key?(:'isin')
    self.isin = attributes[:'isin']
  end

  if attributes.has_key?(:'sedol')
    self.sedol = attributes[:'sedol']
  end

  if attributes.has_key?(:'exchange_mic')
    self.exchange_mic = attributes[:'exchange_mic']
  end

  if attributes.has_key?(:'sponsor')
    self.sponsor = attributes[:'sponsor']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'inception_date')
    self.inception_date = attributes[:'inception_date']
  end

  if attributes.has_key?(:'data_change_date')
    self.data_change_date = attributes[:'data_change_date']
  end

  if attributes.has_key?(:'close_date')
    self.close_date = attributes[:'close_date']
  end

  if attributes.has_key?(:'is_live_listed')
    self.is_live_listed = attributes[:'is_live_listed']
  end

  if attributes.has_key?(:'legal_structure')
    self.legal_structure = attributes[:'legal_structure']
  end

  if attributes.has_key?(:'intraday_nav_ticker')
    self.intraday_nav_ticker = attributes[:'intraday_nav_ticker']
  end

  if attributes.has_key?(:'primary_ticker')
    self.primary_ticker = attributes[:'primary_ticker']
  end

  if attributes.has_key?(:'primary_ticker_country_code')
    self.primary_ticker_country_code = attributes[:'primary_ticker_country_code']
  end

  if attributes.has_key?(:'primary_listing_region')
    self.primary_listing_region = attributes[:'primary_listing_region']
  end

  if attributes.has_key?(:'net_expense_ratio')
    self.net_expense_ratio = attributes[:'net_expense_ratio']
  end

  if attributes.has_key?(:'asset_class')
    self.asset_class = attributes[:'asset_class']
  end

  if attributes.has_key?(:'other_asset_types')
    self.other_asset_types = attributes[:'other_asset_types']
  end

  if attributes.has_key?(:'market_cap_range')
    self.market_cap_range = attributes[:'market_cap_range']
  end

  if attributes.has_key?(:'holds_only_nyse_stocks')
    self.holds_only_nyse_stocks = attributes[:'holds_only_nyse_stocks']
  end

  if attributes.has_key?(:'holds_only_nasdaq_stocks')
    self.holds_only_nasdaq_stocks = attributes[:'holds_only_nasdaq_stocks']
  end

  if attributes.has_key?(:'growth_value_tilt')
    self.growth_value_tilt = attributes[:'growth_value_tilt']
  end

  if attributes.has_key?(:'growth_type')
    self.growth_type = attributes[:'growth_type']
  end

  if attributes.has_key?(:'value_type')
    self.value_type = attributes[:'value_type']
  end

  if attributes.has_key?(:'sector')
    self.sector = attributes[:'sector']
  end

  if attributes.has_key?(:'industry')
    self.industry = attributes[:'industry']
  end

  if attributes.has_key?(:'sub_industry')
    self.sub_industry = attributes[:'sub_industry']
  end

  if attributes.has_key?(:'cross_sector_theme')
    self.cross_sector_theme = attributes[:'cross_sector_theme']
  end

  if attributes.has_key?(:'natural_resources_type')
    self.natural_resources_type = attributes[:'natural_resources_type']
  end

  if attributes.has_key?(:'excludes_financials')
    self.excludes_financials = attributes[:'excludes_financials']
  end

  if attributes.has_key?(:'excludes_technology')
    self.excludes_technology = attributes[:'excludes_technology']
  end

  if attributes.has_key?(:'us_or_excludes_us')
    self.us_or_excludes_us = attributes[:'us_or_excludes_us']
  end

  if attributes.has_key?(:'developed_emerging')
    self.developed_emerging = attributes[:'developed_emerging']
  end

  if attributes.has_key?(:'specialized_region')
    self.specialized_region = attributes[:'specialized_region']
  end

  if attributes.has_key?(:'continent')
    self.continent = attributes[:'continent']
  end

  if attributes.has_key?(:'latin_america_sub_group')
    self.latin_america_sub_group = attributes[:'latin_america_sub_group']
  end

  if attributes.has_key?(:'europe_sub_group')
    self.europe_sub_group = attributes[:'europe_sub_group']
  end

  if attributes.has_key?(:'asia_sub_group')
    self.asia_sub_group = attributes[:'asia_sub_group']
  end

  if attributes.has_key?(:'specific_country')
    self.specific_country = attributes[:'specific_country']
  end

  if attributes.has_key?(:'china_listing_location')
    self.china_listing_location = attributes[:'china_listing_location']
  end

  if attributes.has_key?(:'us_state')
    self.us_state = attributes[:'us_state']
  end

  if attributes.has_key?(:'real_estate')
    self.real_estate = attributes[:'real_estate']
  end

  if attributes.has_key?(:'index_weighting_scheme')
    self.index_weighting_scheme = attributes[:'index_weighting_scheme']
  end

  if attributes.has_key?(:'market_cap_weighting_type')
    self.market_cap_weighting_type = attributes[:'market_cap_weighting_type']
  end

  if attributes.has_key?(:'fundamental_weighting_type')
    self.fundamental_weighting_type = attributes[:'fundamental_weighting_type']
  end

  if attributes.has_key?(:'dividend_weighting_type')
    self.dividend_weighting_type = attributes[:'dividend_weighting_type']
  end

  if attributes.has_key?(:'bond_type')
    self.bond_type = attributes[:'bond_type']
  end

  if attributes.has_key?(:'government_bond_types')
    self.government_bond_types = attributes[:'government_bond_types']
  end

  if attributes.has_key?(:'municipal_bond_region')
    self.municipal_bond_region = attributes[:'municipal_bond_region']
  end

  if attributes.has_key?(:'municipal_vrdo')
    self.municipal_vrdo = attributes[:'municipal_vrdo']
  end

  if attributes.has_key?(:'mortgage_bond_types')
    self.mortgage_bond_types = attributes[:'mortgage_bond_types']
  end

  if attributes.has_key?(:'bond_tax_status')
    self.bond_tax_status = attributes[:'bond_tax_status']
  end

  if attributes.has_key?(:'credit_quality')
    self.credit_quality = attributes[:'credit_quality']
  end

  if attributes.has_key?(:'average_maturity')
    self.average_maturity = attributes[:'average_maturity']
  end

  if attributes.has_key?(:'specific_maturity_year')
    self.specific_maturity_year = attributes[:'specific_maturity_year']
  end

  if attributes.has_key?(:'bond_currency_denomination')
    self.bond_currency_denomination = attributes[:'bond_currency_denomination']
  end

  if attributes.has_key?(:'laddered')
    self.laddered = attributes[:'laddered']
  end

  if attributes.has_key?(:'zero_coupon')
    self.zero_coupon = attributes[:'zero_coupon']
  end

  if attributes.has_key?(:'floating_rate')
    self.floating_rate = attributes[:'floating_rate']
  end

  if attributes.has_key?(:'build_america_bonds')
    self.build_america_bonds = attributes[:'build_america_bonds']
  end

  if attributes.has_key?(:'commodity_types')
    self.commodity_types = attributes[:'commodity_types']
  end

  if attributes.has_key?(:'energy_type')
    self.energy_type = attributes[:'energy_type']
  end

  if attributes.has_key?(:'agricultural_type')
    self.agricultural_type = attributes[:'agricultural_type']
  end

  if attributes.has_key?(:'metal_type')
    self.metal_type = attributes[:'metal_type']
  end

  if attributes.has_key?(:'inverse_leveraged')
    self.inverse_leveraged = attributes[:'inverse_leveraged']
  end

  if attributes.has_key?(:'target_date_multi_asset_type')
    self.target_date_multi_asset_type = attributes[:'target_date_multi_asset_type']
  end

  if attributes.has_key?(:'currency_hedged')
    self.currency_hedged = attributes[:'currency_hedged']
  end

  if attributes.has_key?(:'currency_pair')
    self.currency_pair = attributes[:'currency_pair']
  end

  if attributes.has_key?(:'social_environmental_type')
    self.social_environmental_type = attributes[:'social_environmental_type']
  end

  if attributes.has_key?(:'clean_energy_type')
    self.clean_energy_type = attributes[:'clean_energy_type']
  end

  if attributes.has_key?(:'dividend_type')
    self.dividend_type = attributes[:'dividend_type']
  end

  if attributes.has_key?(:'regular_dividend_payor_type')
    self.regular_dividend_payor_type = attributes[:'regular_dividend_payor_type']
  end

  if attributes.has_key?(:'holds_ml_ps')
    self.holds_ml_ps = attributes[:'holds_ml_ps']
  end

  if attributes.has_key?(:'holds_preferred_stock')
    self.holds_preferred_stock = attributes[:'holds_preferred_stock']
  end

  if attributes.has_key?(:'holds_closed_end_funds')
    self.holds_closed_end_funds = attributes[:'holds_closed_end_funds']
  end

  if attributes.has_key?(:'quant_strategies_type')
    self.quant_strategies_type = attributes[:'quant_strategies_type']
  end

  if attributes.has_key?(:'other_quant_models')
    self.other_quant_models = attributes[:'other_quant_models']
  end

  if attributes.has_key?(:'hedge_fund_type')
    self.hedge_fund_type = attributes[:'hedge_fund_type']
  end

  if attributes.has_key?(:'derivatives_based')
    self.derivatives_based = attributes[:'derivatives_based']
  end

  if attributes.has_key?(:'holds_ad_rs')
    self.holds_ad_rs = attributes[:'holds_ad_rs']
  end

  if attributes.has_key?(:'index_linked')
    self.index_linked = attributes[:'index_linked']
  end

  if attributes.has_key?(:'includes_short_exposure')
    self.includes_short_exposure = attributes[:'includes_short_exposure']
  end

  if attributes.has_key?(:'index_name')
    self.index_name = attributes[:'index_name']
  end

  if attributes.has_key?(:'parent_index')
    self.parent_index = attributes[:'parent_index']
  end

  if attributes.has_key?(:'index_family')
    self.index_family = attributes[:'index_family']
  end

  if attributes.has_key?(:'broader_index_family')
    self.broader_index_family = attributes[:'broader_index_family']
  end

  if attributes.has_key?(:'index_provider')
    self.index_provider = attributes[:'index_provider']
  end

  if attributes.has_key?(:'fund_family')
    self.fund_family = attributes[:'fund_family']
  end

  if attributes.has_key?(:'index_ticker')
    self.index_ticker = attributes[:'index_ticker']
  end

  if attributes.has_key?(:'etn_issuing_bank')
    self.etn_issuing_bank = attributes[:'etn_issuing_bank']
  end

  if attributes.has_key?(:'etn_maturity_date')
    self.etn_maturity_date = attributes[:'etn_maturity_date']
  end

  if attributes.has_key?(:'livestock')
    self.livestock = attributes[:'livestock']
  end

  if attributes.has_key?(:'dynamic_futures_roll')
    self.dynamic_futures_roll = attributes[:'dynamic_futures_roll']
  end

  if attributes.has_key?(:'index_provider_code')
    self.index_provider_code = attributes[:'index_provider_code']
  end

  if attributes.has_key?(:'single_category_designation')
    self.single_category_designation = attributes[:'single_category_designation']
  end

  if attributes.has_key?(:'registered_countries')
    self.registered_countries = attributes[:'registered_countries']
  end

  if attributes.has_key?(:'issuing_entity_country_code')
    self.issuing_entity_country_code = attributes[:'issuing_entity_country_code']
  end

  if attributes.has_key?(:'ucits')
    self.ucits = attributes[:'ucits']
  end

  if attributes.has_key?(:'replication_structure')
    self.replication_structure = attributes[:'replication_structure']
  end

  if attributes.has_key?(:'domicile')
    self.domicile = attributes[:'domicile']
  end

  if attributes.has_key?(:'base_currency')
    self.base_currency = attributes[:'base_currency']
  end

  if attributes.has_key?(:'listing_currency')
    self.listing_currency = attributes[:'listing_currency']
  end

  if attributes.has_key?(:'fund_listing_date')
    self.fund_listing_date = attributes[:'fund_listing_date']
  end

  if attributes.has_key?(:'listing_country_code')
    self.listing_country_code = attributes[:'listing_country_code']
  end

  if attributes.has_key?(:'listing_region')
    self.listing_region = attributes[:'listing_region']
  end

  if attributes.has_key?(:'smartvs_traditional_beta')
    self.smartvs_traditional_beta = attributes[:'smartvs_traditional_beta']
  end

  if attributes.has_key?(:'smartvs_traditional_beta_level2')
    self.smartvs_traditional_beta_level2 = attributes[:'smartvs_traditional_beta_level2']
  end

  if attributes.has_key?(:'income_category')
    self.income_category = attributes[:'income_category']
  end

  if attributes.has_key?(:'etp_structure_type')
    self.etp_structure_type = attributes[:'etp_structure_type']
  end

  if attributes.has_key?(:'month_end_assets')
    self.month_end_assets = attributes[:'month_end_assets']
  end

  if attributes.has_key?(:'etf_portfolio_turnover')
    self.etf_portfolio_turnover = attributes[:'etf_portfolio_turnover']
  end

  if attributes.has_key?(:'firstbridge_id')
    self.firstbridge_id = attributes[:'firstbridge_id']
  end

  if attributes.has_key?(:'firstbridge_parent_id')
    self.firstbridge_parent_id = attributes[:'firstbridge_parent_id']
  end

  if attributes.has_key?(:'number_of_holdings')
    self.number_of_holdings = attributes[:'number_of_holdings']
  end

end

Instance Attribute Details

#agricultural_typeObject

For ETFs where ‘commodity_type’ is ‘Agricultural’, this field provides detail on the type of agricultural exposure provided by the ETF



220
221
222
# File 'lib/intrinio-sdk/models/etf.rb', line 220

def agricultural_type
  @agricultural_type
end

#asia_sub_groupObject

For ETFs that are classified as ‘Asia’ in the ‘continent’ field, this field provides further detail on the type of regional exposure



145
146
147
# File 'lib/intrinio-sdk/models/etf.rb', line 145

def asia_sub_group
  @asia_sub_group
end

#asset_classObject

Captures the underlying nature of the securities in the Exchanged Traded Product (ETP)



82
83
84
# File 'lib/intrinio-sdk/models/etf.rb', line 82

def asset_class
  @asset_class
end

#average_maturityObject

For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range



193
194
195
# File 'lib/intrinio-sdk/models/etf.rb', line 193

def average_maturity
  @average_maturity
end

#base_currencyObject

Base currency of the Exchange Traded Product (ETP) in which the net asset value (NAV) is calculated. Reported using the 3-digit ISO currency code



334
335
336
# File 'lib/intrinio-sdk/models/etf.rb', line 334

def base_currency
  @base_currency
end

#bond_currency_denominationObject

For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities



199
200
201
# File 'lib/intrinio-sdk/models/etf.rb', line 199

def bond_currency_denomination
  @bond_currency_denomination
end

#bond_tax_statusObject

For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities



187
188
189
# File 'lib/intrinio-sdk/models/etf.rb', line 187

def bond_tax_status
  @bond_tax_status
end

#bond_typeObject

For ETFs where ‘asset_class_type’ is ‘Bonds’, this field provides detail on the type of bonds held in the ETF



172
173
174
# File 'lib/intrinio-sdk/models/etf.rb', line 172

def bond_type
  @bond_type
end

#broader_index_familyObject

This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider



289
290
291
# File 'lib/intrinio-sdk/models/etf.rb', line 289

def broader_index_family
  @broader_index_family
end

#build_america_bondsObject

For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds



211
212
213
# File 'lib/intrinio-sdk/models/etf.rb', line 211

def build_america_bonds
  @build_america_bonds
end

#china_listing_locationObject

For ETFs that are classified as ‘China’ in the ‘country’ field, this field provides further detail on the type of exposure in the underlying securities



151
152
153
# File 'lib/intrinio-sdk/models/etf.rb', line 151

def china_listing_location
  @china_listing_location
end

#clean_energy_typeObject

This field is populated if the ETF has a value of ‘Clean Energy’ in the ‘social_environmental_type’ field.



241
242
243
# File 'lib/intrinio-sdk/models/etf.rb', line 241

def clean_energy_type
  @clean_energy_type
end

#close_dateObject

The date on which this ETF was de-listed if it is no longer listed



58
59
60
# File 'lib/intrinio-sdk/models/etf.rb', line 58

def close_date
  @close_date
end

#commodity_typesObject

For ETFs where ‘asset_class_type’ is ‘Commodities’, this field provides detail on the type of commodities held in the ETF



214
215
216
# File 'lib/intrinio-sdk/models/etf.rb', line 214

def commodity_types
  @commodity_types
end

#continentObject

This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent



136
137
138
# File 'lib/intrinio-sdk/models/etf.rb', line 136

def continent
  @continent
end

#credit_qualityObject

For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range



190
191
192
# File 'lib/intrinio-sdk/models/etf.rb', line 190

def credit_quality
  @credit_quality
end

#cross_sector_themeObject

For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples (‘Agri-business’, ‘Natural Resources’, ‘Green Investing’, etc.)



115
116
117
# File 'lib/intrinio-sdk/models/etf.rb', line 115

def cross_sector_theme
  @cross_sector_theme
end

#currency_hedgedObject

This field is populated if the ETF’s strategy involves hedging currency exposure



232
233
234
# File 'lib/intrinio-sdk/models/etf.rb', line 232

def currency_hedged
  @currency_hedged
end

#currency_pairObject

This field is populated if the ETF’s strategy involves providing exposure to the movements of a currency or involves hedging currency exposure



235
236
237
# File 'lib/intrinio-sdk/models/etf.rb', line 235

def currency_pair
  @currency_pair
end

#data_change_dateObject

The last date on which there was a change in a classifications data field for this ETF



55
56
57
# File 'lib/intrinio-sdk/models/etf.rb', line 55

def data_change_date
  @data_change_date
end

#derivatives_basedObject

This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio



268
269
270
# File 'lib/intrinio-sdk/models/etf.rb', line 268

def derivatives_based
  @derivatives_based
end

#descriptionObject

The ETF description as published by the ETF sponsor



49
50
51
# File 'lib/intrinio-sdk/models/etf.rb', line 49

def description
  @description
end

#developed_emergingObject

This field identifies the stage of development of the markets that the ETF provides exposure to



130
131
132
# File 'lib/intrinio-sdk/models/etf.rb', line 130

def developed_emerging
  @developed_emerging
end

#dividend_typeObject

This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus



244
245
246
# File 'lib/intrinio-sdk/models/etf.rb', line 244

def dividend_type
  @dividend_type
end

#dividend_weighting_typeObject

For ETFs that take the value ‘Dividend Weighted’ in the ‘index_weighting_scheme’ field, this field provides detail on the dividend weighting methodology



169
170
171
# File 'lib/intrinio-sdk/models/etf.rb', line 169

def dividend_weighting_type
  @dividend_weighting_type
end

#domicileObject

2 letter ISO country code for the country where the ETP is domiciled



331
332
333
# File 'lib/intrinio-sdk/models/etf.rb', line 331

def domicile
  @domicile
end

#dynamic_futures_rollObject

If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs



310
311
312
# File 'lib/intrinio-sdk/models/etf.rb', line 310

def dynamic_futures_roll
  @dynamic_futures_roll
end

#energy_typeObject

For ETFs where ‘commodity_type’ is ‘Energy’, this field provides detail on the type of energy exposure provided by the ETF



217
218
219
# File 'lib/intrinio-sdk/models/etf.rb', line 217

def energy_type
  @energy_type
end

#etf_portfolio_turnoverObject

The percentage of positions turned over in the last 12 months



364
365
366
# File 'lib/intrinio-sdk/models/etf.rb', line 364

def etf_portfolio_turnover
  @etf_portfolio_turnover
end

#etn_issuing_bankObject

If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank



301
302
303
# File 'lib/intrinio-sdk/models/etf.rb', line 301

def etn_issuing_bank
  @etn_issuing_bank
end

#etn_maturity_dateObject

If the product is an ETN, this field identifies the maturity date for the ETN



304
305
306
# File 'lib/intrinio-sdk/models/etf.rb', line 304

def etn_maturity_date
  @etn_maturity_date
end

#etp_structure_typeObject

Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure



358
359
360
# File 'lib/intrinio-sdk/models/etf.rb', line 358

def etp_structure_type
  @etp_structure_type
end

#europe_sub_groupObject

For ETFs that are classified as ‘Europe’ in the ‘continent’ field, this field provides further detail on the type of regional exposure



142
143
144
# File 'lib/intrinio-sdk/models/etf.rb', line 142

def europe_sub_group
  @europe_sub_group
end

#exchange_micObject

The exchange Market Identifier Code (MIC) from the International Standards Organization (ISO)



40
41
42
# File 'lib/intrinio-sdk/models/etf.rb', line 40

def exchange_mic
  @exchange_mic
end

#excludes_financialsObject

For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective



121
122
123
# File 'lib/intrinio-sdk/models/etf.rb', line 121

def excludes_financials
  @excludes_financials
end

#excludes_technologyObject

For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective



124
125
126
# File 'lib/intrinio-sdk/models/etf.rb', line 124

def excludes_technology
  @excludes_technology
end

#figi_tickerObject

The OpenFIGI ticker for the ETF



28
29
30
# File 'lib/intrinio-sdk/models/etf.rb', line 28

def figi_ticker
  @figi_ticker
end

#firstbridge_idObject

The FirstBridge unique identifier for the Exchange Traded Fund (ETF)



367
368
369
# File 'lib/intrinio-sdk/models/etf.rb', line 367

def firstbridge_id
  @firstbridge_id
end

#firstbridge_parent_idObject

The FirstBridge unique identifier of the parent Exchange Traded Fund (ETF), if applicable



370
371
372
# File 'lib/intrinio-sdk/models/etf.rb', line 370

def firstbridge_parent_id
  @firstbridge_parent_id
end

#floating_rateObject

For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds



208
209
210
# File 'lib/intrinio-sdk/models/etf.rb', line 208

def floating_rate
  @floating_rate
end

#fund_familyObject

This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor



295
296
297
# File 'lib/intrinio-sdk/models/etf.rb', line 295

def fund_family
  @fund_family
end

#fund_listing_dateObject

The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange



340
341
342
# File 'lib/intrinio-sdk/models/etf.rb', line 340

def fund_listing_date
  @fund_listing_date
end

#fundamental_weighting_typeObject

For ETFs that take the value ‘Fundamental Weighted’ in the ‘index_weighting_scheme’ field, this field provides detail on the fundamental weighting methodology



166
167
168
# File 'lib/intrinio-sdk/models/etf.rb', line 166

def fundamental_weighting_type
  @fundamental_weighting_type
end

#government_bond_typesObject

For bond ETFs that take the value ‘Treasury & Government’ in ‘bond_type’, this field provides detail on the exposure



175
176
177
# File 'lib/intrinio-sdk/models/etf.rb', line 175

def government_bond_types
  @government_bond_types
end

#growth_typeObject

For ETFs that are classified as ‘Growth’ in ‘growth_value_tilt’, this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores



100
101
102
# File 'lib/intrinio-sdk/models/etf.rb', line 100

def growth_type
  @growth_type
end

#growth_value_tiltObject

Classifies equity ETFs as either ‘Growth’ or Value’ based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as ‘Core / Blend’



97
98
99
# File 'lib/intrinio-sdk/models/etf.rb', line 97

def growth_value_tilt
  @growth_value_tilt
end

#hedge_fund_typeObject

For ETFs where ‘other_asset_types’ is ‘Hedge Fund Replication’, this field provides detail on the type of hedge fund replication strategy



265
266
267
# File 'lib/intrinio-sdk/models/etf.rb', line 265

def hedge_fund_type
  @hedge_fund_type
end

#holds_ad_rsObject

If true, he ETF’s investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy



271
272
273
# File 'lib/intrinio-sdk/models/etf.rb', line 271

def holds_ad_rs
  @holds_ad_rs
end

#holds_closed_end_fundsObject

IF true, if the ETF’s investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy



256
257
258
# File 'lib/intrinio-sdk/models/etf.rb', line 256

def holds_closed_end_funds
  @holds_closed_end_funds
end

#holds_ml_psObject

If true, the ETF’s investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy



250
251
252
# File 'lib/intrinio-sdk/models/etf.rb', line 250

def holds_ml_ps
  @holds_ml_ps
end

#holds_only_nasdaq_stocksObject

If false, the ETF is an equity ETF and holds only stocks listed on Nasdaq



94
95
96
# File 'lib/intrinio-sdk/models/etf.rb', line 94

def holds_only_nasdaq_stocks
  @holds_only_nasdaq_stocks
end

#holds_only_nyse_stocksObject

If true, the ETF is an equity ETF and holds only stocks listed on NYSE



91
92
93
# File 'lib/intrinio-sdk/models/etf.rb', line 91

def holds_only_nyse_stocks
  @holds_only_nyse_stocks
end

#holds_preferred_stockObject

If true, the ETF’s investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy



253
254
255
# File 'lib/intrinio-sdk/models/etf.rb', line 253

def holds_preferred_stock
  @holds_preferred_stock
end

#idObject

The Intrinio ID of the ETF



19
20
21
# File 'lib/intrinio-sdk/models/etf.rb', line 19

def id
  @id
end

#inception_dateObject

Inception Date for the ETF as published by the ETF sponsor



52
53
54
# File 'lib/intrinio-sdk/models/etf.rb', line 52

def inception_date
  @inception_date
end

#includes_short_exposureObject

This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF



277
278
279
# File 'lib/intrinio-sdk/models/etf.rb', line 277

def includes_short_exposure
  @includes_short_exposure
end

#income_categoryObject

Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income



355
356
357
# File 'lib/intrinio-sdk/models/etf.rb', line 355

def income_category
  @income_category
end

#index_familyObject

This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider



286
287
288
# File 'lib/intrinio-sdk/models/etf.rb', line 286

def index_family
  @index_family
end

#index_linkedObject

This field identifies whether an ETF is index linked or active



274
275
276
# File 'lib/intrinio-sdk/models/etf.rb', line 274

def index_linked
  @index_linked
end

#index_nameObject

This field identifies the name of the underlying index tracked by the ETF, if applicable



280
281
282
# File 'lib/intrinio-sdk/models/etf.rb', line 280

def index_name
  @index_name
end

#index_providerObject

This field identifies the Index provider for the index underlying the ETF, if applicable



292
293
294
# File 'lib/intrinio-sdk/models/etf.rb', line 292

def index_provider
  @index_provider
end

#index_provider_codeObject

This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable



313
314
315
# File 'lib/intrinio-sdk/models/etf.rb', line 313

def index_provider_code
  @index_provider_code
end

#index_tickerObject

This field identifies the OpenFIGI ticker for the Index underlying the ETF



298
299
300
# File 'lib/intrinio-sdk/models/etf.rb', line 298

def index_ticker
  @index_ticker
end

#index_weighting_schemeObject

For ETFs that track an underlying index, this field provides detail on the index weighting type



160
161
162
# File 'lib/intrinio-sdk/models/etf.rb', line 160

def index_weighting_scheme
  @index_weighting_scheme
end

#industryObject

For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.



109
110
111
# File 'lib/intrinio-sdk/models/etf.rb', line 109

def industry
  @industry
end

#intraday_nav_tickerObject

Intra-day NAV ticker for the Exchange Traded Fund (ETF)



67
68
69
# File 'lib/intrinio-sdk/models/etf.rb', line 67

def intraday_nav_ticker
  @intraday_nav_ticker
end

#inverse_leveragedObject

This field is populated if the ETF provides inverse or leveraged exposure



226
227
228
# File 'lib/intrinio-sdk/models/etf.rb', line 226

def inverse_leveraged
  @inverse_leveraged
end

#is_live_listedObject

If true, the ETF is still listed on an exchange; if false, the ETF is no longer listed



61
62
63
# File 'lib/intrinio-sdk/models/etf.rb', line 61

def is_live_listed
  @is_live_listed
end

#isinObject

International Securities Identification Number (ISIN) for the ETF



34
35
36
# File 'lib/intrinio-sdk/models/etf.rb', line 34

def isin
  @isin
end

#issuing_entity_country_codeObject

The name of the legal entity that issued the Exchange Traded Product (ETP)



322
323
324
# File 'lib/intrinio-sdk/models/etf.rb', line 322

def issuing_entity_country_code
  @issuing_entity_country_code
end

#ladderedObject

For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure



202
203
204
# File 'lib/intrinio-sdk/models/etf.rb', line 202

def laddered
  @laddered
end

#latin_america_sub_groupObject

For ETFs that are classified as ‘Latin America’ in the ‘continent’ field, this field provides further detail on the type of regional exposure



139
140
141
# File 'lib/intrinio-sdk/models/etf.rb', line 139

def latin_america_sub_group
  @latin_america_sub_group
end

The legal structure as defined in the prospectus



64
65
66
# File 'lib/intrinio-sdk/models/etf.rb', line 64

def legal_structure
  @legal_structure
end

#listing_country_codeObject

2 letter ISO country code for the country where the Exchange Traded Product (ETP) is listed



343
344
345
# File 'lib/intrinio-sdk/models/etf.rb', line 343

def listing_country_code
  @listing_country_code
end

#listing_currencyObject

Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code



337
338
339
# File 'lib/intrinio-sdk/models/etf.rb', line 337

def listing_currency
  @listing_currency
end

#listing_regionObject

The region in which this specific ETF is listed



346
347
348
# File 'lib/intrinio-sdk/models/etf.rb', line 346

def listing_region
  @listing_region
end

#livestockObject

For ETFs where ‘commodity_type’ is ‘Livestock’, this field provides detail on the type of livestock exposure provided by the ETF



307
308
309
# File 'lib/intrinio-sdk/models/etf.rb', line 307

def livestock
  @livestock
end

#market_cap_rangeObject

Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples (‘Mega Cap’, ‘Large Cap’, ‘Mid Cap’, etc.)



88
89
90
# File 'lib/intrinio-sdk/models/etf.rb', line 88

def market_cap_range
  @market_cap_range
end

#market_cap_weighting_typeObject

For ETFs that take the value ‘Market Cap Weighted’ in the ‘index_weighting_scheme’ field, this field provides detail on the market cap weighting type



163
164
165
# File 'lib/intrinio-sdk/models/etf.rb', line 163

def market_cap_weighting_type
  @market_cap_weighting_type
end

#metal_typeObject

For ETFs where ‘commodity_type’ is ‘Gold & Metals’, this field provides detail on the type of exposure provided by the ETF



223
224
225
# File 'lib/intrinio-sdk/models/etf.rb', line 223

def metal_type
  @metal_type
end

#month_end_assetsObject

Net assets in millions of dollars as of the most recent month end



361
362
363
# File 'lib/intrinio-sdk/models/etf.rb', line 361

def month_end_assets
  @month_end_assets
end

#mortgage_bond_typesObject

For bond ETFs that take the value ‘Mortgage’ in ‘bond_type’, this field provides additional detail on the type of underlying securities



184
185
186
# File 'lib/intrinio-sdk/models/etf.rb', line 184

def mortgage_bond_types
  @mortgage_bond_types
end

#municipal_bond_regionObject

For bond ETFs that take the value ‘Municipal’ in ‘bond_type’, this field provides additional detail on the geographic exposure



178
179
180
# File 'lib/intrinio-sdk/models/etf.rb', line 178

def municipal_bond_region
  @municipal_bond_region
end

#municipal_vrdoObject

For bond ETFs that take the value ‘Municipal’ in ‘bond_type’, this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations



181
182
183
# File 'lib/intrinio-sdk/models/etf.rb', line 181

def municipal_vrdo
  @municipal_vrdo
end

#nameObject

The common name of the ETF



22
23
24
# File 'lib/intrinio-sdk/models/etf.rb', line 22

def name
  @name
end

#natural_resources_typeObject

For ETFs that are classified as ‘Natural Resources’ in the ‘cross_sector_theme’ field, this field provides further detail on the type of Natural Resources exposure.



118
119
120
# File 'lib/intrinio-sdk/models/etf.rb', line 118

def natural_resources_type
  @natural_resources_type
end

#net_expense_ratioObject

Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF Sponsor



79
80
81
# File 'lib/intrinio-sdk/models/etf.rb', line 79

def net_expense_ratio
  @net_expense_ratio
end

#number_of_holdingsObject

The number of holdings for this Exchange Traded Fund (ETF)



373
374
375
# File 'lib/intrinio-sdk/models/etf.rb', line 373

def number_of_holdings
  @number_of_holdings
end

#other_asset_typesObject

If ‘asset_class’ field is classified as ‘Other Asset Types’ this field captures the specific category of the underlying assets



85
86
87
# File 'lib/intrinio-sdk/models/etf.rb', line 85

def other_asset_types
  @other_asset_types
end

#other_quant_modelsObject

For ETFs where ‘quant_strategies_type’ is ‘Other Quant Model’, this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF



262
263
264
# File 'lib/intrinio-sdk/models/etf.rb', line 262

def other_quant_models
  @other_quant_models
end

#parent_indexObject

This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable



283
284
285
# File 'lib/intrinio-sdk/models/etf.rb', line 283

def parent_index
  @parent_index
end

#primary_listing_regionObject

Geographic region in the country of the primary listing falls



76
77
78
# File 'lib/intrinio-sdk/models/etf.rb', line 76

def primary_listing_region
  @primary_listing_region
end

#primary_tickerObject

The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes



70
71
72
# File 'lib/intrinio-sdk/models/etf.rb', line 70

def primary_ticker
  @primary_ticker
end

#primary_ticker_country_codeObject

2 letter ISO country code for the country of the primary listing



73
74
75
# File 'lib/intrinio-sdk/models/etf.rb', line 73

def primary_ticker_country_code
  @primary_ticker_country_code
end

#quant_strategies_typeObject

This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy



259
260
261
# File 'lib/intrinio-sdk/models/etf.rb', line 259

def quant_strategies_type
  @quant_strategies_type
end

#real_estateObject

For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market



157
158
159
# File 'lib/intrinio-sdk/models/etf.rb', line 157

def real_estate
  @real_estate
end

#registered_countriesObject

The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe



319
320
321
# File 'lib/intrinio-sdk/models/etf.rb', line 319

def registered_countries
  @registered_countries
end

#regular_dividend_payor_typeObject

This field is populated if the ETF has a value of ‘Dividend – Regular Payors’ in the ‘dividend_type’ field



247
248
249
# File 'lib/intrinio-sdk/models/etf.rb', line 247

def regular_dividend_payor_type
  @regular_dividend_payor_type
end

#replication_structureObject

The replication structure of the Exchange Traded Product (ETP)



328
329
330
# File 'lib/intrinio-sdk/models/etf.rb', line 328

def replication_structure
  @replication_structure
end

#ricObject

Reuters Instrument Code (RIC) for the ETF



31
32
33
# File 'lib/intrinio-sdk/models/etf.rb', line 31

def ric
  @ric
end

#sectorObject

For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to



106
107
108
# File 'lib/intrinio-sdk/models/etf.rb', line 106

def sector
  @sector
end

#sedolObject

Stock Exchange Daily Official List (SEDOL) for the ETF



37
38
39
# File 'lib/intrinio-sdk/models/etf.rb', line 37

def sedol
  @sedol
end

#single_category_designationObject

This categorization is created for those users who want every ETF to be ‘forced’ into a single bucket, so that the assets for all categories will always sum to the total market



316
317
318
# File 'lib/intrinio-sdk/models/etf.rb', line 316

def single_category_designation
  @single_category_designation
end

#smartvs_traditional_betaObject

This field identifies whether an ETF provides ‘Traditional’ beta exposure or ‘Smart’ beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don’t provide indexed exposure to a targeted factor) are classified separately



349
350
351
# File 'lib/intrinio-sdk/models/etf.rb', line 349

def smartvs_traditional_beta
  @smartvs_traditional_beta
end

#smartvs_traditional_beta_level2Object

This field provides further detail within the traditional and smart beta categories



352
353
354
# File 'lib/intrinio-sdk/models/etf.rb', line 352

def smartvs_traditional_beta_level2
  @smartvs_traditional_beta_level2
end

#social_environmental_typeObject

This field is populated if the ETF’s strategy involves providing exposure to a specific social or environmental theme



238
239
240
# File 'lib/intrinio-sdk/models/etf.rb', line 238

def social_environmental_type
  @social_environmental_type
end

#specialized_regionObject

This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples (‘BRIC’, ‘Chindia’, etc.)



133
134
135
# File 'lib/intrinio-sdk/models/etf.rb', line 133

def specialized_region
  @specialized_region
end

#specific_countryObject

This field is populated if the ETF provides targeted exposure to a specific country



148
149
150
# File 'lib/intrinio-sdk/models/etf.rb', line 148

def specific_country
  @specific_country
end

#specific_maturity_yearObject

For all bond ETFs that take the value ‘Specific Maturity Year’ in the ‘average_maturity’ field, this field specifies the calendar year



196
197
198
# File 'lib/intrinio-sdk/models/etf.rb', line 196

def specific_maturity_year
  @specific_maturity_year
end

The fund manager (ETF) or issuing bank (ETN)



43
44
45
# File 'lib/intrinio-sdk/models/etf.rb', line 43

def sponsor
  @sponsor
end

#sub_industryObject

For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-industry that it provides the exposure to



112
113
114
# File 'lib/intrinio-sdk/models/etf.rb', line 112

def sub_industry
  @sub_industry
end

#target_date_multi_asset_typeObject

For ETFs where ‘asset_class_type’ is ‘Target Date / MultiAsset’, this field provides detail on the type of commodities held in the ETF



229
230
231
# File 'lib/intrinio-sdk/models/etf.rb', line 229

def target_date_multi_asset_type
  @target_date_multi_asset_type
end

#tickerObject

The common ticker symbol for the ETF



25
26
27
# File 'lib/intrinio-sdk/models/etf.rb', line 25

def ticker
  @ticker
end

#typeObject

High-level classification for the ETF based on its intended investment objective



46
47
48
# File 'lib/intrinio-sdk/models/etf.rb', line 46

def type
  @type
end

#ucitsObject

If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant



325
326
327
# File 'lib/intrinio-sdk/models/etf.rb', line 325

def ucits
  @ucits
end

#us_or_excludes_usObject

Takes the value of ‘Domestic’ for US exposure, ‘International’ for non-US exposure and ‘Global’ for exposure that includes all regions including the US



127
128
129
# File 'lib/intrinio-sdk/models/etf.rb', line 127

def us_or_excludes_us
  @us_or_excludes_us
end

#us_stateObject

Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies operating in a specific state in the US



154
155
156
# File 'lib/intrinio-sdk/models/etf.rb', line 154

def us_state
  @us_state
end

#value_typeObject

For ETFs that are classified as ‘Value’ in ‘growth_value_tilt’, this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores



103
104
105
# File 'lib/intrinio-sdk/models/etf.rb', line 103

def value_type
  @value_type
end

#zero_couponObject

For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills



205
206
207
# File 'lib/intrinio-sdk/models/etf.rb', line 205

def zero_coupon
  @zero_coupon
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'lib/intrinio-sdk/models/etf.rb', line 377

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'ticker' => :'ticker',
    :'figi_ticker' => :'figi_ticker',
    :'ric' => :'ric',
    :'isin' => :'isin',
    :'sedol' => :'sedol',
    :'exchange_mic' => :'exchange_mic',
    :'sponsor' => :'sponsor',
    :'type' => :'type',
    :'description' => :'description',
    :'inception_date' => :'inception_date',
    :'data_change_date' => :'data_change_date',
    :'close_date' => :'close_date',
    :'is_live_listed' => :'is_live_listed',
    :'legal_structure' => :'legal_structure',
    :'intraday_nav_ticker' => :'intraday_nav_ticker',
    :'primary_ticker' => :'primary_ticker',
    :'primary_ticker_country_code' => :'primary_ticker_country_code',
    :'primary_listing_region' => :'primary_listing_region',
    :'net_expense_ratio' => :'net_expense_ratio',
    :'asset_class' => :'asset_class',
    :'other_asset_types' => :'other_asset_types',
    :'market_cap_range' => :'market_cap_range',
    :'holds_only_nyse_stocks' => :'holds_only_nyse_stocks',
    :'holds_only_nasdaq_stocks' => :'holds_only_nasdaq_stocks',
    :'growth_value_tilt' => :'growth_value_tilt',
    :'growth_type' => :'growth_type',
    :'value_type' => :'value_type',
    :'sector' => :'sector',
    :'industry' => :'industry',
    :'sub_industry' => :'sub_industry',
    :'cross_sector_theme' => :'cross_sector_theme',
    :'natural_resources_type' => :'natural_resources_type',
    :'excludes_financials' => :'excludes_financials',
    :'excludes_technology' => :'excludes_technology',
    :'us_or_excludes_us' => :'us_or_excludes_us',
    :'developed_emerging' => :'developed_emerging',
    :'specialized_region' => :'specialized_region',
    :'continent' => :'continent',
    :'latin_america_sub_group' => :'latin_america_sub_group',
    :'europe_sub_group' => :'europe_sub_group',
    :'asia_sub_group' => :'asia_sub_group',
    :'specific_country' => :'specific_country',
    :'china_listing_location' => :'china_listing_location',
    :'us_state' => :'us_state',
    :'real_estate' => :'real_estate',
    :'index_weighting_scheme' => :'index_weighting_scheme',
    :'market_cap_weighting_type' => :'market_cap_weighting_type',
    :'fundamental_weighting_type' => :'fundamental_weighting_type',
    :'dividend_weighting_type' => :'dividend_weighting_type',
    :'bond_type' => :'bond_type',
    :'government_bond_types' => :'government_bond_types',
    :'municipal_bond_region' => :'municipal_bond_region',
    :'municipal_vrdo' => :'municipal_vrdo',
    :'mortgage_bond_types' => :'mortgage_bond_types',
    :'bond_tax_status' => :'bond_tax_status',
    :'credit_quality' => :'credit_quality',
    :'average_maturity' => :'average_maturity',
    :'specific_maturity_year' => :'specific_maturity_year',
    :'bond_currency_denomination' => :'bond_currency_denomination',
    :'laddered' => :'laddered',
    :'zero_coupon' => :'zero_coupon',
    :'floating_rate' => :'floating_rate',
    :'build_america_bonds' => :'build_america_bonds',
    :'commodity_types' => :'commodity_types',
    :'energy_type' => :'energy_type',
    :'agricultural_type' => :'agricultural_type',
    :'metal_type' => :'metal_type',
    :'inverse_leveraged' => :'inverse_leveraged',
    :'target_date_multi_asset_type' => :'target_date_multi_asset_type',
    :'currency_hedged' => :'currency_hedged',
    :'currency_pair' => :'currency_pair',
    :'social_environmental_type' => :'social_environmental_type',
    :'clean_energy_type' => :'clean_energy_type',
    :'dividend_type' => :'dividend_type',
    :'regular_dividend_payor_type' => :'regular_dividend_payor_type',
    :'holds_ml_ps' => :'holds_ml_ps',
    :'holds_preferred_stock' => :'holds_preferred_stock',
    :'holds_closed_end_funds' => :'holds_closed_end_funds',
    :'quant_strategies_type' => :'quant_strategies_type',
    :'other_quant_models' => :'other_quant_models',
    :'hedge_fund_type' => :'hedge_fund_type',
    :'derivatives_based' => :'derivatives_based',
    :'holds_ad_rs' => :'holds_ad_rs',
    :'index_linked' => :'index_linked',
    :'includes_short_exposure' => :'includes_short_exposure',
    :'index_name' => :'index_name',
    :'parent_index' => :'parent_index',
    :'index_family' => :'index_family',
    :'broader_index_family' => :'broader_index_family',
    :'index_provider' => :'index_provider',
    :'fund_family' => :'fund_family',
    :'index_ticker' => :'index_ticker',
    :'etn_issuing_bank' => :'etn_issuing_bank',
    :'etn_maturity_date' => :'etn_maturity_date',
    :'livestock' => :'livestock',
    :'dynamic_futures_roll' => :'dynamic_futures_roll',
    :'index_provider_code' => :'index_provider_code',
    :'single_category_designation' => :'single_category_designation',
    :'registered_countries' => :'registered_countries',
    :'issuing_entity_country_code' => :'issuing_entity_country_code',
    :'ucits' => :'ucits',
    :'replication_structure' => :'replication_structure',
    :'domicile' => :'domicile',
    :'base_currency' => :'base_currency',
    :'listing_currency' => :'listing_currency',
    :'fund_listing_date' => :'fund_listing_date',
    :'listing_country_code' => :'listing_country_code',
    :'listing_region' => :'listing_region',
    :'smartvs_traditional_beta' => :'smartvs_traditional_beta',
    :'smartvs_traditional_beta_level2' => :'smartvs_traditional_beta_level2',
    :'income_category' => :'income_category',
    :'etp_structure_type' => :'etp_structure_type',
    :'month_end_assets' => :'month_end_assets',
    :'etf_portfolio_turnover' => :'etf_portfolio_turnover',
    :'firstbridge_id' => :'firstbridge_id',
    :'firstbridge_parent_id' => :'firstbridge_parent_id',
    :'number_of_holdings' => :'number_of_holdings'
  }
end

.swagger_typesObject

Attribute type mapping.



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/intrinio-sdk/models/etf.rb', line 502

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'ticker' => :'String',
    :'figi_ticker' => :'String',
    :'ric' => :'String',
    :'isin' => :'String',
    :'sedol' => :'String',
    :'exchange_mic' => :'String',
    :'sponsor' => :'String',
    :'type' => :'String',
    :'description' => :'String',
    :'inception_date' => :'Date',
    :'data_change_date' => :'Date',
    :'close_date' => :'Date',
    :'is_live_listed' => :'BOOLEAN',
    :'legal_structure' => :'String',
    :'intraday_nav_ticker' => :'String',
    :'primary_ticker' => :'String',
    :'primary_ticker_country_code' => :'String',
    :'primary_listing_region' => :'String',
    :'net_expense_ratio' => :'Float',
    :'asset_class' => :'String',
    :'other_asset_types' => :'String',
    :'market_cap_range' => :'String',
    :'holds_only_nyse_stocks' => :'BOOLEAN',
    :'holds_only_nasdaq_stocks' => :'BOOLEAN',
    :'growth_value_tilt' => :'String',
    :'growth_type' => :'String',
    :'value_type' => :'String',
    :'sector' => :'String',
    :'industry' => :'String',
    :'sub_industry' => :'String',
    :'cross_sector_theme' => :'String',
    :'natural_resources_type' => :'String',
    :'excludes_financials' => :'BOOLEAN',
    :'excludes_technology' => :'BOOLEAN',
    :'us_or_excludes_us' => :'String',
    :'developed_emerging' => :'String',
    :'specialized_region' => :'String',
    :'continent' => :'String',
    :'latin_america_sub_group' => :'String',
    :'europe_sub_group' => :'String',
    :'asia_sub_group' => :'String',
    :'specific_country' => :'String',
    :'china_listing_location' => :'String',
    :'us_state' => :'String',
    :'real_estate' => :'String',
    :'index_weighting_scheme' => :'String',
    :'market_cap_weighting_type' => :'String',
    :'fundamental_weighting_type' => :'String',
    :'dividend_weighting_type' => :'String',
    :'bond_type' => :'String',
    :'government_bond_types' => :'String',
    :'municipal_bond_region' => :'String',
    :'municipal_vrdo' => :'BOOLEAN',
    :'mortgage_bond_types' => :'String',
    :'bond_tax_status' => :'String',
    :'credit_quality' => :'String',
    :'average_maturity' => :'String',
    :'specific_maturity_year' => :'Integer',
    :'bond_currency_denomination' => :'String',
    :'laddered' => :'BOOLEAN',
    :'zero_coupon' => :'BOOLEAN',
    :'floating_rate' => :'BOOLEAN',
    :'build_america_bonds' => :'BOOLEAN',
    :'commodity_types' => :'String',
    :'energy_type' => :'String',
    :'agricultural_type' => :'String',
    :'metal_type' => :'String',
    :'inverse_leveraged' => :'String',
    :'target_date_multi_asset_type' => :'String',
    :'currency_hedged' => :'BOOLEAN',
    :'currency_pair' => :'String',
    :'social_environmental_type' => :'String',
    :'clean_energy_type' => :'String',
    :'dividend_type' => :'String',
    :'regular_dividend_payor_type' => :'String',
    :'holds_ml_ps' => :'BOOLEAN',
    :'holds_preferred_stock' => :'BOOLEAN',
    :'holds_closed_end_funds' => :'BOOLEAN',
    :'quant_strategies_type' => :'String',
    :'other_quant_models' => :'String',
    :'hedge_fund_type' => :'String',
    :'derivatives_based' => :'String',
    :'holds_ad_rs' => :'BOOLEAN',
    :'index_linked' => :'String',
    :'includes_short_exposure' => :'BOOLEAN',
    :'index_name' => :'String',
    :'parent_index' => :'String',
    :'index_family' => :'String',
    :'broader_index_family' => :'String',
    :'index_provider' => :'String',
    :'fund_family' => :'String',
    :'index_ticker' => :'String',
    :'etn_issuing_bank' => :'String',
    :'etn_maturity_date' => :'Date',
    :'livestock' => :'String',
    :'dynamic_futures_roll' => :'BOOLEAN',
    :'index_provider_code' => :'String',
    :'single_category_designation' => :'String',
    :'registered_countries' => :'String',
    :'issuing_entity_country_code' => :'String',
    :'ucits' => :'BOOLEAN',
    :'replication_structure' => :'String',
    :'domicile' => :'String',
    :'base_currency' => :'String',
    :'listing_currency' => :'String',
    :'fund_listing_date' => :'Date',
    :'listing_country_code' => :'String',
    :'listing_region' => :'String',
    :'smartvs_traditional_beta' => :'String',
    :'smartvs_traditional_beta_level2' => :'String',
    :'income_category' => :'String',
    :'etp_structure_type' => :'String',
    :'month_end_assets' => :'Float',
    :'etf_portfolio_turnover' => :'Float',
    :'firstbridge_id' => :'String',
    :'firstbridge_parent_id' => :'String',
    :'number_of_holdings' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
# File 'lib/intrinio-sdk/models/etf.rb', line 1127

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      ticker == o.ticker &&
      figi_ticker == o.figi_ticker &&
      ric == o.ric &&
      isin == o.isin &&
      sedol == o.sedol &&
      exchange_mic == o.exchange_mic &&
      sponsor == o.sponsor &&
      type == o.type &&
      description == o.description &&
      inception_date == o.inception_date &&
      data_change_date == o.data_change_date &&
      close_date == o.close_date &&
      is_live_listed == o.is_live_listed &&
      legal_structure == o.legal_structure &&
      intraday_nav_ticker == o.intraday_nav_ticker &&
      primary_ticker == o.primary_ticker &&
      primary_ticker_country_code == o.primary_ticker_country_code &&
      primary_listing_region == o.primary_listing_region &&
      net_expense_ratio == o.net_expense_ratio &&
      asset_class == o.asset_class &&
      other_asset_types == o.other_asset_types &&
      market_cap_range == o.market_cap_range &&
      holds_only_nyse_stocks == o.holds_only_nyse_stocks &&
      holds_only_nasdaq_stocks == o.holds_only_nasdaq_stocks &&
      growth_value_tilt == o.growth_value_tilt &&
      growth_type == o.growth_type &&
      value_type == o.value_type &&
      sector == o.sector &&
      industry == o.industry &&
      sub_industry == o.sub_industry &&
      cross_sector_theme == o.cross_sector_theme &&
      natural_resources_type == o.natural_resources_type &&
      excludes_financials == o.excludes_financials &&
      excludes_technology == o.excludes_technology &&
      us_or_excludes_us == o.us_or_excludes_us &&
      developed_emerging == o.developed_emerging &&
      specialized_region == o.specialized_region &&
      continent == o.continent &&
      latin_america_sub_group == o.latin_america_sub_group &&
      europe_sub_group == o.europe_sub_group &&
      asia_sub_group == o.asia_sub_group &&
      specific_country == o.specific_country &&
      china_listing_location == o.china_listing_location &&
      us_state == o.us_state &&
      real_estate == o.real_estate &&
      index_weighting_scheme == o.index_weighting_scheme &&
      market_cap_weighting_type == o.market_cap_weighting_type &&
      fundamental_weighting_type == o.fundamental_weighting_type &&
      dividend_weighting_type == o.dividend_weighting_type &&
      bond_type == o.bond_type &&
      government_bond_types == o.government_bond_types &&
      municipal_bond_region == o.municipal_bond_region &&
      municipal_vrdo == o.municipal_vrdo &&
      mortgage_bond_types == o.mortgage_bond_types &&
      bond_tax_status == o.bond_tax_status &&
      credit_quality == o.credit_quality &&
      average_maturity == o.average_maturity &&
      specific_maturity_year == o.specific_maturity_year &&
      bond_currency_denomination == o.bond_currency_denomination &&
      laddered == o.laddered &&
      zero_coupon == o.zero_coupon &&
      floating_rate == o.floating_rate &&
      build_america_bonds == o.build_america_bonds &&
      commodity_types == o.commodity_types &&
      energy_type == o.energy_type &&
      agricultural_type == o.agricultural_type &&
      metal_type == o.metal_type &&
      inverse_leveraged == o.inverse_leveraged &&
      target_date_multi_asset_type == o.target_date_multi_asset_type &&
      currency_hedged == o.currency_hedged &&
      currency_pair == o.currency_pair &&
      social_environmental_type == o.social_environmental_type &&
      clean_energy_type == o.clean_energy_type &&
      dividend_type == o.dividend_type &&
      regular_dividend_payor_type == o.regular_dividend_payor_type &&
      holds_ml_ps == o.holds_ml_ps &&
      holds_preferred_stock == o.holds_preferred_stock &&
      holds_closed_end_funds == o.holds_closed_end_funds &&
      quant_strategies_type == o.quant_strategies_type &&
      other_quant_models == o.other_quant_models &&
      hedge_fund_type == o.hedge_fund_type &&
      derivatives_based == o.derivatives_based &&
      holds_ad_rs == o.holds_ad_rs &&
      index_linked == o.index_linked &&
      includes_short_exposure == o.includes_short_exposure &&
      index_name == o.index_name &&
      parent_index == o.parent_index &&
      index_family == o.index_family &&
      broader_index_family == o.broader_index_family &&
      index_provider == o.index_provider &&
      fund_family == o.fund_family &&
      index_ticker == o.index_ticker &&
      etn_issuing_bank == o.etn_issuing_bank &&
      etn_maturity_date == o.etn_maturity_date &&
      livestock == o.livestock &&
      dynamic_futures_roll == o.dynamic_futures_roll &&
      index_provider_code == o.index_provider_code &&
      single_category_designation == o.single_category_designation &&
      registered_countries == o.registered_countries &&
      issuing_entity_country_code == o.issuing_entity_country_code &&
      ucits == o.ucits &&
      replication_structure == o.replication_structure &&
      domicile == o.domicile &&
      base_currency == o.base_currency &&
      listing_currency == o.listing_currency &&
      fund_listing_date == o.fund_listing_date &&
      listing_country_code == o.listing_country_code &&
      listing_region == o.listing_region &&
      smartvs_traditional_beta == o.smartvs_traditional_beta &&
      smartvs_traditional_beta_level2 == o.smartvs_traditional_beta_level2 &&
      income_category == o.income_category &&
      etp_structure_type == o.etp_structure_type &&
      month_end_assets == o.month_end_assets &&
      etf_portfolio_turnover == o.etf_portfolio_turnover &&
      firstbridge_id == o.firstbridge_id &&
      firstbridge_parent_id == o.firstbridge_parent_id &&
      number_of_holdings == o.number_of_holdings
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/intrinio-sdk/models/etf.rb', line 1287

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Intrinio.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/intrinio-sdk/models/etf.rb', line 1353

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
# File 'lib/intrinio-sdk/models/etf.rb', line 1266

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


1253
1254
1255
# File 'lib/intrinio-sdk/models/etf.rb', line 1253

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



1259
1260
1261
# File 'lib/intrinio-sdk/models/etf.rb', line 1259

def hash
  [id, name, ticker, figi_ticker, ric, isin, sedol, exchange_mic, sponsor, type, description, inception_date, data_change_date, close_date, is_live_listed, legal_structure, intraday_nav_ticker, primary_ticker, primary_ticker_country_code, primary_listing_region, net_expense_ratio, asset_class, other_asset_types, market_cap_range, holds_only_nyse_stocks, holds_only_nasdaq_stocks, growth_value_tilt, growth_type, value_type, sector, industry, sub_industry, cross_sector_theme, natural_resources_type, excludes_financials, excludes_technology, us_or_excludes_us, developed_emerging, specialized_region, continent, latin_america_sub_group, europe_sub_group, asia_sub_group, specific_country, china_listing_location, us_state, real_estate, index_weighting_scheme, market_cap_weighting_type, fundamental_weighting_type, dividend_weighting_type, bond_type, government_bond_types, municipal_bond_region, municipal_vrdo, mortgage_bond_types, bond_tax_status, credit_quality, average_maturity, specific_maturity_year, bond_currency_denomination, laddered, zero_coupon, floating_rate, build_america_bonds, commodity_types, energy_type, agricultural_type, metal_type, inverse_leveraged, target_date_multi_asset_type, currency_hedged, currency_pair, social_environmental_type, clean_energy_type, dividend_type, regular_dividend_payor_type, holds_ml_ps, holds_preferred_stock, holds_closed_end_funds, quant_strategies_type, other_quant_models, hedge_fund_type, derivatives_based, holds_ad_rs, index_linked, includes_short_exposure, index_name, parent_index, index_family, broader_index_family, index_provider, fund_family, index_ticker, etn_issuing_bank, etn_maturity_date, livestock, dynamic_futures_roll, index_provider_code, single_category_designation, registered_countries, issuing_entity_country_code, ucits, replication_structure, domicile, base_currency, listing_currency, fund_listing_date, listing_country_code, listing_region, smartvs_traditional_beta, smartvs_traditional_beta_level2, income_category, etp_structure_type, month_end_assets, etf_portfolio_turnover, firstbridge_id, firstbridge_parent_id, number_of_holdings].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



1114
1115
1116
1117
# File 'lib/intrinio-sdk/models/etf.rb', line 1114

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



1333
1334
1335
# File 'lib/intrinio-sdk/models/etf.rb', line 1333

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



1339
1340
1341
1342
1343
1344
1345
1346
1347
# File 'lib/intrinio-sdk/models/etf.rb', line 1339

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



1327
1328
1329
# File 'lib/intrinio-sdk/models/etf.rb', line 1327

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



1121
1122
1123
# File 'lib/intrinio-sdk/models/etf.rb', line 1121

def valid?
  return true
end