Schedule

Retrieve Current Schedule

Changed on

Retrieve the current availability and curtailment schedule for a premium resource. Use issue_time to query historical schedule state.

get/manage/schedules

Request

  • Base URL
    https://api.solcast.com.au (the document declares no server; this is the origin it was published from)
  • URL
    https://api.solcast.com.au/manage/schedules
  • Auth
    none declared

Query parameters

resource_idstring nullable required

The resource id.

period_startstring date-time nullable required

Start of the query window (ISO 8601). Must be on a 5-minute boundary.

period_endstring date-time nullable required

End of the query window (ISO 8601). Must be on a 5-minute boundary.

issue_timestring date-time nullable

Return the schedule as it existed at this point in time (ISO 8601). When omitted, the latest schedule is returned.

format'json' | 'csv' nullable

Response format. Default is HTML if not supplied.

Response

OK

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      added the new optional query request parameter format