Class: OpenfigiRuby::FigiResult

Inherits:

Struct

• Object
• Struct
• OpenfigiRuby::FigiResult

Defined in:

lib/openfigi_ruby/figi_result.rb

Overview

Represents a single financial instrument returned by the OpenFIGI API.

Instance Attribute Summary

• #composite_figi ⇒ String^? readonly

  Composite FIGI (aggregates listings across exchanges).

• #exch_code ⇒ String^? readonly

  Exchange code (e.g. "US", "LN").

• #figi ⇒ String readonly

  The Financial Instrument Global Identifier (FIGI).

• #market_sector ⇒ String^? readonly

  Market sector (e.g. "Equity", "Corp", "Govt").

• #metadata ⇒ String^? readonly

  Optional metadata string returned by the API.

• #name ⇒ String^? readonly

  Instrument name.

• #security_description ⇒ String^? readonly

  Short description of the security.

• #security_type ⇒ String^? readonly

  Primary security classification (e.g. "Common Stock", "ETP").

• #security_type2 ⇒ String^? readonly

  Secondary security classification.

• #share_class_figi ⇒ String^? readonly

  Share class-level FIGI.

• #ticker ⇒ String^? readonly

  Exchange ticker symbol.

Instance Attribute Details

#composite_figi ⇒ String^? (readonly)

Returns composite FIGI (aggregates listings across exchanges).

Returns:

• (String, nil) —

  composite FIGI (aggregates listings across exchanges)

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#exch_code ⇒ String^? (readonly)

Returns exchange code (e.g. "US", "LN").

Returns:

• (String, nil) —

  exchange code (e.g. "US", "LN")

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#figi ⇒ String (readonly)

Returns the Financial Instrument Global Identifier (FIGI).

Returns:

• (String) —

  the Financial Instrument Global Identifier (FIGI)

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#market_sector ⇒ String^? (readonly)

Returns market sector (e.g. "Equity", "Corp", "Govt").

Returns:

• (String, nil) —

  market sector (e.g. "Equity", "Corp", "Govt")

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#metadata ⇒ String^? (readonly)

Returns optional metadata string returned by the API.

Returns:

• (String, nil) —

  optional metadata string returned by the API

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#name ⇒ String^? (readonly)

Returns instrument name.

Returns:

• (String, nil) —

  instrument name

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#security_description ⇒ String^? (readonly)

Returns short description of the security.

Returns:

• (String, nil) —

  short description of the security

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#security_type ⇒ String^? (readonly)

Returns primary security classification (e.g. "Common Stock", "ETP").

Returns:

• (String, nil) —

  primary security classification (e.g. "Common Stock", "ETP")

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#security_type2 ⇒ String^? (readonly)

Returns secondary security classification.

Returns:

• (String, nil) —

  secondary security classification

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#share_class_figi ⇒ String^? (readonly)

Returns share class-level FIGI.

Returns:

• (String, nil) —

  share class-level FIGI

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)

#ticker ⇒ String^? (readonly)

Returns exchange ticker symbol.

Returns:

• (String, nil) —

  exchange ticker symbol

# File 'lib/openfigi_ruby/figi_result.rb', line 28

FigiResult = Struct.new(
  :figi,
  :security_type,
  :market_sector,
  :ticker,
  :name,
  :exch_code,
  :share_class_figi,
  :composite_figi,
  :security_type2,
  :security_description,
  :metadata,
  keyword_init: true
)