Eclipses

POST

/eclipses

request.sh

curl -X POST https://api.astroway.info/v1/eclipses \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "year": 2024, "yearsRange": 2 }'

▸ Try it POST /eclipses

• Production

Find solar and lunar eclipses within a given year or multi-year range. Returns type, date, and geographic visibility data.

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

year required

number

nullable

yearsRange

number

>= 1e-9 <= 20

Example

{
  "year": 2024,
  "yearsRange": 2
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

eclipses

Array<object>

nullable

object

kind

string

nullable

type

string

nullable

maxJd

number

nullable

maxDate

string

nullable

beginJd

number

nullable

beginDate

string

nullable

endJd

number

nullable

endDate

string

nullable

longitude

number

nullable

signIndex

number

nullable

totalityBeginJd

number

nullable

totalityEndJd

number

nullable

Example

{
  "ok": true,
  "data": {
    "eclipses": [
      {
        "kind": "solar",
        "type": "hybrid",
        "maxJd": 2460054.6783186323,
        "maxDate": "2023-04-20T04:16:47.000Z",
        "beginJd": 2460054.565720898,
        "beginDate": "2023-04-20T01:34:38.000Z",
        "endJd": 2460054.791215786,
        "endDate": "2023-04-20T06:59:21.000Z",
        "longitude": 29.839278300586834,
        "signIndex": 0,
        "totalityBeginJd": 2460054.6091770693,
        "totalityEndJd": 2460054.7477158764
      }
    ]
  }
}

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