<!-- generated by scripts/docs/generate-reference.ts — do not edit -->

astro_find_electional

Electional astrology — score date ranges against a criteria DSL.

  • Layer: search
  • Methods: criteria
  • Free tier:
  • Paid tier: criteria

Description

Electional astrology — score date ranges against a criteria DSL.

Methods:
  criteria [Paid] — Score a date range against an electional criteria DSL (planet-in-sign, planet-not-retrograde, moon-not-voc, moon-waxing, aspect-within-orb, no-aspect); returns the top scoring windows.

Input schema

criteria

FieldTypeRequiredConstraints
dateRange.fromobjectyes
dateRange.toobjectyes
criteriaarrayyes
stepHoursnumbernomin 1, max 24, default 6
topNnumbernomin 1, max 20, default 5

Example request

{
  "method": "criteria",
  "dateRange": {
    "from": {
      "year": 2024,
      "month": 6,
      "day": 1
    },
    "to": {
      "year": 2024,
      "month": 6,
      "day": 7
    }
  },
  "criteria": [
    {
      "kind": "moon-not-voc"
    },
    {
      "kind": "planet-in-sign",
      "planet": "Moon",
      "signs": [
        "Cancer"
      ]
    }
  ]
}

Example response (captured; long values elided)

{
  "maxPossible": 2,
  "windows": [
    {
      "startJd": 2460462.750001,
      "endJd": 2460464.250001,
      "score": 1,
      "satisfied": [
        "moon-not-voc"
      ]
    },
    {
      "startJd": 2460464.750001,
      "endJd": 2460466.000001,
      "score": 1,
      "satisfied": [
        "moon-not-voc"
      ]
    },
    {
      "startJd": 2460467.000001,
      "endJd": 2460468.500001,
      "score": 1,
      "satisfied": [
        "moon-not-voc"
      ]
    },
    {
      "startJd": 2460462.500001,
      "endJd": 2460462.500001,
      "score": 0,
      "satisfied": []
    },
    {
      "startJd": 2460464.500001,
      "endJd": 2460464.500001,
      "score": 0,
      "satisfied": []
    }
  ]
}