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

astro_moment

Astrological qualities of a moment — phase, VOC, hours, mansions, eclipses.

Description

Astrological qualities of a moment — phase, VOC, hours, mansions, eclipses.

Methods:
  moon-phase       [Free] — current lunar phase, waxing/waning state, sign + house of the Moon at a moment
  void-of-course   [Free] — whether the Moon is void-of-course at a moment, with sign-entry/exit windows
  planetary-hours  [Free] — hour rulers across a date at a location (Chaldean order), sunrise/sunset + daily ruler
  lunar-mansions   [Paid] — the 28 lunar mansion the Moon occupies at a moment
  oob-declination  [Paid] — planets out-of-bounds in declination at a birth moment
  critical-degrees [Free] — planets conjunct cardinal/fixed/mutable critical degrees in a birth chart
  eclipses-current [Free] — solar + lunar eclipses within a date range, plus next solar/lunar eclipses

Input schema

moon-phase

FieldTypeRequiredConstraints
yearintegeryesmin -4000, max 4000, int
monthintegeryesmin 1, max 12, int
dayintegeryesmin 1, max 31, int
hourintegernomin 0, max 23, int
minuteintegernomin 0, max 59, int
secondintegernomin 0, max 59, int
latitudenumbernomin -90, max 90
longitudenumbernomin -180, max 180
timezonenumbernomin -12, max 14
houseSystemenum(38)no
zodiacenum(34)no

void-of-course

FieldTypeRequiredConstraints
dateTime.yearintegeryesmin 1800, max 2200, int
dateTime.monthintegeryesmin 1, max 12, int
dateTime.dayintegeryesmin 1, max 31, int
dateTime.hourintegeryesmin 0, max 23, int
dateTime.minuteintegernomin 0, max 59, int
dateTime.secondintegernomin 0, max 59, int
planetSet"classical" | "modern"no

planetary-hours

FieldTypeRequiredConstraints
date.yearintegeryesmin 1800, max 2200, int
date.monthintegeryesmin 1, max 12, int
date.dayintegeryesmin 1, max 31, int
latitudenumberyesmin -66, max 66
longitudenumberyesmin -180, max 180
timezonenumberyesmin -12, max 14

lunar-mansions

FieldTypeRequiredConstraints
dateTime.yearintegeryesmin 1800, max 2200, int
dateTime.monthintegeryesmin 1, max 12, int
dateTime.dayintegeryesmin 1, max 31, int
dateTime.hourintegeryesmin 0, max 23, int
dateTime.minuteintegernomin 0, max 59, int
dateTime.secondintegernomin 0, max 59, int

oob-declination

FieldTypeRequiredConstraints
birthData.yearintegeryesmin -4000, max 4000, int
birthData.monthintegeryesmin 1, max 12, int
birthData.dayintegeryesmin 1, max 31, int
birthData.hourintegeryesmin 0, max 23, int
birthData.minuteintegeryesmin 0, max 59, int
birthData.secondintegernomin 0, max 59, int
birthData.latitudenumberyesmin -90, max 90
birthData.longitudenumberyesmin -180, max 180
birthData.timezonenumberyesmin -12, max 14
birthData.unknownTimebooleanno

critical-degrees

FieldTypeRequiredConstraints
birthData.yearintegeryesmin -4000, max 4000, int
birthData.monthintegeryesmin 1, max 12, int
birthData.dayintegeryesmin 1, max 31, int
birthData.hourintegeryesmin 0, max 23, int
birthData.minuteintegeryesmin 0, max 59, int
birthData.secondintegernomin 0, max 59, int
birthData.latitudenumberyesmin -90, max 90
birthData.longitudenumberyesmin -180, max 180
birthData.timezonenumberyesmin -12, max 14
birthData.unknownTimebooleanno
orbnumbernomin 0.1, max 3

eclipses-current

FieldTypeRequiredConstraints
dateRange.fromobjectyes
dateRange.toobjectyes
kind"solar" | "lunar" | "both"no