API access

Version 1.0.0

An API is available, allowing this product to be accessed programmatically. The base URL for the API routes is "https://idoc-ssa-prod.ias.u-psud.fr/api/s050a"; this is not a valid URL by itself, but the API URLs are obtained by adding the route path to this base URL. Here we give some examples of the most useful routes.

Access to the latest nowcast data

Route: GET /nowcast/

• Parameters: none
• Example: https://idoc-ssa-prod.ias.u-psud.fr/api/s050a/nowcast/
• Response:
  • HTTP 200: maps found; a JSON file provides a list of these maps.
  • HTTP 204: no map found.

Route: GET /map/nowcast/{channel}

• Parameters:
  • channel: SDO/AIA channel (e.g. 171)
• Example: https://idoc-ssa-prod.ias.u-psud.fr/api/s050a/nowcast/171
• Response:
  • HTTP 200: maps found; a JSON file provides a list of these maps.
  • HTTP 204: no map found.

Access to the latest forecast data

Route: GET /forecast/

• Parameters: none
• Example: https://idoc-ssa-prod.ias.u-psud.fr/api/s050a/forecast/
• Response:
  • HTTP 200: maps found; a JSON file provides a list of these maps.
  • HTTP 204: no map found.

Route: GET /forecast/{channel}/{delta_days}

• Parameters:
  • channel: SDO/AIA channel (e.g. 171)
  • delta_days: forecast horizon, in days
• Example: https://idoc-ssa-prod.ias.u-psud.fr/api/s050a/forecast/171/1
• Response:
  • HTTP 200: maps found; a JSON file provides a list of these maps.
  • HTTP 204: no map found.

Access to the archived data

Route: POST /map

• Parameters: a JSON payload containing query parameters, e.g.

      {
      "start_date": "2021-06-01",
      "end_date": "2021-06-10",
      "channels": [
          "211",
          "304",
          "335",
      ],
      "map_type": [
          "forecast",
          "nowcast",
          "temporary",
          "archived"
      ],
      "latest": true
      }
          

• Response:
  • HTTP 200: maps found; a JSON file provides a list of these maps.
  • HTTP 204: no map found.

Limitation

No specific limitations.