API Parameters Guide

Comprehensive reference for all available parameters in the Astrological Calculations API

Introduction

This guide provides detailed information about all parameters available for each endpoint in the API. Use this reference to construct your API requests with the correct parameter formats and values.

All date and time parameters should use UTC unless otherwise specified. The API will adjust calculations for the specified location's timezone automatically.

Common Parameters

These parameters are used across multiple endpoints:

date (string): Date in ISO format YYYY-MM-DD. Example: "2025-05-21"

time (string): Time in 24-hour format HH:MM:SS. Example: "15:30:00"

latitude (float): Geographic latitude in decimal degrees. Positive values for North, negative for South. Range: -90.0 to 90.0. Example: 35.9940

longitude (float): Geographic longitude in decimal degrees. Positive values for East, negative for West. Range: -180.0 to 180.0. Example: -78.8986

house_system (string): Astrological house system to use. Options:

  • "P" - Placidus (most commonly used)
  • "K" - Koch
  • "O" - Porphyrius
  • "R" - Regiomontanus
  • "C" - Campanus
  • "E" - Equal
  • "W" - Whole Sign
  • "B" - Alcabitus
  • "M" - Morinus
  • "A" - Equal (Asc in middle of 1st house)

planets (array of strings): List of planets to include in calculations. Available options:

  • "Sun" - The Sun
  • "Moon" - The Moon
  • "Mercury" - Mercury
  • "Venus" - Venus
  • "Mars" - Mars
  • "Jupiter" - Jupiter
  • "Saturn" - Saturn
  • "Uranus" - Uranus
  • "Neptune" - Neptune
  • "Pluto" - Pluto
  • "Chiron" - Chiron
  • "North Node" - True North Node
  • "South Node" - True South Node
  • "Mean North Node" - Mean North Node
  • "Mean South Node" - Mean South Node
  • "Ascendant" - Ascendant
  • "Midheaven" - Midheaven (MC)
  • "Part of Fortune" - Part of Fortune
  • "Vertex" - Vertex
  • "Lilith" - Black Moon Lilith
  • "Ceres" - Ceres
  • "Pallas" - Pallas
  • "Juno" - Juno
  • "Vesta" - Vesta
If omitted, all major planets (Sun through Pluto plus Chiron, North Node, Ascendant, and Midheaven) will be included.

Endpoint Parameters

POST /planetary-positions

Calculate planetary positions for a given date, time, and location.

Required Parameters:

date (string): Date in ISO format YYYY-MM-DD

time (string): Time in 24-hour format HH:MM:SS

latitude (float): Geographic latitude in decimal degrees

longitude (float): Geographic longitude in decimal degrees

Optional Parameters:

planets (array of strings): List of planets to include

include_extended (boolean): Whether to include extended information like speed, latitude, distance. Default: false

zodiac_type (string): Type of zodiac to use. Options: "tropical" (default), "sidereal"

ayanamsa (string): Ayanamsa method for sidereal zodiac calculations. Options: "fagan_bradley" (default), "lahiri", "deluce", "raman", "krishnamurti", "djwhal_khul". Only used if zodiac_type is "sidereal"

Example Request:

{
  "date": "2025-05-21",
  "time": "12:00:00",
  "latitude": 35.9940,
  "longitude": -78.8986,
  "planets": ["Sun", "Moon", "Mercury", "Venus", "Mars"],
  "include_extended": true,
  "zodiac_type": "tropical"
}

POST /astrological-houses

Calculate astrological houses for a given date, time, and location.

Required Parameters:

date (string): Date in ISO format YYYY-MM-DD

time (string): Time in 24-hour format HH:MM:SS

latitude (float): Geographic latitude in decimal degrees

longitude (float): Geographic longitude in decimal degrees

Optional Parameters:

house_system (string): House system to use. Default: "P" (Placidus)

zodiac_type (string): Type of zodiac to use. Options: "tropical" (default), "sidereal"

ayanamsa (string): Ayanamsa method for sidereal zodiac calculations. Only used if zodiac_type is "sidereal"

include_points (boolean): Whether to include special points like Ascendant, Midheaven, etc. Default: true

Example Request:

{
  "date": "2025-05-21",
  "time": "12:00:00",
  "latitude": 35.9940,
  "longitude": -78.8986,
  "house_system": "W",
  "include_points": true
}

POST /aspects

Calculate aspects between planets for a given date, time, and location.

Required Parameters:

date (string): Date in ISO format YYYY-MM-DD

time (string): Time in 24-hour format HH:MM:SS

latitude (float): Geographic latitude in decimal degrees

longitude (float): Geographic longitude in decimal degrees

Optional Parameters:

planets (array of strings): List of planets to consider for aspects

include_minor_aspects (boolean): Whether to include minor aspects. Default: false

custom_orbs (object): Custom orbs for specific aspects. Example: {"conjunction": 8, "opposition": 8}

aspect_types (array of strings): List of aspect types to include. Available options:

  • "conjunction" - 0°
  • "opposition" - 180°
  • "trine" - 120°
  • "square" - 90°
  • "sextile" - 60°
  • "quintile" - 72°
  • "septile" - 51.43°
  • "semisquare" - 45°
  • "sesquisquare" - 135°
  • "semisextile" - 30°
  • "quincunx" - 150°
  • "biquintile" - 144°
If omitted, major aspects (conjunction, opposition, trine, square, sextile) will be included.

Example Request:

{
  "date": "2025-05-21",
  "time": "12:00:00",
  "latitude": 35.9940,
  "longitude": -78.8986,
  "include_minor_aspects": true,
  "planets": ["Sun", "Moon", "Venus", "Mars", "Jupiter", "Saturn"],
  "custom_orbs": {
    "conjunction": 8,
    "opposition": 8,
    "trine": 7
  }
}

POST /natal-chart

Calculate a complete natal chart with planetary positions, houses, and aspects.

Required Parameters:

date (string): Birth date in ISO format YYYY-MM-DD

time (string): Birth time in 24-hour format HH:MM:SS

latitude (float): Birth place latitude in decimal degrees

longitude (float): Birth place longitude in decimal degrees

Optional Parameters:

house_system (string): House system to use. Default: "P" (Placidus)

planets (array of strings): List of planets to include

include_minor_aspects (boolean): Whether to include minor aspects. Default: false

zodiac_type (string): Type of zodiac to use. Options: "tropical" (default), "sidereal"

ayanamsa (string): Ayanamsa method for sidereal zodiac calculations

name (string): Name for the chart (useful when saving to database)

description (string): Description for the chart

include_interpretations (boolean): Whether to include basic interpretations. Default: false

Example Request:

{
  "date": "1989-01-06",
  "time": "15:10:00",
  "latitude": 35.9940,
  "longitude": -78.8986,
  "house_system": "P",
  "include_minor_aspects": false,
  "planets": ["Sun", "Moon", "Mercury", "Venus", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune", "Pluto", "Chiron", "North Node", "Ascendant", "Midheaven"],
  "name": "My Birth Chart",
  "description": "Birth chart for Durham, NC",
  "include_interpretations": true
}

POST /transits

Calculate transit aspects between natal and transit charts.

Required Parameters:

natal_date (string): Natal chart date in ISO format YYYY-MM-DD

natal_time (string): Natal chart time in 24-hour format HH:MM:SS

natal_latitude (float): Natal chart latitude in decimal degrees

natal_longitude (float): Natal chart longitude in decimal degrees

transit_date (string): Transit date in ISO format YYYY-MM-DD

transit_time (string): Transit time in 24-hour format HH:MM:SS

Optional Parameters:

natal_planets (array of strings): List of planets to include from the natal chart

transit_planets (array of strings): List of planets to include from the transit chart

include_minor_aspects (boolean): Whether to include minor aspects. Default: false

house_system (string): House system to use. Default: "P" (Placidus)

transit_latitude (float): Transit location latitude. If omitted, uses natal_latitude

transit_longitude (float): Transit location longitude. If omitted, uses natal_longitude

orb_factor (float): Factor to adjust orbs for transit aspects (usually tighter than natal). Range: 0.1 to 2.0. Default: 0.7

include_applying (boolean): Whether to indicate if aspects are applying or separating. Default: true

include_interpretations (boolean): Whether to include basic transit interpretations. Default: false

Example Request:

{
  "natal_date": "1989-01-06",
  "natal_time": "15:10:00",
  "natal_latitude": 35.9940,
  "natal_longitude": -78.8986,
  "transit_date": "2025-05-21",
  "transit_time": "12:00:00",
  "include_minor_aspects": true,
  "natal_planets": ["Sun", "Moon", "Mercury", "Venus", "Mars", "Jupiter", "Saturn"],
  "transit_planets": ["Jupiter", "Saturn", "Uranus", "Neptune", "Pluto"],
  "orb_factor": 0.8,
  "include_interpretations": true
}

GET /lunar-movements

Get the moon's sign, entry/exit times, and void of course information.

Optional Query Parameters:

date (string): Date in ISO format YYYY-MM-DD. If omitted, uses current date

time (string): Time in 24-hour format HH:MM:SS. If omitted, uses current time

days (integer): Number of days to include in the response. Range: 1 to 30. Default: 1

zodiac_type (string): Type of zodiac to use. Options: "tropical" (default), "sidereal"

Example Usage:

GET /lunar-movements?date=2025-05-21&days=3

GET /lunar-phase

Get lunar phase information including new/full moon dates.

Optional Query Parameters:

date (string): Date in ISO format YYYY-MM-DD. If omitted, uses current date

time (string): Time in 24-hour format HH:MM:SS. If omitted, uses current time

include_next_phases (boolean): Whether to include upcoming lunar phase dates. Default: true

count (integer): Number of upcoming phases to include. Range: 1 to 8. Default: 4

Example Usage:

GET /lunar-phase?date=2025-05-21&include_next_phases=true&count=6

GET or POST /mansion-of-the-moon

Get lunar mansion information including descriptions.

Optional Parameters (GET query params or POST body):

date (string): Date in ISO format YYYY-MM-DD. If omitted, uses current date

time (string): Time in 24-hour format HH:MM:SS. If omitted, uses current time

system (string): Mansion system to use. Options: "tropical" (default), "vedic", "arabic"

include_details (boolean): Whether to include detailed descriptions. Default: true

Example Usage:

GET /mansion-of-the-moon?date=2025-05-21&system=arabic

POST /neo4j/setup

Setup Neo4j database connection.

Required Parameters:

uri (string): Neo4j database URI. Example: "bolt://neo4j.pathsofreverence.com:7687"

username (string): Neo4j database username. Example: "neo4j"

password (string): Neo4j database password

Optional Parameters:

remember (boolean): Whether to save connection details for future sessions. Default: true

Example Request:

{
  "uri": "bolt://neo4j.pathsofreverence.com:7687",
  "username": "neo4j",
  "password": "your_password",
  "remember": true
}

POST /neo4j/sync

Synchronize data between PostgreSQL and Neo4j.

Required Parameters:

password (string): Neo4j database password

Optional Parameters:

type (string): Type of synchronization. Options: "all" (default), "recent"

hours (integer): For recent sync, number of hours to look back. Range: 1 to 720. Default: 24

Example Request:

{
  "type": "recent",
  "hours": 48,
  "password": "your_password"
}

POST /neo4j/query

Run a custom Cypher query against the Neo4j database.

Required Parameters:

query (string): Cypher query to execute

Optional Parameters:

params (object): Parameters for the Cypher query

Example Request:

{
  "query": "MATCH (p:Planet)-[r:IN_SIGN]->(s:Sign) WHERE p.name = $planet RETURN p, r, s",
  "params": {
    "planet": "Mars"
  }
}

GET /today

Get today's astrological highlights including current moon sign, moon phase (if Full or New), and sun sign changes. Returns live cosmic data for the current date.

Parameters:

No parameters required - automatically uses current date and time

Response Format:

{
  "moonSign": "Cancer",
  "moonPhase": "New Moon",  // Only included if Full or New Moon
  "sunSignChange": {        // Only included if Sun changed signs today
    "from": "Gemini",
    "to": "Cancer"
  }
}

Usage Notes:

• Returns current Moon sign based on live astronomical calculations

• Moon phase only appears during Full Moon or New Moon events

• Sun sign changes are detected when the Sun moves into a new zodiac sign

• All data calculated using Swiss Ephemeris for maximum accuracy