intrinio-sdk 1.0.0

data/docs/SecurityScreenClause.md

@@ -0,0 +1,10 @@
+# Intrinio::SecurityScreenClause
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** | The field to use when screening, such as an Intrinio Data Tag | [optional] 
+**operator** | **String** | The logic operator to use when screening | [optional] 
+**value** | **String** | The value to screen by | [optional] 
+
+

data/docs/SecurityScreenGroup.md

@@ -0,0 +1,10 @@
+# Intrinio::SecurityScreenGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operator** | **String** | The logic operator for the group (AND, OR, NOT) | [optional] 
+**clauses** | [**Array<SecurityScreenClause>**](SecurityScreenClause.md) | The logic clauses in the group | [optional] 
+**groups** | [**Array<SecurityScreenGroup>**](SecurityScreenGroup.md) | The nested groups within the group | [optional] 
+
+

data/docs/SecurityScreenResult.md

@@ -0,0 +1,9 @@
+# Intrinio::SecurityScreenResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**security** | [**SecuritySummary**](SecuritySummary.md) |  | [optional] 
+**data** | [**Array<SecurityScreenResultData>**](SecurityScreenResultData.md) |  | [optional] 
+
+

data/docs/SecurityScreenResultData.md

@@ -0,0 +1,10 @@
+# Intrinio::SecurityScreenResultData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | The data tag that was screened-for | [optional] 
+**number_value** | **String** | The numeric value for the tag | [optional] 
+**text_value** | **String** | The text value for the tag | [optional] 
+
+

data/docs/SecuritySummary.md

@@ -0,0 +1,17 @@
+# Intrinio::SecuritySummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for Security | [optional] 
+**company_id** | **String** | The Intrinio ID for the Company for which the Security is issued | [optional] 
+**name** | **String** | The name of the Security | [optional] 
+**code** | **String** | A 2-3 digit code classifying the Security | [optional] 
+**currency** | **String** | The currency in which the Security is traded on the exchange | [optional] 
+**ticker** | **String** | The common/local ticker of the Security | [optional] 
+**composite_ticker** | **String** | The country-composite ticker of the Security | [optional] 
+**figi** | **String** | The OpenFIGI identifier | [optional] 
+**composite_figi** | **String** | The country-composite OpenFIGI identifier | [optional] 
+**share_class_figi** | **String** | The global-composite OpenFIGI identifier | [optional] 
+
+

data/docs/StandardizedFinancial.md

@@ -0,0 +1,9 @@
+# Intrinio::StandardizedFinancial
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_tag** | [**DataTagSummary**](DataTagSummary.md) |  | [optional] 
+**value** | **Float** | The value for the Data Tag within the scope of the Fundamental | [optional] 
+
+

data/docs/StockExchange.md

@@ -0,0 +1,17 @@
+# Intrinio::StockExchange
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the Stock Exchange | [optional] 
+**name** | **String** | The name of the exchange | [optional] 
+**mic** | **String** | The Market Identifier Code (MIC) of the exchange | [optional] 
+**acronym** | **String** | The acronym of the exchange's name | [optional] 
+**city** | **String** | The city in which the exchange is located | [optional] 
+**country** | **String** | The country in which the exchange is located | [optional] 
+**country_code** | **String** | The 2-digit code of the exchange's country | [optional] 
+**website** | **String** | The website of the exchange | [optional] 
+**first_stock_price_date** | **Date** | The earliest date for which Intrinio has stock prices for the exchange | [optional] 
+**last_stock_price_date** | **Date** | The latest date for which Intrinio has stock prices for the exchange | [optional] 
+
+

data/docs/StockExchangeApi.md

@@ -0,0 +1,267 @@
+# Intrinio::StockExchangeApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**filter_stock_exchanges**](StockExchangeApi.md#filter_stock_exchanges) | **GET** /stock_exchanges/filter | Filter Stock Exchanges
+[**get_all_stock_exchanges**](StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | Get All Stock Exchanges
+[**get_stock_exchange_by_id**](StockExchangeApi.md#get_stock_exchange_by_id) | **GET** /stock_exchanges/{identifier} | Get Stock Exchange by ID
+[**get_stock_exchange_price_adjustments**](StockExchangeApi.md#get_stock_exchange_price_adjustments) | **GET** /stock_exchanges/{identifier}/prices/adjustments | Get Stock Price Adjustments by Exchange
+[**get_stock_exchange_prices**](StockExchangeApi.md#get_stock_exchange_prices) | **GET** /stock_exchanges/{identifier}/prices | Get Stock Prices by Exchange
+[**get_stock_exchange_securities**](StockExchangeApi.md#get_stock_exchange_securities) | **GET** /stock_exchanges/{identifier}/securities | Get Securities by Exchange
+
+
+# **filter_stock_exchanges**
+> ApiResponseStockExchanges filter_stock_exchanges(opts)
+
+Filter Stock Exchanges
+
+Return Stock Exchanges matching the given filters
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+stockExchange_api = Intrinio::StockExchangeApi.new
+
+opts = { 
+  city: "city_example", # String | Filter by city
+  country: "CHINA", # String | Filter by country
+  country_code: "country_code_example" # String | Filter by ISO country code
+}
+
+begin
+  result = stockExchange_api.filter_stock_exchanges(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling StockExchangeApi->filter_stock_exchanges: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **city** | **String**| Filter by city | [optional] 
+ **country** | **String**| Filter by country | [optional] 
+ **country_code** | **String**| Filter by ISO country code | [optional] 
+
+### Return type
+
+[**ApiResponseStockExchanges**](ApiResponseStockExchanges.md)
+
+# **get_all_stock_exchanges**
+> ApiResponseStockExchanges get_all_stock_exchanges
+
+Get All Stock Exchanges
+
+Return All Stock Exchanges
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+stockExchange_api = Intrinio::StockExchangeApi.new
+
+begin
+  result = stockExchange_api.get_all_stock_exchanges
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling StockExchangeApi->get_all_stock_exchanges: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiResponseStockExchanges**](ApiResponseStockExchanges.md)
+
+# **get_stock_exchange_by_id**
+> StockExchange get_stock_exchange_by_id(identifier)
+
+Get Stock Exchange by ID
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+stockExchange_api = Intrinio::StockExchangeApi.new
+
+identifier = "XSHG" # String | A Stock Exchange identifier (MIC or Intrinio ID)
+
+
+begin
+  result = stockExchange_api.get_stock_exchange_by_id(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling StockExchangeApi->get_stock_exchange_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) | 
+
+### Return type
+
+[**StockExchange**](StockExchange.md)
+
+# **get_stock_exchange_price_adjustments**
+> ApiResponseStockExchangeStockPriceAdjustments get_stock_exchange_price_adjustments(identifier, opts)
+
+Get Stock Price Adjustments by Exchange
+
+Return stock price adjustments for the Stock Exchange with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+stockExchange_api = Intrinio::StockExchangeApi.new
+
+identifier = "USCOMP" # String | A Stock Exchange identifier (MIC or Intrinio ID)
+
+opts = { 
+  date: Date.parse("2018-08-14"), # Date | The date for which to return price adjustments
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = stockExchange_api.get_stock_exchange_price_adjustments(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling StockExchangeApi->get_stock_exchange_price_adjustments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) | 
+ **date** | **Date**| The date for which to return price adjustments | [optional] 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseStockExchangeStockPriceAdjustments**](ApiResponseStockExchangeStockPriceAdjustments.md)
+
+# **get_stock_exchange_prices**
+> ApiResponseStockExchangeStockPrices get_stock_exchange_prices(identifier, opts)
+
+Get Stock Prices by Exchange
+
+Return daily Stock Prices for Securities on the Stock Exchange with `identifier` and on the `price_date` (or the latest date that prices are available)
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+stockExchange_api = Intrinio::StockExchangeApi.new
+
+identifier = "USCOMP" # String | A Stock Exchange identifier (MIC or Intrinio ID)
+
+opts = { 
+  date: Date.parse("2018-08-14"), # Date | The date for which to return prices
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = stockExchange_api.get_stock_exchange_prices(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling StockExchangeApi->get_stock_exchange_prices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) | 
+ **date** | **Date**| The date for which to return prices | [optional] 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseStockExchangeStockPrices**](ApiResponseStockExchangeStockPrices.md)
+
+# **get_stock_exchange_securities**
+> ApiResponseStockExchangeSecurities get_stock_exchange_securities(identifier, opts)
+
+Get Securities by Exchange
+
+Return Securities traded on the Stock Exchange with `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+stockExchange_api = Intrinio::StockExchangeApi.new
+
+identifier = "USCOMP" # String | A Stock Exchange identifier (MIC or Intrinio ID)
+
+opts = { 
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = stockExchange_api.get_stock_exchange_securities(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling StockExchangeApi->get_stock_exchange_securities: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) | 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseStockExchangeSecurities**](ApiResponseStockExchangeSecurities.md)
+

data/docs/StockMarketIndex.md

@@ -0,0 +1,17 @@
+# Intrinio::StockMarketIndex
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Intrinio ID for the Index | [optional] 
+**symbol** | **String** | The symbol used to identify the Index | [optional] 
+**name** | **String** | The name of the Index | [optional] 
+**continent** | **String** | The continent of the country of focus for the Index | [optional] 
+**country** | **String** | The country of focus for the Index | [optional] 
+**update_frequency** | **String** | How often the Index is updated | [optional] 
+**last_updated** | **DateTime** | When the Index was updated last | [optional] 
+**description** | **String** | A paragraph describing the index and its scope | [optional] 
+**observation_start** | **Date** | The earliest date for which data is available | [optional] 
+**observation_end** | **Date** | The latest date for which data is available | [optional] 
+
+

data/docs/StockMarketIndexSummary.md

@@ -0,0 +1,16 @@
+# Intrinio::StockMarketIndexSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Intrinio ID for the Index | [optional] 
+**symbol** | **String** | The symbol used to identify the Index | [optional] 
+**name** | **String** | The name of the Index | [optional] 
+**continent** | **String** | The continent of the country of focus for the Index | [optional] 
+**country** | **String** | The country of focus for the Index | [optional] 
+**update_frequency** | **String** | How often the Index is updated | [optional] 
+**last_updated** | **DateTime** | When the Index was updated last | [optional] 
+**observation_start** | **Date** | The earliest date for which data is available | [optional] 
+**observation_end** | **Date** | The latest date for which data is available | [optional] 
+
+

data/docs/StockPrice.md

@@ -0,0 +1,21 @@
+# Intrinio::StockPrice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **Date** | The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc) | [optional] 
+**intraperiod** | **BOOLEAN** | If true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period | [optional] 
+**frequency** | **String** | The type of period that the stock price represents | [optional] 
+**open** | **Float** | The price at the beginning of the period | [optional] 
+**high** | **Float** | The highest price over the span of the period | [optional] 
+**low** | **Float** | The lowest price over the span of the period | [optional] 
+**close** | **Float** | The price at the end of the period | [optional] 
+**volume** | **Float** | The number of shares exchanged during the period | [optional] 
+**adj_open** | **Float** | The price at the beginning of the period, adjusted for splits and dividends | [optional] 
+**adj_high** | **Float** | The highest price over the span of the period, adjusted for splits and dividends | [optional] 
+**adj_low** | **Float** | The lowest price over the span of the period, adjusted for splits and dividends | [optional] 
+**adj_close** | **Float** | The price at the end of the period, adjusted for splits and dividends | [optional] 
+**adj_volume** | **Float** | The number of shares exchanged during the period, adjusted for splits and dividends | [optional] 
+**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the stock price | [optional] 
+
+

data/docs/StockPriceAdjustment.md

@@ -0,0 +1,12 @@
+# Intrinio::StockPriceAdjustment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **Date** | The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date. | [optional] 
+**factor** | **Float** | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. | [optional] 
+**dividend** | **Float** | The dividend amount, if a dividend was paid. | [optional] 
+**dividend_currency** | **String** | The currency of the dividend, if known. | [optional] 
+**split_ratio** | **Float** | The ratio of the stock split, if a stock split occurred. | [optional] 
+
+

data/docs/StockPriceAdjustmentSummary.md

@@ -0,0 +1,13 @@
+# Intrinio::StockPriceAdjustmentSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **Date** | The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date. | [optional] 
+**factor** | **Float** | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. | [optional] 
+**dividend** | **Float** | The dividend amount, if a dividend was paid. | [optional] 
+**dividend_currency** | **String** | The currency of the dividend, if known. | [optional] 
+**split_ratio** | **Float** | The ratio of the stock split, if a stock split occurred. | [optional] 
+**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the stock price | [optional] 
+
+