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

astro_render_planetary_clock

Planetary clock face — rise, set, culminate for a date + location.

  • Layer: render
  • Methods: clock
  • Free tier:
  • Paid tier: clock

Description

Planetary clock face — rise, set, culminate for a date + location.

Methods:
  clock [Paid] — date + location → rise / set / culmination clock-face for the planets

Input schema

clock

FieldTypeRequiredConstraints
date.yearintegeryesmin 1800, max 2200, int
date.monthintegeryesmin 1, max 12, int
date.dayintegeryesmin 1, max 31, int
latitudenumberyesmin -89.9, max 89.9
longitudenumberyesmin -180, max 180
timezonenumbernomin -12, max 14
bodiesarray<enum(10)>no
atTimenumbernomin 0, max 24
showPlanetaryHoursbooleanno
sizePxintegernomin 160, max 1024, int
mode"light" | "dark"no
palette.backgroundstringno
palette.ringstringno
palette.arcstringno
palette.textstringno

Example request

{
  "method": "clock",
  "date": {
    "year": 2024,
    "month": 6,
    "day": 1
  },
  "latitude": 51.5074,
  "longitude": -0.1278
}

Example response (captured; long values elided)

{
  "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 760 760\" width=\"760\" height=\"760\"><rect width=\"760\" height=\"760\" fi… (141771 chars total)",
  "events": [
    {
      "body": "Sun",
      "riseJdUT": 2460462.658881,
      "setJdUT": 2460463.339373,
      "culminationJdUT": 2460462.998911,
      "circumpolar": false
    },
    {
      "body": "Moon",
      "riseJdUT": 2460462.560966,
      "setJdUT": 2460463.07643,
      "culminationJdUT": 2460462.812367,
      "circumpolar": false
    },
    {
      "body": "Mercury",
      "riseJdUT": 2460462.63589,
      "setJdUT": 2460463.277622,
      "culminationJdUT": 2460462.955917,
      "circumpolar": false
    },
    {
      "body": "Venus",
      "riseJdUT": 2460462.65922,
      "setJdUT": 2460463.334377,
      "culminationJdUT": 2460462.996453,
      "circumpolar": false
    },
    {
      "body": "Mars",
      "riseJdUT": 2460462.586978,
      "setJdUT": 2460463.150251,
      "culminationJdUT": 2460462.868327,
      "circumpolar": false
    },
    {
      "body": "Jupiter",
      "riseJdUT": 2460462.643276,
      "setJdUT": 2460463.297187,
      "culminationJdUT": 2460462.970162,
      "circumpolar": false
    },
    {
      "body": "Saturn",
      "riseJdUT": 2460462.548286,
      "setJdUT": 2460463.008856,
      "culminationJdUT": 2460462.77856,
      "circumpolar": false
    }
  ],
  "planetaryHours": {
    "weekday": "Saturday",
    "dayRuler": "Saturn",
    "sunriseJdUT": 2460462.658881,
    "sunsetJdUT": 2460463.339373,
    "nextSunriseJdUT": 2460463.658362,
    "hours": [
      {
        "index": 0,
        "ruler": "Saturn",
        "startJdUT": 2460462.658881,
        "endJdUT": 2460462.715589,
        "isDay": true
      },
      {
        "index": 1,
        "ruler": "Jupiter",
        "startJdUT": 2460462.715589,
        "endJdUT": 2460462.772297,
        "isDay": true
      },
      {
        "index": 2,
        "ruler": "Mars",
        "startJdUT": 2460462.772297,
        "endJdUT": 2460462.829004,
        "isDay": true
      },
      {
        "index": 3,
        "ruler": "Sun",
        "startJdUT": 2460462.829004,
        "endJdUT": 2460462.885712,
        "isDay": true
      },
      {
        "index": 4,
        "ruler": "Venus",
        "startJdUT": 2460462.885712,
        "endJdUT": 2460462.94242,
        "isDay": true
      },
      {
        "index": 5,
        "ruler": "Mercury",
        "startJdUT": 2460462.94242,
        "endJdUT": 2460462.999127,
        "isDay": true
      },
      {
        "index": 6,
        "ruler": "Moon",
        "startJdUT": 2460462.999127,
        "endJdUT": 2460463.055835,
        "isDay": true
      },
      {
        "index": 7,
        "ruler": "Saturn",
        "startJdUT": 2460463.055835,
        "endJdUT": 2460463.112543,
        "isDay": true
      },
      "… 16 more items"
    ]
  }
}

Rendered example

astro_render_planetary_clock.clock example render (watchmaker style)