Screen Securities

SDKs

C# SDK

Java SDK

JavaScript SDK

Python SDK

R SDK

Ruby SDK

Sales Estimates - API Endpoints

Security Reference Data

All Securities

Lookup Security

Search Securities

Real-Time Prices

Data Point (Number) for Security

Historical End of Day Prices

Historical Data for Security

Screener

Screen Securities

No endpoints match your query.

Not familiar with our API? checkout our getting started page .

Screen Securities R API Documentation

Intrinio Market Data IconBack to Product Docs

Screen Securities using complex logic. Use POST only. See screener documentation for details on how to construct conditions.

API Class:
IntrinioSDK::SecurityApi
Instance Method:
screen_securities()

Stock Price Code Example

Use my API Key
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
SecurityApi <- IntrinioSDK::SecurityApi$new(client)
# Optional params
opts <- list(
logic = IntrinioSDK::SecurityScreenGroup$new(),
order_column = "marketcap",
order_direction = "asc",
primary_only = FALSE,
page_size = 100
)
response <- SecurityApi$screen_securities(opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
logicSecurityScreenGroupThe logic to screen with, consisting of operators, clauses, and nested groups.
See screener documentation for details on how to construct conditions.		[optional]  
order_columnCharacterResults returned sorted by this column[optional]  
order_directionCharacterSort order to use with the order_column[optional] [default to asc]  
primary_onlyLogicalReturn only primary securities[optional] [default to FALSE]  
page_sizeIntegerThe number of results to return. Maximum for this endpoint is 50000.[optional] [default to 100]  


Return Type

object
IntrinioSDK::SecurityScreenResult

Properties

NameTypeDescription
securitySecuritySummary 
dataList of SecurityScreenResultData 
data_data_frameData FrameData frame representation of data
object
IntrinioSDK::SecuritySummary

Properties

NameTypeDescription
idCharacterThe Intrinio ID for Security  
company_idCharacterThe Intrinio ID for the Company for which the Security is issued  
exchangeCharacterThe exchange's MIC  
exchange_micCharacterThe security's exchange MIC  
stock_exchange_idCharacterThe exchange's Intrinio ID  
nameCharacterThe name of the Security  
codeCharacterA 2-3 digit code classifying the Security (reference)  
currencyCharacterThe currency in which the Security is traded on the exchange  
tickerCharacterThe common/local ticker of the Security  
composite_tickerCharacterThe country-composite ticker of the Security  
figiCharacterThe OpenFIGI identifier  
composite_figiCharacterThe country-composite OpenFIGI identifier  
share_class_figiCharacterThe global-composite OpenFIGI identifier  
primary_listingLogicalIf TRUE, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange