intrinio-sdk 1.0.0

data/docs/ReportedFinancial.md

@@ -0,0 +1,9 @@
+# Intrinio::ReportedFinancial
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**xbrl_tag** | [**ReportedTag**](ReportedTag.md) |  | [optional] 
+**value** | **Float** | The value reported for the XBRL Tag within the scope of the Fundamental | [optional] 
+
+

data/docs/ReportedTag.md

@@ -0,0 +1,14 @@
+# Intrinio::ReportedTag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | The tag code | [optional] 
+**name** | **String** | The tag name | [optional] 
+**balance** | **String** | Whether the tag represents a credit or debit | [optional] 
+**unit** | **String** | The unit of the tag | [optional] 
+**abstract** | **BOOLEAN** | If true, the tag is an abstract and does not represent a nominal value | [optional] 
+**sequence** | **Integer** | The vertical sequence of the tag when displayed in the financial statement | [optional] 
+**depth** | **Integer** | The horizontal depth of the tag when displayed in the financial statement | [optional] 
+
+

data/docs/SICIndex.md

@@ -0,0 +1,12 @@
+# Intrinio::SICIndex
+
+## 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] 
+
+

data/docs/Security.md

@@ -0,0 +1,34 @@
+# Intrinio::Security
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the 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] 
+**type** | **String** | The Security's type | [optional] 
+**code** | **String** | A 2-3 digit code classifying the Security | [optional] 
+**share_class** | **String** | The Security's share class (if applicable) | [optional] 
+**currency** | **String** | The currency in which the Security is traded on the exchange | [optional] 
+**round_lot_size** | **Float** | The normal unit of trading | [optional] 
+**ticker** | **String** | The common ticker | [optional] 
+**exchange_ticker** | **String** | The exchange-level ticker | [optional] 
+**composite_ticker** | **String** | The country-composite ticker | [optional] 
+**alternate_tickers** | **Array<String>** | Alternate formats of the common ticker | [optional] 
+**figi** | **String** | The exchange-level OpenFIGI identifier | [optional] 
+**cik** | **String** | Central Index Key issued by the SEC, which is the unique identifier for all owner filings | [optional] 
+**composite_figi** | **String** | The country-composite OpenFIGI identifier | [optional] 
+**share_class_figi** | **String** | The global-composite OpenFIGI identifier | [optional] 
+**figi_uniqueid** | **String** | The OpenFIGI unique ID | [optional] 
+**active** | **BOOLEAN** | If true, the Security is active and has been recently traded | [optional] 
+**etf** | **BOOLEAN** | If true, this Security is an ETF | [optional] 
+**delisted** | **BOOLEAN** | If true, the Security is no longer traded on the exchange | [optional] 
+**primary_listing** | **BOOLEAN** | If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange | [optional] 
+**primary_security** | **BOOLEAN** | If true, the Security is considered by Intrinio to be the primary Security for its company | [optional] 
+**first_stock_price** | **Date** | The date of the first recorded stock price | [optional] 
+**last_stock_price** | **Date** | The date of the last recorded stock price (or the most recent trading day) | [optional] 
+**last_stock_price_adjustment** | **Date** | The date of the last stock price adjustment (dividend, split, etc) | [optional] 
+**last_corporate_action** | **Date** | The date of the last corporate action | [optional] 
+**previous_tickers** | **Array<String>** | Previous tickers used by this security | [optional] 
+
+

data/docs/SecurityApi.md

@@ -0,0 +1,420 @@
+# Intrinio::SecurityApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_all_securities**](SecurityApi.md#get_all_securities) | **GET** /securities | Get All Securiites
+[**get_security_by_id**](SecurityApi.md#get_security_by_id) | **GET** /securities/{identifier} | Get a Security by ID
+[**get_security_data_point_number**](SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Get Security Data Point (Number)
+[**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Get Security Data Point (Text)
+[**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Get Security Historical Data
+[**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Get Stock Price Adjustments for Security
+[**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Get Stock Prices for Security
+[**screen_securities**](SecurityApi.md#screen_securities) | **POST** /securities/screen | Screen Securities
+[**search_securities**](SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities
+
+
+# **get_all_securities**
+> ApiResponseSecurities get_all_securities(opts)
+
+Get All Securiites
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+security_api = Intrinio::SecurityApi.new
+
+opts = { 
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = security_api.get_all_securities(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_all_securities: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseSecurities**](ApiResponseSecurities.md)
+
+# **get_security_by_id**
+> Security get_security_by_id(identifier)
+
+Get a Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+
+begin
+  result = security_api.get_security_by_id(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+
+### Return type
+
+[**Security**](Security.md)
+
+# **get_security_data_point_number**
+> Float get_security_data_point_number(identifier, tag)
+
+Get Security Data Point (Number)
+
+Returns a numeric value for the given `tag` for the Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+tag = "52_week_high" # String | An Intrinio data tag ID or code-name
+
+
+begin
+  result = security_api.get_security_data_point_number(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_data_point_number: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**Float**
+
+# **get_security_data_point_text**
+> String get_security_data_point_text(identifier, tag)
+
+Get Security Data Point (Text)
+
+Returns a text value for the given `tag` for the Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+tag = "figi" # String | An Intrinio data tag ID or code-name
+
+
+begin
+  result = security_api.get_security_data_point_text(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_data_point_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**String**
+
+# **get_security_historical_data**
+> ApiResponseSecurityHistoricalData get_security_historical_data(identifier, tag, opts)
+
+Get Security Historical Data
+
+Returns historical values for the given `tag` and the Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+tag = "volume" # String | An Intrinio data tag ID or code-name
+
+opts = { 
+  type: nil, # String | Filter by type, when applicable
+  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
+  end_date: Date.parse("2019-01-01"), # Date | Get historical date on or before this date
+  sort_order: "desc", # String | Sort by date `asc` or `desc`
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = security_api.get_security_historical_data(identifier, tag, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_historical_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+ **type** | **String**| Filter by type, when applicable | [optional] 
+ **start_date** | **Date**| Get historical data on or after this date | [optional] 
+ **end_date** | **Date**| Get historical date on or before this date | [optional] 
+ **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md)
+
+# **get_security_stock_price_adjustments**
+> ApiResponseSecurityStockPriceAdjustments get_security_stock_price_adjustments(identifier, opts)
+
+Get Stock Price Adjustments for Security
+
+Return stock price adjustments for the Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+opts = { 
+  start_date: Date.parse("2018-01-01"), # Date | Return price adjustments on or after the date
+  end_date: Date.parse("2019-01-01"), # Date | Return price adjustments on or before the date
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = security_api.get_security_stock_price_adjustments(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_stock_price_adjustments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+ **start_date** | **Date**| Return price adjustments on or after the date | [optional] 
+ **end_date** | **Date**| Return price adjustments on or before the date | [optional] 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseSecurityStockPriceAdjustments**](ApiResponseSecurityStockPriceAdjustments.md)
+
+# **get_security_stock_prices**
+> ApiResponseSecurityStockPrices get_security_stock_prices(identifier, opts)
+
+Get Stock Prices for Security
+
+Return stock prices for the Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+opts = { 
+  start_date: Date.parse("2018-01-01"), # Date | Return prices on or after the date
+  end_date: Date.parse("2019-01-01"), # Date | Return prices on or before the date
+  frequency: "daily", # String | Return stock prices in the given frequency
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = security_api.get_security_stock_prices(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_stock_prices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+ **start_date** | **Date**| Return prices on or after the date | [optional] 
+ **end_date** | **Date**| Return prices on or before the date | [optional] 
+ **frequency** | **String**| Return stock prices in the given frequency | [optional] [default to daily]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md)
+
+# **screen_securities**
+> Array<SecurityScreenResult> screen_securities(opts)
+
+Screen Securities
+
+Screen securities using complex logic
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+security_api = Intrinio::SecurityApi.new
+
+opts = { 
+  logic: Intrinio::SecurityScreenGroup.new, # SecurityScreenGroup | The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions.
+  order_column: "order_column_example", # String | Results returned sorted by this column
+  order_direction: "asc", # String | Sort order to use with the order_column
+  primary_only: false # BOOLEAN | Return only primary securities
+}
+
+begin
+  result = security_api.screen_securities(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->screen_securities: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions. | [optional] 
+ **order_column** | **String**| Results returned sorted by this column | [optional] 
+ **order_direction** | **String**| Sort order to use with the order_column | [optional] [default to asc]
+ **primary_only** | **BOOLEAN**| Return only primary securities | [optional] [default to false]
+
+### Return type
+
+[**Array&lt;SecurityScreenResult&gt;**](SecurityScreenResult.md)
+
+# **search_securities**
+> ApiResponseSecurities search_securities(query)
+
+Search Securities
+
+Searches for Securities matching the text `query`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+security_api = Intrinio::SecurityApi.new
+
+query = "Apple" # String | 
+
+
+begin
+  result = security_api.search_securities(query)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->search_securities: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**|  | 
+
+### Return type
+
+[**ApiResponseSecurities**](ApiResponseSecurities.md)
+