Class: OpenfigiRuby::FilterResult

Inherits:
Struct
  • Object
show all
Defined in:
lib/openfigi_ruby/search_result.rb

Overview

Result from POST /v3/filter.

Like SearchResult but results are sorted alphabetically by FIGI and a total count is included.

Instance Attribute Summary collapse

Instance Attribute Details

#data ⇒ Array<FigiResult> (readonly)

Returns instruments matching the filter for this page.

Returns:

  • (Array<FigiResult>) —

    instruments matching the filter for this page



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

FilterResult = Struct.new(:data, :next_page, :total, :error, keyword_init: true)

#error ⇒ String? (readonly)

Returns error message when the request is invalid.

Returns:

  • (String, nil) —

    error message when the request is invalid



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

FilterResult = Struct.new(:data, :next_page, :total, :error, keyword_init: true)

#next_page ⇒ String? (readonly)

Returns opaque pagination token; pass as +start:+ to Client#filter to fetch the next page. nil when this is the last page.

Returns:

  • (String, nil) —

    opaque pagination token; pass as +start:+ to Client#filter to fetch the next page. nil when this is the last page.



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

FilterResult = Struct.new(:data, :next_page, :total, :error, keyword_init: true)

#total ⇒ Integer (readonly)

Returns total number of matching instruments across all pages.

Returns:

  • (Integer) —

    total number of matching instruments across all pages



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

FilterResult = Struct.new(:data, :next_page, :total, :error, keyword_init: true)