Health Check

GET

/health

const url = 'https://api.astroway.info/v1/health?fields=planets.name%2Cplanets.longitude&precision=4';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.astroway.info/v1/health?fields=planets.name%2Cplanets.longitude&precision=4' \
  --header 'X-Api-Key: <X-Api-Key>'

Returns API health status. No authentication required.

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

API is healthy

application/json

object

boolean

data

object

status

string

version

string

uptime_seconds

number

timestamp

string

Example

{
  "ok": true,
  "data": {
    "status": "ok",
    "version": "2.157.1",
    "uptime_seconds": 295,
    "timestamp": "2026-08-23T13:07:23.339Z"
  }
}

Was this helpful?