System

Status of the key you authenticate with: its plan and rate limit, request counts for today, this week and this month, the top endpoints it calls, and a daily series. Authenticate with the X-Api-Key header; without one the answer is 400 MISSING_KEY. The ?key= query parameter still works but is deprecated and answers carry a Deprecation header: a URL ends up in access logs, CDN logs and browser history, so a key passed that way stops being secret.

get/status

Request

  • Base URL: https://api.astroway.info/v1
  • URL: https://api.astroway.info/v1/status
  • Auth: API key in header X-Api-Key

Query parameters

fieldsstring

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.

precisioninteger

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.

Response

Successful calculation

okboolean

Example response

{
  "ok": true
}

Changes

    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter precision

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status