Skip to content

Latest commit

 

History

History
457 lines (288 loc) · 12.3 KB

OwnersApi.md

File metadata and controls

457 lines (288 loc) · 12.3 KB
Raw

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(institutional, pageSize, nextPage)

All Owners

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    OwnersApi ownersApi = new OwnersApi();
    Boolean institutional = null;
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseOwners result = ownersApi.getAllOwners(institutional, pageSize, nextPage);
    System.out.println(result);
  }
}

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 Integer 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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    OwnersApi ownersApi = new OwnersApi();
    String identifier = "0000001800";
    Owner result = ownersApi.getOwnerById(identifier);
    System.out.println(result);
  }
}

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, startDate, endDate, pageSize, nextPage)

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    OwnersApi ownersApi = new OwnersApi();
    String identifier = "0001494730";
    LocalDate startDate = LocalDate.of(2018,1,01);
    LocalDate endDate = LocalDate.of(2019,1,01);
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseOwnerInsiderTransactionFilings result = ownersApi.insiderTransactionFilingsByOwner(identifier, startDate, endDate, pageSize, nextPage);
    System.out.println(result);
  }
}

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 LocalDate Return Owner's insider transaction filings on or after this date [optional]  
endDate LocalDate Return Owner's insider transaction filings on or before this date [optional]  
pageSize Integer 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, pageSize, asOfDate, nextPage)

Institutional Holdings by Owner

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    OwnersApi ownersApi = new OwnersApi();
    String identifier = "430692";
    Integer pageSize = 100;
    LocalDate asOfDate = LocalDate.of(2021,1,05);
    String nextPage = null;
    ApiResponseOwnerInstitutionalHoldings result = ownersApi.institutionalHoldingsByOwner(identifier, pageSize, asOfDate, nextPage);
    System.out.println(result);
  }
}

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 Integer The number of results to return [optional] [default to 100]  
asOfDate LocalDate 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, institutional, pageSize, nextPage)

Search Owners

Searches for Owners matching the text `query`

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    OwnersApi ownersApi = new OwnersApi();
    String query = "Cook";
    Boolean institutional = null;
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseOwners result = ownersApi.searchOwners(query, institutional, pageSize, nextPage);
    System.out.println(result);
  }
}

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 Integer 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