Eclipse Path Map (SVG)

POST

/render/eclipse-path

• Production

Equirectangular world graticule with caller-supplied eclipse track. Renders centerline + shaded band of given degree-width.

Authorizations

• ApiKeyAuth

Code Samples

cURL

curl -X POST https://api.astroway.info/v1/render/eclipse-path \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "path": [ { "latitude": 40, "longitude": -100 }, { "latitude": 35, "longitude": -90 } ], "bandWidthDeg": 3, "title": "Eclipse 2026" }'

Node.js

const res = await fetch('https://api.astroway.info/v1/render/eclipse-path', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "path": [
      {
        "latitude": 40,
        "longitude": -100
      },
      {
        "latitude": 35,
        "longitude": -90
      }
    ],
    "bandWidthDeg": 3,
    "title": "Eclipse 2026"
  }),
});
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/eclipse-path',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'path': [
        {
          'latitude': 40,
          'longitude': -100
        },
        {
          'latitude': 35,
          'longitude': -90
        }
      ],
      'bandWidthDeg': 3,
      'title': "Eclipse 2026"
    },
)
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/eclipse-path', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'path' => [[
            'latitude' => 40,
            'longitude' => -100,
        ], [
            'latitude' => 35,
            'longitude' => -90,
        ]],
        'bandWidthDeg' => 3,
        'title' => 'Eclipse 2026',
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Request Body ^required

object

path

required

Array<object>

>= 2 items <= 500 items

object

latitude

required

number

>= -90 <= 90

longitude

required

number

>= -180 <= 180

time

string

<= 40 characters

centerlinePoints

Array<object>

<= 500 items

object

latitude

required

number

>= -90 <= 90

longitude

required

number

>= -180 <= 180

time

string

<= 40 characters

bandWidthDeg

number

>= 0.1 <= 20

title

string

<= 120 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

height

integer

>= 200 <= 1500

showGraticule

boolean

pathColor

string

<= 20 characters

Example

{
  "path": [
    {
      "latitude": 40,
      "longitude": -100
    },
    {
      "latitude": 35,
      "longitude": -90
    }
  ],
  "bandWidthDeg": 3,
  "title": "Eclipse 2026"
}

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": 4500
  }
}

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