CLclear-street
Screener

Replace Screener

Changed on

Update a saved screener configuration.

Replaces the screener configuration for the authenticated user. If name is null, the existing name is preserved.

Deprecated -- use PATCH /saved-screeners/{screener_id}; PUT replaces omitted columns, filters and sorts with empty values.

put/v1/saved-screeners/{screener_id}

Request

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

Path parameters

screener_idstring uuid required

Screener ID

Request body

namestring nullable

The name for this screener configuration

sharedboolean nullable

Whether any user may fetch this screener by id. Omit to leave the existing value unchanged (defaults to false when creating).

Example request

{
  "columns": [
    {
      "name": "market_cap"
    }
  ],
  "filters": [
    {
      "left": {
        "name": "market_cap"
      },
      "op": {
        "name": "GREATER_OR_EQUAL"
      },
      "right": [
        {
          "value": 1000000000
        }
      ]
    }
  ],
  "sorts": [
    {
      "direction": "DESC",
      "field": {
        "name": "market_cap"
      }
    }
  ]
}

Response

Screener updated successfully

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

      endpoint deprecated

    • info

      added the new optional request property

    • 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

    • info

      added the new ANNUAL enum value to the request property //////

    • info

      added the new ANNUAL enum value to the request property ///////

    • info

      added the new ANNUAL enum value to the request property /////////////

    • info

      added the new ANNUAL enum value to the request property ///////