Screen Securities Ruby API Documentation

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

API Class:

Intrinio::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
32
33
34
35
36
# Load the gem
require 'intrinio-sdk'
require 'pp'
# Setup authorization
Intrinio.configure do |config|
  config.api_key['api_key'] = 'YOUR_API_KEY'
  config.allow_retries = true
end
security_api = Intrinio::SecurityApi.new
clauses = [
  {
    "field": "marketcap",
    "operator": "gt",
    "value": "10000000"
  },
  {
    "field": "beta",
    "operator": "lt",
    "value": "5"
  }
]
opts = {
  logic: Intrinio::SecurityScreenGroup.new(operator: "AND", clauses: clauses),
  order_column: "marketcap",
  order_direction: "asc",
  primary_only: false,
  page_size: 100
}
result = security_api.screen_securities(opts)
pp 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]
order_column	String	Results returned sorted by this column	[optional]
order_direction	String	Sort order to use with the order_column	[optional] [default to asc]
primary_only	BOOLEAN	Return only primary securities	[optional] [default to false]
page_size	Integer	The number of results to return. Maximum for this endpoint is 50000.	[optional] [default to 100]

Return Type

object

Array<Intrinio::SecurityScreenResult>

Properties

Name	Type	Description
security	SecuritySummary
data	Array

object

Intrinio::SecuritySummary

Properties

Name	Type	Description
id	String	The Intrinio ID for Security
company_id	String	The Intrinio ID for the Company for which the Security is issued
exchange	String	The exchange's MIC
exchange_mic	String	The security's exchange MIC
stock_exchange_id	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
composite_ticker	String	The country-composite ticker of the Security
figi	String	The OpenFIGI identifier
composite_figi	String	The country-composite OpenFIGI identifier
share_class_figi	String	The global-composite OpenFIGI identifier
primary_listing	BOOLEAN	If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange

object

Intrinio::SecurityScreenResultData

Properties

Name	Type	Description
tag	String	The data tag that was screened-for
number_value	String	The numeric value for the tag
text_value	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