Fixed star catalogue

GET

/fixed-stars/catalog

curl -X GET https://api.astroway.info/v1/fixed-stars/catalog \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json"

const res = await fetch('https://api.astroway.info/v1/fixed-stars/catalog', {
  method: 'GET',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

import os, requests

r = requests.get(
    'https://api.astroway.info/v1/fixed-stars/catalog',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->get('fixed-stars/catalog', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

The star names this API accepts, from Swiss Ephemeris fixstars.cat: traditional name, Bayer nomenclature, constellation and magnitude, with the 36-star astrological default set flagged. Optional ?maxMagnitude= trims to the bright end. Static lookup, no chart needed.

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

Responses

200

Successful calculation

application/json

object

boolean

data

object

count

number

nullable

total

number

nullable

defaultSetSize

number

nullable

maxMagnitude

nullable

source

string

nullable

stars

Array<object>

nullable

object

name

string

nullable

traditionalName

string

nullable

nomenclature

string

nullable

constellation

string

nullable

magnitude

number

nullable

default

boolean

nullable

Example

{
  "ok": true,
  "data": {
    "count": 953,
    "total": 953,
    "defaultSetSize": 36,
    "maxMagnitude": null,
    "source": "Swiss Ephemeris fixstars.cat",
    "stars": [
      {
        "name": "Sirius",
        "traditionalName": "Sirius",
        "nomenclature": "alCMa",
        "constellation": "Canis Major",
        "magnitude": -1.47,
        "default": true
      }
    ]
  }
}

400

Validation error

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

application/json

Example

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

Корисно?