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 Python 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:
screen_securities()

Stock Price Code Example

Use my API Key
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)
clauses = [
{
"field": "marketcap",
"operator": "gt",
"value": "10000000"
},
{
"field": "beta",
"operator": "lt",
"value": "5"
}
]
logic = intrinio.SecurityScreenGroup(operator="AND", clauses=clauses)
order_column = 'marketcap'
order_direction = 'asc'
primary_only = False
page_size = 100
response = intrinio.SecurityApi().screen_securities(logic=logic, order_column=order_column, order_direction=order_direction, primary_only=primary_only
  , page_size=page_size)
print(response)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
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_columnstrResults returned sorted by this column[optional]  
order_directionstrSort order to use with the order_column[optional] [default to asc]  
primary_onlyboolReturn only primary securities[optional] [default to False]  
page_sizeintThe number of results to return. Maximum for this endpoint is 50000.[optional] [default to 100]  


Return Type

object
list[SecurityScreenResult]

Properties

NameTypeDescription
securitySecuritySummary 
datalist[SecurityScreenResultData] 
object
SecuritySummary

Properties

NameTypeDescription
idstrThe Intrinio ID for Security  
company_idstrThe Intrinio ID for the Company for which the Security is issued  
exchangestrThe exchange's MIC  
exchange_micstrThe security's exchange MIC  
stock_exchange_idstrThe exchange's Intrinio ID  
namestrThe name of the Security  
codestrA 2-3 digit code classifying the Security (reference)  
currencystrThe currency in which the Security is traded on the exchange  
tickerstrThe common/local ticker of the Security  
composite_tickerstrThe country-composite ticker of the Security  
figistrThe OpenFIGI identifier  
composite_figistrThe country-composite OpenFIGI identifier  
share_class_figistrThe global-composite OpenFIGI identifier  
primary_listingboolIf 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
tagstrThe data tag that was screened-for  
number_valuestrThe numeric value for the tag  
text_valuestrThe text value for the tag