Timeline (SVG)

POST

/render/timeline

request.sh

curl -X POST https://api.astroway.info/v1/render/timeline \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "rangeStart": "2026-01-01", "rangeEnd": "2026-12-31", "events": [ { "label": "Saturn ☐ Sun", "start": "2026-03-15", "end": "2026-04-20", "exact": "2026-04-02", "category": "Square" } ], "options": { "theme": "light", "width": 1000 } }'

▸ Try it POST /render/timeline

• Production

Gantt-style horizontal timeline of transit/aspect events over a date window. Caller supplies events array.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

fields

string

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

Example

planets.name,planets.longitude

precision

integer

<= 15

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Example

4

Request Body ^required

Media type application/json

object

rangeStart required

string

/^\d{4}-\d{2}-\d{2}$/

rangeEnd required

string

/^\d{4}-\d{2}-\d{2}$/

events required

Array<object>

>= 1 items <= 200 items

object

label required

string

>= 1 characters <= 120 characters

start required

string

/^\d{4}-\d{2}-\d{2}$/

end required

string

/^\d{4}-\d{2}-\d{2}$/

exact

string

/^\d{4}-\d{2}-\d{2}$/

category

string

<= 40 characters

color

string

<= 20 characters

options

object

size

integer

>= 200 <= 2000

theme

Css paints every colour as var(—aw-, ), so the page that inlines the SVG can recolour it with CSS custom properties (—aw-chart-bg, —aw-fg, —aw-muted, —aw-ring, —aw-houses-fill, —aw-benefic, —aw-malefic, —aw-aspect-harmonious, —aw-aspect-tense, —aw-aspect-neutral, —aw-aspect-minor, —aw-aspect-quintile, —aw-moon-shadow, —aw-moon-light, —aw-cycle-physical, —aw-cycle-emotional, —aw-cycle-intellectual). With none set it looks exactly like light. Inside an the variables cannot be set, so it stays light. The Western wheels and the aspect grid then also carry stable aw-* classes, and each planet is a with data-planet and data-label, each aspect line has data-a and data-b; see the @astroway/render changelog for the list.

string

Allowed values: light dark console css

showAspects

boolean

showRetrograde

boolean

title

string

<= 120 characters

format

string

default: json

Allowed values: svg json

width

integer

>= 400 <= 3000

rowHeight

integer

>= 16 <= 60

Example

{
  "rangeStart": "2026-01-01",
  "rangeEnd": "2026-12-31",
  "events": [
    {
      "label": "Saturn ☐ Sun",
      "start": "2026-03-15",
      "end": "2026-04-20",
      "exact": "2026-04-02",
      "category": "Square"
    }
  ],
  "options": {
    "theme": "light",
    "width": 1000
  }
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

svg

string

nullable

format

string

nullable

byteLength

number

nullable

Example

{
  "ok": true,
  "data": {
    "svg": "<svg ...>",
    "format": "svg",
    "byteLength": 3321
  }
}

400

Validation error

Media type application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Date must be YYYY-MM-DD",
    "details": [
      {
        "path": "date",
        "message": "Date must be YYYY-MM-DD"
      }
    ]
  }
}

401

Missing or invalid API key

Media type application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}