SecurityApi.md in intrinio-sdk-2.0.0

- old
+ new

@@ -7,10 +7,11 @@
 [**get_all_securities**](SecurityApi.md#get_all_securities) | **GET** /securities | All Securities
 [**get_security_by_id**](SecurityApi.md#get_security_by_id) | **GET** /securities/{identifier} | Lookup Security
 [**get_security_data_point_number**](SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Data Point (Number) for Security
 [**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
 [**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
+[**get_security_intraday_prices**](SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
 [**get_security_latest_dividend_record**](SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Lastest Dividend Record for Security
 [**get_security_latest_earnings_record**](SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Lastest Earnings Record for Security
 [**get_security_realtime_price**](SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
 [**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
 [**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
@@ -34,10 +35,11 @@
 end
 
 security_api = Intrinio::SecurityApi.new
 
 opts = { 
+  page_size: 100, # Float | The number of results to return
   next_page: nil # String | Gets the next page of data from a previous API call
 }
 
 begin
   result = security_api.get_all_securities(opts)
@@ -49,10 +51,11 @@
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
 
 ### Return type
 
 [**ApiResponseSecurities**](ApiResponseSecurities.md)
@@ -210,10 +213,11 @@
   frequency: "daily", # String | Return historical data in the given frequency
   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`
+  page_size: 100, # Float | The number of results to return
   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)
@@ -232,16 +236,69 @@
  **frequency** | **String**| Return historical data in the given frequency | [optional] [default to daily]
  **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 &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc]
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
 
 ### Return type
 
 [**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md)
 
+# **get_security_intraday_prices**
+> ApiResponseSecurityIntradayPrices get_security_intraday_prices(identifier, opts)
+
+Intraday Stock Prices for Security
+
+Return intraday 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 = { 
+  source: nil, # String | Return intraday prices from the specified data source
+  start_date: Date.parse("2018-01-01"), # Date | Return intraday prices starting at the specified date
+  start_time: "4200", # String | Return intraday prices starting at the specified time on the `start_date` (timezone is UTC)
+  end_date: Date.parse("2018-01-01"), # Date | Return intraday prices stopping at the specified date
+  end_time: "4200" # String | Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC)
+}
+
+begin
+  result = security_api.get_security_intraday_prices(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_intraday_prices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+ **source** | **String**| Return intraday prices from the specified data source | [optional] 
+ **start_date** | **Date**| Return intraday prices starting at the specified date | [optional] 
+ **start_time** | **String**| Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (timezone is UTC) | [optional] 
+ **end_date** | **Date**| Return intraday prices stopping at the specified date | [optional] 
+ **end_time** | **String**| Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (timezone is UTC) | [optional] 
+
+### Return type
+
+[**ApiResponseSecurityIntradayPrices**](ApiResponseSecurityIntradayPrices.md)
+
 # **get_security_latest_dividend_record**
 > DividendRecord get_security_latest_dividend_record(identifier)
 
 Lastest Dividend Record for Security
 
@@ -386,10 +443,11 @@
 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
+  page_size: 100, # Float | The number of results to return
   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)
@@ -404,10 +462,11 @@
 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] 
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
 
 ### Return type
 
 [**ApiResponseSecurityStockPriceAdjustments**](ApiResponseSecurityStockPriceAdjustments.md)
@@ -435,10 +494,11 @@
 
 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
+  page_size: 100, # Float | The number of results to return
   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)
@@ -454,10 +514,11 @@
 ------------- | ------------- | ------------- | -------------
  **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]
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
 
 ### Return type
 
 [**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md)
@@ -483,11 +544,12 @@
 
 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
+  primary_only: false, # BOOLEAN | Return only primary securities
+  page_size: 100 # Float | The number of results to return
 }
 
 begin
   result = security_api.screen_securities(opts)
   p result
@@ -502,17 +564,18 @@
 ------------- | ------------- | ------------- | -------------
  **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]
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
 
 ### Return type
 
 [**Array&lt;SecurityScreenResult&gt;**](SecurityScreenResult.md)
 
 # **search_securities**
-> ApiResponseSecurities search_securities(query)
+> ApiResponseSecuritiesSearch search_securities(query, opts)
 
 Search Securities
 
 Searches for Securities matching the text `query`
 
@@ -528,13 +591,16 @@
 
 security_api = Intrinio::SecurityApi.new
 
 query = "Apple" # String | 
 
+opts = { 
+  page_size: 100 # Float | The number of results to return
+}
 
 begin
-  result = security_api.search_securities(query)
+  result = security_api.search_securities(query, opts)
   p result
 rescue Intrinio::ApiError => e
   puts "Exception when calling SecurityApi->search_securities: #{e}"
 end
 ```
@@ -542,10 +608,11 @@
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | **String**|  | 
+ **page_size** | **Float**| The number of results to return | [optional] [default to 100]
 
 ### Return type
 
-[**ApiResponseSecurities**](ApiResponseSecurities.md)
+[**ApiResponseSecuritiesSearch**](ApiResponseSecuritiesSearch.md)
 