Module: OpenfigiRuby

Defined in:
lib/openfigi_ruby.rb,
lib/openfigi_ruby/error.rb,
lib/openfigi_ruby/client.rb,
lib/openfigi_ruby/version.rb,
lib/openfigi_ruby/figi_result.rb,
lib/openfigi_ruby/configuration.rb,
lib/openfigi_ruby/search_result.rb,
lib/openfigi_ruby/mapping_result.rb

Overview

Ruby client for the OpenFIGI V3 API.

Provides identifier mapping, keyword search, and filtering for Financial Instrument Global Identifiers (FIGIs).

Examples:

Configure globally and create a client

OpenfigiRuby.configure do |config|
  config.api_key = ENV["OPENFIGI_API_KEY"]
end

client = OpenfigiRuby::Client.new
results = client.mapping([{ id_type: "ID_ISIN", id_value: "US0378331005" }])

Defined Under Namespace

Classes: ApiError, AuthenticationError, Client, Configuration, Error, FigiResult, FilterResult, InvalidRequestError, MappingResult, RateLimitError, SearchResult, ServerError

Constant Summary collapse

VERSION =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Gem version string.

"0.1.1"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration

Returns the global Configuration instance.

Returns:



27
28
29
 
# File 'lib/openfigi_ruby.rb', line 27

def configuration
  @configuration ||= Configuration.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Configures the gem globally.

Examples:

OpenfigiRuby.configure do |config|
  config.api_key = ENV["OPENFIGI_API_KEY"]
end

Yield Parameters:



39
40
41
 
# File 'lib/openfigi_ruby.rb', line 39

def configure
  yield configuration
end