bayesline.api.equity.MCapFilterSettings

pydantic model bayesline.api.equity.MCapFilterSettings

Specify the lower and upper bound for the market cap filter.

By default the bounds are infinite.

Show JSON schema

{
   "title": "MCapFilterSettings",
   "description": "Specify the lower and upper bound for the market cap filter.\n\nBy default the bounds are infinite.",
   "type": "object",
   "properties": {
      "lower": {
         "default": 0.0,
         "description": "Lower bound of the cap filter in USD.",
         "examples": [
            10000000000.0
         ],
         "minimum": 0,
         "title": "Lower",
         "type": "number"
      },
      "upper": {
         "default": 1e+20,
         "description": "Upper bound of the cap filter in USD.",
         "examples": [
            1000000000000.0
         ],
         "exclusiveMinimum": 0.0,
         "minimum": 0,
         "title": "Upper",
         "type": "number"
      }
   },
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• lower (float)

• upper (float)

Validators:

• check_upper_gt_lower » all fields

field lower: NonNegativeFloat = 0.0

Lower bound of the cap filter in USD.

Constraints:

• ge = 0

Validated by:

• check_upper_gt_lower

field upper: NonNegativeFloat = 1e+20

Upper bound of the cap filter in USD.

Constraints:

• gt = 0.0

• ge = 0

Validated by:

• check_upper_gt_lower

validator check_upper_gt_lower → MCapFilterSettings  »  all fields

Validate that the upper bound is greater than the lower bound.

Returns

MCapFilterSettings

The validated instance.

Raises

ValueError

If the upper bound is not greater than the lower bound.