class Intrinio::OwnersApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/intrinio-sdk/api/owners_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_all_owners(opts = {}) click to toggle source

All Owners Returns all owners and information for all insider and institutional owners of securities covered by Intrinio. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :institutional Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. @option opts [Integer] :page_size The number of results to return (default to 100) @option opts [String] :next_page Gets the next page of data from a previous API call @return [ApiResponseOwners]

# File lib/intrinio-sdk/api/owners_api.rb, line 30
def get_all_owners(opts = {})
  data, _status_code, _headers = get_all_owners_with_http_info(opts)
  return data
end
get_all_owners_with_http_info(opts = {}) click to toggle source

All Owners Returns all owners and information for all insider and institutional owners of securities covered by Intrinio. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :institutional Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. @option opts [Integer] :page_size The number of results to return @option opts [String] :next_page Gets the next page of data from a previous API call @return [Array<(ApiResponseOwners, Fixnum, Hash)>] ApiResponseOwners data, response status code and response headers

# File lib/intrinio-sdk/api/owners_api.rb, line 42
def get_all_owners_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OwnersApi.get_all_owners ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OwnersApi.get_all_owners, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/owners"

  # query parameters
  query_params = {}
  query_params[:'institutional'] = opts[:'institutional'] if !opts[:'institutional'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseOwners')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnersApi#get_all_owners\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_owner_by_id(identifier, opts = {}) click to toggle source

Owner by ID Returns the Owner with the given ID @param identifier An Intrinio ID or CIK of an Owner @param [Hash] opts the optional parameters @return [Owner]

# File lib/intrinio-sdk/api/owners_api.rb, line 88
def get_owner_by_id(identifier, opts = {})
  data, _status_code, _headers = get_owner_by_id_with_http_info(identifier, opts)
  return data
end
get_owner_by_id_with_http_info(identifier, opts = {}) click to toggle source

Owner by ID Returns the Owner with the given ID @param identifier An Intrinio ID or CIK of an Owner @param [Hash] opts the optional parameters @return [Array<(Owner, Fixnum, Hash)>] Owner data, response status code and response headers

# File lib/intrinio-sdk/api/owners_api.rb, line 98
def get_owner_by_id_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OwnersApi.get_owner_by_id ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling OwnersApi.get_owner_by_id"
  end
  # resource path
  local_var_path = "/owners/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Owner')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnersApi#get_owner_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
insider_transaction_filings_by_owner(identifier, opts = {}) click to toggle source

Insider Transaction Filings by Owner Returns a list of all insider transaction filings by an owner in as many companies as the owner may be considered an insider. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider. @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. @param [Hash] opts the optional parameters @option opts [Date] :start_date Return Owner&#39;s insider transaction filings on or after this date @option opts [Date] :end_date Return Owner&#39;s insider transaction filings on or before this date @option opts [Integer] :page_size The number of results to return (default to 100) @option opts [String] :next_page Gets the next page of data from a previous API call @return [ApiResponseOwnerInsiderTransactionFilings]

# File lib/intrinio-sdk/api/owners_api.rb, line 145
def insider_transaction_filings_by_owner(identifier, opts = {})
  data, _status_code, _headers = insider_transaction_filings_by_owner_with_http_info(identifier, opts)
  return data
end
insider_transaction_filings_by_owner_with_http_info(identifier, opts = {}) click to toggle source

Insider Transaction Filings by Owner Returns a list of all insider transaction filings by an owner in as many companies as the owner may be considered an insider. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider. @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. @param [Hash] opts the optional parameters @option opts [Date] :start_date Return Owner&#39;s insider transaction filings on or after this date @option opts [Date] :end_date Return Owner&#39;s insider transaction filings on or before this date @option opts [Integer] :page_size The number of results to return @option opts [String] :next_page Gets the next page of data from a previous API call @return [Array<(ApiResponseOwnerInsiderTransactionFilings, Fixnum, Hash)>] ApiResponseOwnerInsiderTransactionFilings data, response status code and response headers

# File lib/intrinio-sdk/api/owners_api.rb, line 159
def insider_transaction_filings_by_owner_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OwnersApi.insider_transaction_filings_by_owner ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling OwnersApi.insider_transaction_filings_by_owner"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OwnersApi.insider_transaction_filings_by_owner, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/owners/{identifier}/insider_transaction_filings".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseOwnerInsiderTransactionFilings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnersApi#insider_transaction_filings_by_owner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
institutional_holdings_by_owner(identifier, opts = {}) click to toggle source

Institutional Holdings by Owner Returns a list of all ownership interests and the value of their interests by a single institutional owner. @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. @param [Hash] opts the optional parameters @option opts [Integer] :page_size The number of results to return (default to 100) @option opts [Object] :as_of_date Return only holdings filed before this date. @option opts [String] :next_page Gets the next page of data from a previous API call @return [ApiResponseOwnerInstitutionalHoldings]

# File lib/intrinio-sdk/api/owners_api.rb, line 213
def institutional_holdings_by_owner(identifier, opts = {})
  data, _status_code, _headers = institutional_holdings_by_owner_with_http_info(identifier, opts)
  return data
end
institutional_holdings_by_owner_with_http_info(identifier, opts = {}) click to toggle source

Institutional Holdings by Owner Returns a list of all ownership interests and the value of their interests by a single institutional owner. @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. @param [Hash] opts the optional parameters @option opts [Integer] :page_size The number of results to return @option opts [Object] :as_of_date Return only holdings filed before this date. @option opts [String] :next_page Gets the next page of data from a previous API call @return [Array<(ApiResponseOwnerInstitutionalHoldings, Fixnum, Hash)>] ApiResponseOwnerInstitutionalHoldings data, response status code and response headers

# File lib/intrinio-sdk/api/owners_api.rb, line 226
def institutional_holdings_by_owner_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OwnersApi.institutional_holdings_by_owner ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling OwnersApi.institutional_holdings_by_owner"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OwnersApi.institutional_holdings_by_owner, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/owners/{identifier}/institutional_holdings".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'as_of_date'] = opts[:'as_of_date'] if !opts[:'as_of_date'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseOwnerInstitutionalHoldings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnersApi#institutional_holdings_by_owner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
search_owners(query, opts = {}) click to toggle source

Search Owners Searches for Owners matching the text `query` @param query @param [Hash] opts the optional parameters @option opts [BOOLEAN] :institutional Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. @option opts [Integer] :page_size The number of results to return (default to 100) @option opts [String] :next_page Gets the next page of data from a previous API call @return [ApiResponseOwners]

# File lib/intrinio-sdk/api/owners_api.rb, line 279
def search_owners(query, opts = {})
  data, _status_code, _headers = search_owners_with_http_info(query, opts)
  return data
end
search_owners_with_http_info(query, opts = {}) click to toggle source

Search Owners Searches for Owners matching the text &#x60;query&#x60; @param query @param [Hash] opts the optional parameters @option opts [BOOLEAN] :institutional Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. @option opts [Integer] :page_size The number of results to return @option opts [String] :next_page Gets the next page of data from a previous API call @return [Array<(ApiResponseOwners, Fixnum, Hash)>] ApiResponseOwners data, response status code and response headers

# File lib/intrinio-sdk/api/owners_api.rb, line 292
def search_owners_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OwnersApi.search_owners ..."
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling OwnersApi.search_owners"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OwnersApi.search_owners, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/owners/search"

  # query parameters
  query_params = {}
  query_params[:'query'] = query
  query_params[:'institutional'] = opts[:'institutional'] if !opts[:'institutional'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseOwners')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OwnersApi#search_owners\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end