Timeline (SVG)

POST

/render/timeline

• Production

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

Authorizations

• ApiKeyAuth

Code Samples

cURL

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 } }'

Node.js

const res = await fetch('https://api.astroway.info/v1/render/timeline', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "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
    }
  }),
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

Python

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/render/timeline',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      '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
      }
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

PHP

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('render/timeline', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        '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,
        ],
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Request Body ^required

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

string

Allowed values: light dark console

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

object

ok

boolean

Example

true

data

object

svg

string

format

string

byteLength

number

Example

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

400

Validation error

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

Example

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