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 Javascript 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:
SecurityApi
Instance Method:
screenSecurities()

Stock Price Code Example

Use my API Key
var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;
var security = new intrinioSDK.SecurityApi();
clauses = [
{
"field": "marketcap",
"operator": "gt",
"value": "10000000"
},
{
"field": "beta",
"operator": "lt",
"value": "5"
}
]
var logic = new intrinioSDK.SecurityScreenGroup()
logic.operator = "AND"
logic.clauses = clauses
var opts = {
'logic': logic,
'orderColumn': "marketcap",
'orderDirection': "asc",
'primaryOnly': false,
'pageSize': 100
};
security.screenSecurities(opts).then(function(data) {
data = JSON.stringify(data, null, 2)
console.log(data);
}, function(error) {
console.error(error);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
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]  
orderColumnStringResults returned sorted by this column[optional]  
orderDirectionStringSort order to use with the order_column[optional] [default to asc]  
primaryOnlyBooleanReturn only primary securities[optional] [default to false]  
pageSizeNumberThe number of results to return. Maximum for this endpoint is 50000.[optional] [default to 100]  


Return Type

object
[SecurityScreenResult]

Properties

NameTypeDescription
securitySecuritySummary 
data[SecurityScreenResultData] 
object
SecuritySummary

Properties

NameTypeDescription
idStringThe Intrinio ID for Security  
companyIdStringThe Intrinio ID for the Company for which the Security is issued  
exchangeStringThe exchange's MIC  
exchangeMicStringThe security's exchange MIC  
stockExchangeIdStringThe exchange's Intrinio ID  
nameStringThe name of the Security  
codeStringA 2-3 digit code classifying the Security (reference)  
currencyStringThe currency in which the Security is traded on the exchange  
tickerStringThe common/local ticker of the Security  
compositeTickerStringThe country-composite ticker of the Security  
figiStringThe OpenFIGI identifier  
compositeFigiStringThe country-composite OpenFIGI identifier  
shareClassFigiStringThe global-composite OpenFIGI identifier  
primaryListingBooleanIf true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange  
object
SecurityScreenResultData

Properties

NameTypeDescription
tagStringThe data tag that was screened-for  
numberValueStringThe numeric value for the tag  
textValueStringThe text value for the tag