API docs by Redocly

OPALE API (20260916.0)

Download OpenAPI specification:Download

OPALE API: no-reply@imcce.fr URL: https://opale.imcce.fr/ License: Terms of Service

OPALE provides a catalog of APIs to fetch the ephemerids data

Status of the service

Get the status of the service.

Example: https://opale.imcce.fr/api/status

Responses

Response samples

Content type
application/json
{
  • "apiVersion": "2026.09.16",
  • "description": "Opale API service 2026.09.16 is available and is running the library version 2026.9.15",
  • "libraryVersion": "2026.9.15",
  • "status": "OK"
}

Eclipses of the Moon or the Sun

Get all lunar or solar eclipses for an optional given date. If the date is not provided, the eclipses of the current year are returned. The instants of the events are given in the timescale UTC for the dates after 1962 and UT1 for the dates before 1962.

A response, which contains the information about the eclipses, is returned to the client encoded in json format, by default. A map of the visibility of the eclipse on the Earth is streamed to the client if the header Accept of the request specifies the MIME media types image/svg+xml, application/pdf or application/postscript and the date is a calendar day. This behavior can be replaced by the query parameter format.

Examples:

Capabilities : https://opale.imcce.fr/api/v1/phenomena/eclipses/capability

path Parameters
body
required
integer
Enum: 10 301
Example: 301

NAIF identification number of the body.

  • 10 for solar eclipse
  • 301 for lunar eclipse
required
Year (string) or Calendar date (string)
Example: 2026

Filter by year or day.

The supported calendars are :

  • gregorian : Gregorian calendar. In early eras, the adopted calendar is the proleptic Gregorian calendar. It complies with the ISO 8601 standard.
  • julian : Julian calendar. In early eras, the adopted calendar is the proleptic Julian calendar. It follows the astronomical year numbering, which includes the year 0.

If the calendar is not given, then date is assumed to be expressed in the (proleptic) gregorian calendar.

query Parameters
nbd
integer [ 1 .. 10 ]
Default: 1
Example: nbd=1

Number of years to compute

NAIF Identification (integer) or observatory code (string) or Array of (geodetic latitude, longitude, and optionally the altitude) (numbers)

Location of the observer. General circumstances of the solar eclipses are computed (default case) if the observer is located at the geocenter, otherwise, local circumstances are computed. This parameter is ignored for the lunar eclipses.

format
string
Default: "json"
Enum: "json" "image" "video"
Example: format=json

The response format. The default response format is given by the header request Accept. If format is given, the header request Accept is ignored. If the format is image, the image bytes are directly streamed to the client.

image-format
string
Default: "svg"
Enum: "svg" "eps" "pdf"
Example: image-format=svg

The format of the exported image. The default format of the exported image is svg.

video-format
string
Default: "mp4"
Enum: "hls" "mp4" "webm"
Example: video-format=mp4

The format of the exported video. The default format of the exported video is mp4.

video-definition
string
Default: "HD"
Enum: "custom" "SD" "HD" "FHD"
Example: video-definition=HD

The definition of the exported video. The default definition of the exported video is HD.

  • custom : the resolution is given by the parameter image-size.
  • SD : the number of lines of video is set to 576. The width of the video is adjusted in order to respect the projection.
  • HD : the number of lines of video is set to 720. The width of the video is adjusted in order to respect the projection.
  • FHD : the number of lines of video is set to 1080. The width of the video is adjusted in order to respect the projection.
Array of integers or strings = 2 items
Default: [800,600]
Example: image-size=800,600

The size (width , height) of the exported image in pixels. The default size of the export image is (800,600). If one component is auto, then its size in pixels is automatically set to maximize the visible world depending of the projection.

image-style
string
Default: "ssp"
Enum: "ssp" "newsletter"
Example: image-style=ssp

The style of the exported image. The default style of the export image is ssp.

map-projection
string
Default: "EPSG:3395"
Enum: "EPSG:3395" "EPSG:3857" "EPSG:9840" "EPSG:9820" "EPSG:9825" "ESRI:54026"
Example: map-projection=EPSG:3395

The projection of the map. The default projection is the Mercator conformal projection (EPSG:3395).

  • EPSG:3395 : Mercator conformal projection
  • EPSG:3857 : Web-Mercator or pseudo-Mercator projection
  • EPSG:9820 : Lambert Azimuthal Equal Area
  • EPSG:9825 : Pseudo Plate Carree
  • EPSG:9840 : Orthographic projection
  • ESRI:54026 : Stereographic projection
map-center
Array of numbers = 2 items [ items [ -180 .. 180 ] ]
Default: [0,0]
Example: map-center=0,0

The geodetic longitude and latitude of the center of the projection of the map, expressed in decimal degrees. The longitude is the first argument and the latitude is the second argument.

map-theme
string
Default: "land-small"
Enum: "land-small" "land-medium" "country-small" "country-medium"
Example: map-theme=land-small

The background theme of the map. The default content include the lands and major islands. Images produced with the theme '-small' have a size in bytes smaller than those generated with '-medium'.

  • land-small : show the lands and major islands. Suitable for schematic map of the eclipse
  • land-medium : show the lands and major islands. Suitable for detailed map of the eclipse
  • country-small : show the country boundaries. Suitable for schematic map of the eclipse
  • country-medium : show the country boundaries. Suitable for detailed map of the eclipse
map-zoom
number [ 1 .. 20 ]
Default: 1
Example: map-zoom=1

The zoom level. The lowest level 1 is the lowest zoom level (fully zoomed out) and 20 is the highest level (fully zoomed in). The zoom level determines how much of the world is visible on a map.

map-labels
string
Default: "none"
Enum: "none" "en" "fr"
Example: map-labels=none

Display the label of the lines of the events on the map.

  • none : no label is displayed.
  • en : english labels (P1, U1, U2, U3, U4, P4) are displayed.
  • fr : french labels (P1, O1, T1, T2, O2, P2) are displayed.
map-meridian-zenith
boolean
Default: false
Example: map-meridian-zenith=false

Show, as a solid line on the map, the meridian where the moon is at the zenith at the greatest event.

Responses

Response samples

Content type
{
  • "link": {},
  • "request": {
    },
  • "response": {