Returns security list and information all securities that match the given conditions. The API call credits required for each call is equal to the number of conditions specified.
| Name | Description | Example |
|---|---|---|
|
screener_conditions
|
A list of conditions used to filter the resulting securities. See screener documentation for details on how to construct conditions. | pricetoearnings~lt~15 |
|
logic
|
The logic of how the conditions are applied. See screener documentation for details on how to use logic with conditions. | low_pe AND high_roi |
|
order_column
|
A data tag by which to order the results. | - |
|
order_direction
|
The direction in which to order the results (“asc” for Ascending or “desc” for descending).
Options:
asc
desc
show more
show less
|
asc |
|
primary_only
|
Return only primary securities (excluding special securities such as preferred shares)
Options:
true
show more
show less
|
true |
|
actively_traded
|
Return only securities that have a stock price in the past 7 days
Options:
true
show more
show less
|
true |
|
page_number
|
An integer greater than or equal to 1 for specifying the page number for the return values. | 3 |
|
page_size
|
An integer greater than or equal to 1 for specifying the number of results on each page. | 20 |
|
hide_paging
|
Hide first row of paging information.
Options:
true
show more
show less
|
true |
|
screener_conditions
* required
A list of conditions used to filter the resulting securities. See screener documentation for details on how to construct conditions.
|
||
|
logic
* required
The logic of how the conditions are applied. See screener documentation for details on how to use logic with conditions.
|
||
|
order_column
* required
A data tag by which to order the results.
|
||
|
order_direction
* required
The direction in which to order the results (“asc” for Ascending or “desc” for descending).
|
||
|
primary_only
* required
Return only primary securities (excluding special securities such as preferred shares)
|
||
|
actively_traded
* required
Return only securities that have a stock price in the past 7 days
|
||
|
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values.
|
||
|
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page.
|
||
|
hide_paging
* required
Hide first row of paging information.
|
Back to Product Docs