GET
/
screener
Screen stocks
curl --request GET \
  --url https://api.financialcontext.com/screener \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": "<any>",
  "message": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "meta": {
    "pagination": {
      "currentPage": 1,
      "pageSize": 20,
      "totalItems": 150,
      "totalPages": 8,
      "hasMore": true,
      "hasPrevious": false
    }
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

filters
string

JSON string of screening filters

sort
string

Sort field and direction

limit
string

Maximum number of results to return

offset
string

Number of results to skip for pagination

Response

Screener results retrieved successfully

success
boolean
required

Indicates successful API response

data
any
required

Response data payload

timestamp
string<date-time>
required

ISO 8601 timestamp of the response

message
string

Optional success message

meta
object

Optional metadata including pagination, statistics, and additional context