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 |
View Intrinio API Documentation
ApiResponseOwners get_all_owners(opts)
Returns all owners and information for all insider and institutional owners of securities covered by Intrinio.
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
OwnersApi <- IntrinioSDK::OwnersApi$new(client)
# Optional params
opts <- list(
institutional = NULL,
page_size = 100,
next_page = NULL
)
response <- OwnersApi$get_all_owners(opts)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| institutional | Logical | 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 | Integer | The number of results to return | [optional] [default to 100] |
| next_page | Character | Gets the next page of data from a previous API call | [optional] |
View Intrinio API Documentation
Owner get_owner_by_id(identifier)
Returns the Owner with the given ID
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
OwnersApi <- IntrinioSDK::OwnersApi$new(client)
# Required params
identifier <- "0000001800"
response <- OwnersApi$get_owner_by_id(identifier)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| identifier | Character | An Intrinio ID or CIK of an Owner |
View Intrinio API Documentation
ApiResponseOwnerInsiderTransactionFilings insider_transaction_filings_by_owner(identifier, opts)
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.
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
OwnersApi <- IntrinioSDK::OwnersApi$new(client)
# Required params
identifier <- "0001494730"
# Optional params
opts <- list(
start_date = as.Date("2018-01-01"),
end_date = as.Date("2019-01-01"),
page_size = 100,
next_page = NULL
)
response <- OwnersApi$insider_transaction_filings_by_owner(identifier, opts)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| identifier | Character | 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 | Integer | The number of results to return | [optional] [default to 100] |
| next_page | Character | Gets the next page of data from a previous API call | [optional] |
ApiResponseOwnerInsiderTransactionFilings
View Intrinio API Documentation
ApiResponseOwnerInstitutionalHoldings institutional_holdings_by_owner(identifier, opts)
Returns a list of all ownership interests and the value of their interests by a single institutional owner.
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
OwnersApi <- IntrinioSDK::OwnersApi$new(client)
# Required params
identifier <- 430692
# Optional params
opts <- list(
page_size = 100,
as_of_date = as.Date("2021-01-05"),
next_page = NULL
)
response <- OwnersApi$institutional_holdings_by_owner(identifier, opts)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| identifier | Character | The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. | |
| page_size | Integer | The number of results to return | [optional] [default to 100] |
| as_of_date | Date | Return only holdings filed before this date. | [optional] |
| next_page | Character | Gets the next page of data from a previous API call | [optional] |
ApiResponseOwnerInstitutionalHoldings
View Intrinio API Documentation
ApiResponseOwners search_owners(query, opts)
Searches for Owners matching the text query
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
OwnersApi <- IntrinioSDK::OwnersApi$new(client)
# Required params
query <- "Cook"
# Optional params
opts <- list(
institutional = NULL,
page_size = 100,
next_page = NULL
)
response <- OwnersApi$search_owners(query, opts)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| query | Character | ||
| institutional | Logical | 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 | Integer | The number of results to return | [optional] [default to 100] |
| next_page | Character | Gets the next page of data from a previous API call | [optional] |