Star Map (SVG)

POST

/render/star-map

request.sh

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

▸ Спробувати POST /render/star-map

• Production

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

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

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

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

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