CLclear-street
Screener

Get Screeners

Changed on

List saved screener configurations.

Returns all screener configurations for the authenticated user.

get/v1/saved-screeners

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Response

List of saved screeners

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  },
  "data": [
    {
      "columns": [
        {
          "name": "market_cap"
        }
      ],
      "filters": [
        {
          "left": {
            "name": "market_cap"
          },
          "op": {
            "name": "GREATER_OR_EQUAL"
          },
          "right": [
            {
              "value": 1000000000
            }
          ]
        }
      ],
      "sorts": [
        {
          "direction": "DESC",
          "field": {
            "name": "market_cap"
          }
        }
      ]
    }
  ]
}

Changes

  • 1bd9eddeffc8Revision changes
    • info

      added the required property /// to the response with the status

  • 169e8b9ad50cRevision changes
    • warning

      added the new ANNUAL enum value to the ///////// response property for the response status

    • warning

      added the new ANNUAL enum value to the ////////// response property for the response status

    • warning

      added the new ANNUAL enum value to the //////////////// response property for the response status

    • warning

      added the new ANNUAL enum value to the ////////// response property for the response status