CLclear-street
Screener

Patch Screener

Changed on

Partially update a saved screener configuration.

Every field is optional. Omitting a field, or sending it as null, leaves the stored value unchanged. Sending a field's empty value clears it: columns: [] clears the stored columns, sorts: [] clears the stored sort, and filters: [] clears the stored filters. name: "" is rejected -- a screener's name cannot be cleared. shared: false sets it to false; it is a value, not a clear.

Unknown fields are rejected with a 422.

patch/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. Omit or send null to leave unchanged. Cannot be set to an empty string.

sharedboolean nullable

Whether any user may fetch this screener by id. Omit or send null to leave unchanged. false is a value, not a clear.

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