Class: OpenfigiRuby::SearchResult

Inherits:

Struct

• Object
• Struct
• OpenfigiRuby::SearchResult

Defined in:

lib/openfigi_ruby/search_result.rb

Overview

Result from POST /v3/search.

Instance Attribute Summary

• #data ⇒ Array<FigiResult> readonly

  Instruments matching the search query for this page.

• #error ⇒ String^? readonly

  Error message when the query itself is invalid.

• #next_page ⇒ String^? readonly

  Opaque pagination token; pass as +start:+ to Client#search to fetch the next page.

Instance Attribute Details

#data ⇒ Array<FigiResult> (readonly)

Returns instruments matching the search query for this page.

Returns:

• (Array<FigiResult>) —

  instruments matching the search query for this page

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

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

#error ⇒ String^? (readonly)

Returns error message when the query itself is invalid.

Returns:

• (String, nil) —

  error message when the query itself is invalid

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

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

#next_page ⇒ String^? (readonly)

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

Returns:

• (String, nil) —

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

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

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