Availability_V2

Get monthly availability and PR (performance ratio) data for an
installation (insts_id) - not a device_id. Pre-calculated monthly by a
crontask (availability_month), not recomputed on request.

You can enter a range of months to get data for that period.

/v2/availability/<insts-id>/?start=XXX&end=XXX

Arguments

  • insts_id [*]: Installation id number.

  • start: (Optional) (yyyy-mm-dd) Start month (any day of month works,
    only year/month matter). Defaults to 12 months ago.

  • end: (Optional) (yyyy-mm-dd) End month. Defaults to today.

Response

JSON object with the result. May return the following errors:

  • 404 Not found : No installation found or don't have rights to get data
  • 400 Wrong insts id: The id format is incorrect
  • 400 Bad Dates: Dates entered are incorrect
  • 204 No data found: The data entered have not produced any results

Example

Get the last 12 months of availability for insts_id 21

GET /v2/availability/21 HTTP/1.1
Host: apiexternal.mvscada.com
MV-API-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Content-Type: application/json

Response

{
    "insts_id": 21,
    "insts_name": "Agrupación Carbonero",
    "start": "2025-09-15",
    "end": "2026-09-15",
    "availability": [
        {
            "availability_month_date": "2026-08-01",
            "availability_month_availability": 99.120,
            "availability_month_hours_period": 744.00,
            "availability_month_hours_excluded": 2.50,
            "availability_month_hours_una": 0.00,
            "availability_month_pr": 84.231,
            "availability_month_exported": 123456.789,
            "availability_month_estimated": 146600.000,
            "availability_month_pr_nc": 85.900,
            "availability_month_exported_nc": 124000.000,
            "availability_month_estimated_nc": 144000.000,
            "availability_month_detail": {"...": "..."},
            "availability_month_calculated": "2026-09-01 03:00:00"
        }
    ]
}

Other examples

Get a specific range of months

/v2/availability/<insts-id>/?start=2026-01-01&end=2026-06-30