Star Map (SVG)

POST

/render/star-map

• Production

Stereographic projection of caller-supplied points (RA/Dec). Handles brightness magnitude scaling and labels.

Authorizations

• ApiKeyAuth

Code Samples

cURL

curl -X POST https://api.astroway.info/v1/render/star-map \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "points": [ { "raHours": 5.92, "decDeg": 7.41, "magnitude": 0.45, "name": "Betelgeuse" } ], "title": "Orion" }'

Node.js

const res = await fetch('https://api.astroway.info/v1/render/star-map', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "points": [
      {
        "raHours": 5.92,
        "decDeg": 7.41,
        "magnitude": 0.45,
        "name": "Betelgeuse"
      }
    ],
    "title": "Orion"
  }),
});
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/star-map',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'points': [
        {
          'raHours': 5.92,
          'decDeg': 7.41,
          'magnitude': 0.45,
          'name': "Betelgeuse"
        }
      ],
      'title': "Orion"
    },
)
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/star-map', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'points' => [[
            'raHours' => 5.92,
            'decDeg' => 7.41,
            'magnitude' => 0.45,
            'name' => 'Betelgeuse',
        ]],
        'title' => 'Orion',
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Request Body ^required

object

points

required

Array<object>

>= 1 items <= 2000 items

object

raHours

number

<= 24

raDeg

number

<= 360

decDeg

required

number

>= -90 <= 90

magnitude

number

name

string

<= 40 characters

glyph

string

<= 8 characters

observerLatDeg

number

>= -90 <= 90

zenithDecDeg

number

>= -90 <= 90

capAltitudeDeg

number

>= -90 <= 90

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

Example

{
  "points": [
    {
      "raHours": 5.92,
      "decDeg": 7.41,
      "magnitude": 0.45,
      "name": "Betelgeuse"
    }
  ],
  "title": "Orion"
}

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

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