v57

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-2161198428.4 KB

Screener

Create Screener

Create a saved screener configuration.

Persists a screener configuration for the authenticated user.

post/v1/saved-screeners

Request body

namestring nullable

The name for this screener configuration

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 created successfully

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "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"
        }
      }
    ]
  }
}