Screen Securities Java 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:

screenSecurities()

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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;
public class Main {
  public static void main(String[] args) throws Exception {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);
    SecurityApi securityApi = new SecurityApi();
    SecurityScreenGroup logic = new SecurityScreenGroup();
    String orderColumn = "marketcap";
    String orderDirection = "asc";
    Boolean primaryOnly = false;
    Integer pageSize = 100;
    logic.setOperator("AND");
    SecurityScreenClause clauseOne = new SecurityScreenClause();
    SecurityScreenClause clauseTwo = new SecurityScreenClause();
    clauseOne.setField("marketcap");
    clauseOne.setOperator(SecurityScreenClause.OperatorEnum.GT);
    clauseOne.setValue("100000000");
    clauseTwo.setField("beta");
    clauseTwo.setOperator(SecurityScreenClause.OperatorEnum.LT);
    clauseTwo.setValue("5");
    List<SecurityScreenClause> clauses = new ArrayList<>();
    clauses.add(clauseOne);
    clauses.add(clauseTwo);
    logic.setClauses(clauses);
    List<SecurityScreenResult> result = securityApi.screenSecurities(logic, orderColumn, orderDirection, primaryOnly, pageSize);
    System.out.println(result);
  }
}
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
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]
orderColumn	String	Results returned sorted by this column	[optional]
orderDirection	String	Sort order to use with the order_column	[optional] [default to asc] [enum: asc, desc]
primaryOnly	Boolean	Return only primary securities	[optional] [default to false]
pageSize	Integer	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

object

SecuritySummary

Properties

Name	Type	Description
id	String	The Intrinio ID for Security
companyId	String	The Intrinio ID for the Company for which the Security is issued
exchange	String	The exchange's MIC
exchangeMic	String	The security's exchange MIC
stockExchangeId	String	The exchange's Intrinio ID
name	String	The name of the Security
code	String	A 2-3 digit code classifying the Security (reference)
currency	String	The currency in which the Security is traded on the exchange
ticker	String	The common/local ticker of the Security
compositeTicker	String	The country-composite ticker of the Security
figi	String	The OpenFIGI identifier
compositeFigi	String	The country-composite OpenFIGI identifier
shareClassFigi	String	The global-composite OpenFIGI identifier
primaryListing	Boolean	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	String	The data tag that was screened-for
numberValue	String	The numeric value for the tag
textValue	String	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