Skip to content

Latest commit

 

History

History
442 lines (256 loc) · 10.8 KB

OwnersApi.md

File metadata and controls

442 lines (256 loc) · 10.8 KB

intrinioSDK.OwnersApi

All URIs are relative to https://api-v2.intrinio.com

Method HTTP request Description
getAllOwners GET /owners All Owners
getOwnerById GET /owners/{identifier} Owner by ID
insiderTransactionFilingsByOwner GET /owners/{identifier}/insider_transaction_filings Insider Transaction Filings by Owner
institutionalHoldingsByOwner GET /owners/{identifier}/institutional_holdings Institutional Holdings by Owner
searchOwners GET /owners/search Search Owners

getAllOwners

View Intrinio API Documentation

ApiResponseOwners getAllOwners(opts)

All Owners

Returns all owners and information for all insider and institutional owners of securities covered by Intrinio.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var owners = new intrinioSDK.OwnersApi();

var opts = { 
  'institutional': null,
  'pageSize': 100,
  'nextPage': null
};

owners.getAllOwners(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
institutional Boolean Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOwners

getOwnerById

View Intrinio API Documentation

Owner getOwnerById(identifier)

Owner by ID

Returns the Owner with the given ID

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var owners = new intrinioSDK.OwnersApi();

var identifier = "0000001800";


owners.getOwnerById(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String An Intrinio ID or CIK of an Owner  

Return type

Owner

insiderTransactionFilingsByOwner

View Intrinio API Documentation

ApiResponseOwnerInsiderTransactionFilings insiderTransactionFilingsByOwner(identifier, opts)

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.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var owners = new intrinioSDK.OwnersApi();

var identifier = "0001494730";


var opts = { 
  'startDate': new Date("2018-01-01"),
  'endDate': new Date("2019-01-01"),
  'pageSize': 100,
  'nextPage': null
};

owners.insiderTransactionFilingsByOwner(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under.  
startDate Date Return Owner's insider transaction filings on or after this date [optional]  
endDate Date Return Owner's insider transaction filings on or before this date [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOwnerInsiderTransactionFilings

institutionalHoldingsByOwner

View Intrinio API Documentation

ApiResponseOwnerInstitutionalHoldings institutionalHoldingsByOwner(identifier, opts)

Institutional Holdings by Owner

Returns a list of all ownership interests and the value of their interests by a single institutional owner.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var owners = new intrinioSDK.OwnersApi();

var identifier = "430692";


var opts = { 
  'pageSize': 100,
  'asOfDate': new Date("2021-01-05"),
  'nextPage': null
};

owners.institutionalHoldingsByOwner(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under.  
pageSize Number The number of results to return [optional] [default to 100]  
asOfDate Date Return only holdings filed before this date. [optional]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOwnerInstitutionalHoldings

searchOwners

View Intrinio API Documentation

ApiResponseOwners searchOwners(query, opts)

Search Owners

Searches for Owners matching the text `query`

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var owners = new intrinioSDK.OwnersApi();

var query = "Cook";


var opts = { 
  'institutional': null,
  'pageSize': 100,
  'nextPage': null
};

owners.searchOwners(query, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
query String  
institutional Boolean Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOwners