Skip to content

Latest commit

 

History

History
412 lines (243 loc) · 11.1 KB

OwnersApi.md

File metadata and controls

412 lines (243 loc) · 11.1 KB

intrinio_sdk.OwnersApi

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

Method HTTP request Description
get_all_owners GET /owners All Owners
get_owner_by_id GET /owners/{identifier} Owner by ID
insider_transaction_filings_by_owner GET /owners/{identifier}/insider_transaction_filings Insider Transaction Filings by Owner
institutional_holdings_by_owner GET /owners/{identifier}/institutional_holdings Institutional Holdings by Owner
search_owners GET /owners/search Search Owners

get_all_owners

View Intrinio API Documentation

ApiResponseOwners get_all_owners(institutional=institutional, page_size=page_size, next_page=next_page)

All Owners

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

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

institutional = ''
page_size = 100
next_page = ''

response = intrinio.OwnersApi().get_all_owners(institutional=institutional, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

Name Type Description Notes
institutional bool 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]  
page_size int The number of results to return [optional] [default to 100]  
next_page str Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOwners

get_owner_by_id

View Intrinio API Documentation

Owner get_owner_by_id(identifier)

Owner by ID

Returns the Owner with the given ID

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = '0000001800'

response = intrinio.OwnersApi().get_owner_by_id(identifier)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

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

Return type

Owner

insider_transaction_filings_by_owner

View Intrinio API Documentation

ApiResponseOwnerInsiderTransactionFilings insider_transaction_filings_by_owner(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page)

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

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = '0001494730'
start_date = '2018-01-01'
end_date = '2019-01-01'
page_size = 100
next_page = ''

response = intrinio.OwnersApi().insider_transaction_filings_by_owner(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

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

Return type

ApiResponseOwnerInsiderTransactionFilings

institutional_holdings_by_owner

View Intrinio API Documentation

ApiResponseOwnerInstitutionalHoldings institutional_holdings_by_owner(identifier, page_size=page_size, as_of_date=as_of_date, next_page=next_page)

Institutional Holdings by Owner

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

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = '430692'
page_size = 100
as_of_date = '2021-01-05'
next_page = ''

response = intrinio.OwnersApi().institutional_holdings_by_owner(identifier, page_size=page_size, as_of_date=as_of_date, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

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

Return type

ApiResponseOwnerInstitutionalHoldings

search_owners

View Intrinio API Documentation

ApiResponseOwners search_owners(query, institutional=institutional, page_size=page_size, next_page=next_page)

Search Owners

Searches for Owners matching the text query

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

query = 'Cook'
institutional = ''
page_size = 100
next_page = ''

response = intrinio.OwnersApi().search_owners(query, institutional=institutional, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

Name Type Description Notes
query str  
institutional bool 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]  
page_size int The number of results to return [optional] [default to 100]  
next_page str Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOwners