AstronomyAPI
  • 🚀Getting Started
  • API v2 Reference
    • 🪐Bodies
      • 🌐Positions
      • 🗓️Events
    • 📸Studio
      • ✨Star Chart
      • 🌒Moon Phase
    • 🔎Search
  • 🤝Requests and Responses
    • 🪐Body Properties
    • 🕚Event Properties
    • 🔎Search Result Properties
    • 🔭Observer Parameters
    • 🗓️Tabular Responses
    • 🔢Rows Responses
    • 🚩Error Responses
    • 🔢Constellation Enums
    • 🔢DSO Enums
  • Page
  • 🧩Widgets
  • ⚠️Known Issues
  • 📕Changelog
  • Links
    • demo.astronomyapi.com
    • Sample code on Github
    • Back to Dashboard
Powered by GitBook
On this page

Was this helpful?

  1. Requests and Responses

Event Properties

PreviousBody PropertiesNextSearch Result Properties

Last updated 1 year ago

Was this helpful?

And Event object is returned when body events are requested using the.

Section
Sub Section
Data Type
Description

type

string

Describes the event type. This can be either of total_lunar_eclipse, total_solar_eclipse, annular_solar_eclipse, partial_solar_eclipse, partial_lunar_eclipse or penumbral_lunar_eclipse

eventHighlights

-

object

Contains the event highlights

penumbralStart

object

Start of the penumbral eclipse. Available for the moon only.

partialStart

object

Start of the partial eclipse and the altitude from the horizon. Available for both the sun and the moon,

fullStart

object

Start of the full eclipse and the altitude from the horizon. Available for the moon only.

totalStart

object

Start of the total eclipse and the altitude from the horizon. Available for the sun only.

peak

object

Peak of the event and the altitude from the horizon. Available for both the sun and the moon

totalEnd

object

End of the total eclipse and the altitude from the horizon. Available for the sun only.

fullEnd

object

End of the full eclipse and the altitude from the horizon. Available for the moon only.

partialEnd

object

End of the partial eclipse and the altitude from the horizon. Available for both the sun and the moon,

penumbralEnd

object

Endrt of the penumbral eclipse and the altitude from the horizon. Available for the moon only.

rise

object

Rise time of the object for the date and the altitude from the horizon.

set

object

Set time of the object for the date and the altitude from the horizon.

extraInfo

object

Any other information.

Sample response object

{
    "data": {
        "dates": {
            "from": "2020-12-20T09:00:00.000-05:00",
            "to": "2022-12-23T09:00:00.000-05:00"
        },
        "observer": {
            "location": {
                "longitude": -84.39733,
                "latitude": 38.775867,
                "elevation": 0
            }
        },
        "rows": [
            {
                "body": {
                    "id": "sun",
                    "name": "Sun"
                },
                "events": [
                    {
                        "type": "partial_solar_eclipse",
                        "eventHighlights": {
                            "partialStart": {
                                "date": "2021-06-10T03:45:15.241-05:00",
                                "altitude": -13.56
                            },
                            "totalStart": null,
                            "peak": {
                                "date": "2021-06-10T04:37:30.267-05:00",
                                "altitude": -5.85
                            },
                            "totalEnd": null,
                            "patialEnd": {
                                "date": "2021-06-10T05:32:52.677-05:00",
                                "altitude": 2.92
                            }
                        },
                        "rise": "2021-06-10T10:12:14.143Z",
                        "set": "2021-06-11T01:02:13.766Z",
                        "extraInfo": {
                            "obscuration": 0.76
                        }
                    }
                ]
            }
        ]
    }
}
{
    "data": {
        "dates": {
            "from": "2020-12-20T09:00:00.000-05:00",
            "to": "2022-12-23T09:00:00.000-05:00"
        },
        "observer": {
            "location": {
                "longitude": -84.39733,
                "latitude": 38.775867,
                "elevation": 0
            }
        },
        "rows": [
            {
                "body": {
                    "id": "moon",
                    "name": "Moon"
                },
                "events": [
                    {
                        "type": "total_lunar_eclipse",
                        "eventHighlights": {
                            "pemumbralStart": {
                                "date": "2022-05-15T20:32:25.341-05:00",
                                "altitude": 9.53
                            },
                            "partialStart": {
                                "date": "2022-05-15T21:28:25.341-05:00",
                                "altitude": 17.45
                            },
                            "fullStart": {
                                "date": "2022-05-15T22:29:25.341-05:00",
                                "altitude": 24.44
                            },
                            "peak": {
                                "date": "2022-05-15T23:11:25.341-05:00",
                                "altitude": 27.93
                            },
                            "fullEnd": {
                                "date": "2022-05-15T23:53:25.341-05:00",
                                "altitude": 30.09
                            },
                            "partialEnd": {
                                "date": "2022-05-16T00:54:25.341-05:00",
                                "altitude": 30.58
                            },
                            "pemumbralEnd": {
                                "date": "2022-05-16T01:50:25.341-05:00",
                                "altitude": 28.22
                            }
                        },
                        "rise": "2022-05-16T00:28:34.597Z",
                        "set": "2022-05-17T11:22:15.102Z",
                        "extraInfo": {
                            "obscuration": 1
                        }
                    }
                ]
            }
        ]
    }
}
🤝
🕚
Events API