portfolio_screen

Screen and rank a portfolio of 2–20 supplied properties using the shared rental-yield and income calculations.

When to use

Use when an agent needs a first-pass ranking of multiple properties before deeper analysis.

Selection guidance

Role: specialized. Use when an agent needs a first-pass ranking of multiple properties before deeper analysis.

Use cases

Access

Price: $0.50 USD per call. Payment options are deployment-configured; inspect /api/v1/payment-methods. Prices and payment semantics are unchanged from the canonical registry.

Related tools

Example input

{
  "properties": [
    {
      "name": "A",
      "propertyValue": 85000,
      "annualRent": 7200
    },
    {
      "name": "B",
      "propertyValue": 100000,
      "annualRent": 7000
    }
  ]
}

Example output

{
  "workflow": "portfolio_screen",
  "result": {
    "properties": [],
    "sortedByNetYield": []
  },
  "limitations": [
    "This screen compares supplied properties; it does not verify ownership, financing, taxes or transaction costs."
  ]
}

Input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "properties": {
      "minItems": 2,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "propertyValue": {
            "type": "number",
            "minimum": 0.01,
            "maximum": 1000000000000
          },
          "annualRent": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000000
          },
          "serviceCharge": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000000
          },
          "maintenanceCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000000
          },
          "maintenance": {
            "description": "Legacy alias for maintenanceCost; supply only one",
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000000
          },
          "vacancyRatePct": {
            "type": "number",
            "minimum": 0,
            "maximum": 100
          },
          "otherAnnualCosts": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000000
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          }
        },
        "required": [
          "propertyValue",
          "annualRent",
          "name"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "properties"
  ],
  "additionalProperties": false
}

Output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workflow": {
      "type": "string"
    },
    "result": {},
    "limitations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "workflow",
    "result",
    "limitations"
  ],
  "additionalProperties": false
}

Category: Property Intelligence · hierarchy: specialized · idempotent: yes · side effects: no