Stream Eclipse Totality

POST

/stream/eclipse-totality

request.sh

curl -X POST https://api.astroway.info/v1/stream/eclipse-totality \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

▸ Спробувати POST /stream/eclipse-totality

• Production

Next solar+lunar eclipses with totality info.

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

latitude

number

nullable

longitude

number

nullable

Example

{}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

timestamp

string

nullable

nextSolar

object

type

string

nullable

longitude

number

nullable

sign

string

nullable

maxAt

string

nullable

beginAt

string

nullable

endAt

string

nullable

durationHours

number

nullable

daysUntil

number

nullable

isTotal

boolean

nullable

nextLunar

object

type

string

nullable

longitude

number

nullable

sign

string

nullable

maxAt

string

nullable

beginAt

string

nullable

endAt

string

nullable

durationHours

number

nullable

daysUntil

number

nullable

isTotal

boolean

nullable

note

string

nullable

nextEventAt

string

nullable

tickSeconds

number

nullable

transport

string

nullable

sseUpgrade

string

nullable

pricing

string

nullable

Example

{
  "ok": true,
  "data": {
    "timestamp": "2026-08-23T22:05:27.448Z",
    "nextSolar": {
      "type": "annular",
      "longitude": 317.62961434553335,
      "sign": "Aquarius",
      "maxAt": "2027-02-06T15:59:40.318Z",
      "beginAt": "2027-02-06T12:57:51.310Z",
      "endAt": "2027-02-06T19:01:40.865Z",
      "durationHours": 6.06,
      "daysUntil": 166.75,
      "isTotal": false
    },
    "nextLunar": {
      "type": "partial",
      "longitude": 334.8525422076384,
      "sign": "Pisces",
      "maxAt": "2026-08-28T04:12:58.339Z",
      "beginAt": "2026-08-28T02:33:53.071Z",
      "endAt": "2026-08-28T05:52:03.261Z",
      "durationHours": 3.3,
      "daysUntil": 4.26,
      "isTotal": false
    },
    "note": "Path-of-totality geographic resolution requires per-location calculation; current API returns event-level data only.",
    "nextEventAt": "2026-08-28T04:12:58.339Z",
    "tickSeconds": 3600,
    "transport": "http-polling",
    "sseUpgrade": "Use the same endpoint with /sse subpath for Server-Sent Events (planned).",
    "pricing": "10 credits/call (Tier 1): each tick recomputes positions, so it is a live compute, not a cheap lookup. Poll on the returned `tickSeconds`; see docs/PRICING.md §11."
  }
}

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