Screen Securities

Screen Securities Web API Documentation

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

Endpoint:
Method:
POST
https://api-v2.intrinio.com/securities/screen

Parameters

Name Description Example
logic
The logic to screen with, consisting of operators, clauses, and nested groups.
See screener documentation for details on how to construct conditions.
Request Body:
{
  "operator": "AND",
  "clauses": [
    {
      "field": "marketcap",
      "operator": "gt",
      "value": "1000000000"
    },
    {
      "field": "beta",
      "operator": "lt",
      "value": "5"
    }
  ]
}
order_column
Results returned sorted by this column marketcap
order_direction
Sort order to use with the order_column
Options:
asc
desc
show more show less
asc
primary_only
Return only primary securities -
page_size
The number of results to return. Maximum for this endpoint is 50000. -
logic
The logic to screen with, consisting of operators, clauses, and nested groups.
See screener documentation for details on how to construct conditions.
order_column
Results returned sorted by this column
order_direction
Sort order to use with the order_column
primary_only
Return only primary securities
page_size
The number of results to return. Maximum for this endpoint is 50000.

Output Fields

Name Description Type
security
object
id
The Intrinio ID for Security string
company_id
The Intrinio ID for the Company for which the Security is issued string
name
The name of the Security string
code
A 2-3 digit code classifying the Security (reference) string
currency
The currency in which the Security is traded on the exchange string
ticker
The common/local ticker of the Security string
composite_ticker
The country-composite ticker of the Security string
figi
The OpenFIGI identifier string
composite_figi
The country-composite OpenFIGI identifier string
share_class_figi
The global-composite OpenFIGI identifier string
primary_listing
If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange boolean
data
array
properties
security
data

Choose an Endpoint

Screener

Screen Securities

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

No endpoints match your query.


Sample Data

Live Data

Sample Data

Switch to Sample Data

Screen Securities

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

URL:
https://api-v2.intrinio.com/securities/screen?order_column=marketcap&order_direction=asc

Request Body:

{
  "operator": "AND",
  "clauses": [
    {
      "field": "marketcap",
      "operator": "gt",
      "value": "1000000000"
    },
    {
      "field": "beta",
      "operator": "lt",
      "value": "5"
    }
  ]
}
No available sample data available

Start building the future today

Request a Consultation