System

API Key Introspection

Changed on

Return metadata about the calling API key: plan, remaining credits, period end, bound domain, status. Useful for any SDK consumer that wants to surface plan and balance in its own UI. A key that is not metered (internal, or a custom plan without a limit) returns credits_remaining and credits_total_this_period as null with unlimited: true; a site key returns them as null with limits.per_hour.

get/auth/keys/me

Request

  • Base URL: https://api.astroway.info/v1
  • URL: https://api.astroway.info/v1/auth/keys/me
  • 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

  • b64222844186Revision changes
    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter precision