Screen Securities Python API Documentation

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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

Name	Type	Description	Notes
logic	SecurityScreenGroup	The logic to screen with, consisting of operators, clauses, and nested groups. See screener documentation for details on how to construct conditions.	[optional]
order_column	str	Results returned sorted by this column	[optional]
order_direction	str	Sort order to use with the order_column	[optional] [default to asc]
primary_only	bool	Return only primary securities	[optional] [default to False]
page_size	int	The number of results to return. Maximum for this endpoint is 50000.	[optional] [default to 100]

Return Type

object

list[SecurityScreenResult]

Properties

Name	Type	Description
security	SecuritySummary
data	list[SecurityScreenResultData]

object

SecuritySummary

Properties

Name	Type	Description
id	str	The Intrinio ID for Security
company_id	str	The Intrinio ID for the Company for which the Security is issued
exchange	str	The exchange's MIC
exchange_mic	str	The security's exchange MIC
stock_exchange_id	str	The exchange's Intrinio ID
name	str	The name of the Security
code	str	A 2-3 digit code classifying the Security (reference)
currency	str	The currency in which the Security is traded on the exchange
ticker	str	The common/local ticker of the Security
composite_ticker	str	The country-composite ticker of the Security
figi	str	The OpenFIGI identifier
composite_figi	str	The country-composite OpenFIGI identifier
share_class_figi	str	The global-composite OpenFIGI identifier
primary_listing	bool	If True, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange

object

SecurityScreenResultData

Properties

Name	Type	Description
tag	str	The data tag that was screened-for
number_value	str	The numeric value for the tag
text_value	str	The text value for the tag

Screen Securities

SDKs

API Endpoints

Standardized & As-Reported Financial Statement Data

Company Reference & Metadata

Company News

Insider & Institutional Holdings Data

Upcoming & Historical IPOs

Raw Text Filings

XBRL Searchable Financial Statement Notes

Aggregate Standardized Financial Statement Data by SIC Codes

Economic Data

Security Reference Data

Real-Time Prices

Historical Intraday Prices

Historical End of Day Prices

Technical Indicators

Historical End of Day Index Prices

Reference & Metadata

Holdings

Returns & Analytics