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

astro_returns

Planetary returns — each planet's next crossing of its natal longitude.

Description

Planetary returns — each planet's next crossing of its natal longitude.

Methods:
  sun        [Paid] — Solar return chart for a given year — natal + return wheels, cross-aspects, house overlays, midpoints.
  moon       [Paid] — Moon returns to its natal longitude (position) or natal phase angle (phase) over a date range.
  saturn     [Paid] — Saturn return to its natal longitude (not yet implemented).
  jupiter    [Paid] — Jupiter return to its natal longitude (not yet implemented).
  mars       [Paid] — Mars return to its natal longitude (not yet implemented).
  venus      [Paid] — Venus return to its natal longitude (not yet implemented).
  mercury    [Paid] — Mercury return to its natal longitude (not yet implemented).
  uranus     [Paid] — Uranus return to its natal longitude (not yet implemented).
  neptune    [Paid] — Neptune return to its natal longitude (not yet implemented).
  pluto      [Paid] — Pluto return to its natal longitude (not yet implemented).
  node       [Paid] — North Node return to its natal longitude (not yet implemented).
  any-planet [Paid] — Returns of any of the ten classical planets to its natal longitude, with optional monthly/daily subdivision points.

Input schema

sun

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
returnYearintegeryesmin 1800, max 2101, int
returnLocation.latitudenumberyesmin -90, max 90
returnLocation.longitudenumberyesmin -180, max 180
returnLocation.timezonenumberyesmin -12, max 14
houseSystemenum(38)no
zodiacenum(34)no
aspectOrbsany | "default" | "hide" | objectno
bodies.fortunebooleanno
bodies.vertexbooleanno
bodies.chironbooleanno
bodies.lilithbooleanno
bodies.trueLilithbooleanno
bodies.nodesbooleanno
bodies.trueNodebooleanno
aspectToggles.fortuneAspectsbooleanno
aspectToggles.vertexAspectsbooleanno
aspectToggles.chironAspectsbooleanno
aspectToggles.lilithAspectsbooleanno
aspectToggles.nodeAspectsbooleanno
aspectToggles.ascMcAspectsbooleanno
minorAspects.quincunxbooleanno
minorAspects.semiSextilebooleanno
minorAspects.semiSquarebooleanno
minorAspects.sesquiquadratebooleanno
minorAspects.quintilebooleanno
minorAspects.biQuintilebooleanno
parallelOrbnumbernomin 0, max 3
aspectDisplay"cross" | "natal" | "natal-outer" | "hide"no

moon

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
target"position" | "phase"no
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 13, int

saturn

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

jupiter

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

mars

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

venus

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

mercury

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

uranus

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

neptune

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

pluto

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

node

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
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no

any-planet

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
planetenum(10)yes
fromDate.yearintegeryesmin 1800, max 2100, int
fromDate.monthintegeryesmin 1, max 12, int
fromDate.dayintegeryesmin 1, max 31, int
countintegernomin 1, max 12, int
subdivisions"monthly" | "daily" | "none"no