Get Filtered Equities
Retrieve equities sorted by a particular field and split into multiple pages
Overview
This GET endpoint enables you to retrieve equites sorted by a specified field.
There are seven required parameters that must be provided in the request:
Authorization (header). This is the authorization token from the very first token request. The value of this header must have the following format:
Bearer BQ898r9fefi
(Bearer
+ 1 space + the token).API version (path). Unless necessary, leave it at "1.0".
pageNumber (query). This is the page number (there are thousands of equities split into pages).
pageSize (query). This is the number of equities that should be retrieved from this page.
sortField (query). This is the field by which all equities should be sorted. For example, if you specify Type, first you'll receive stocks, then ETFs, etc.
Desc (query). This is a boolean field that indicates if the returned equities should be sorted in the descending order.
There's also one optional parameter worth examining:
filter (query). This is an SQL query used to retrieve only those equities that satisfy the conditions of the query. The following table outlines the parameter's syntax.
Note that you can combine different queries to create more complex requests:
AllowMargin = true and AllowShort = false
Here's the final template for this API request:
Sample CURLs
Fetch FANG stocks:
Fetch securities disabled from trading:
Fetch securities traded on NASDAQ:
Response
In response to this API request, you'll receive the following JSON that lists the equities sorted by the specified parameter.
where:
Common Mistakes
Here are some of the common mistakes that developers make when attempting to retrieve sorted equities.
Failing to Specify the Et-App-Key Parameter
If you specify the wrong Et-App-Key parameter or fail to include it in the header altogether, you'll get the following error:
Failing to Specify the Query Parameters
It's crucial to understand that all four query parameters must be indicated in the request; otherwise you'll receive the 404 status code and the following message:
The following article covers the syntax for this API request in detail.
Last updated