RealtimeWind API Documentation

Welcome to the RealtimeWind API documentation page. This API allows you to schedule operational commands for wind assets via JSON over HTTP.

Endpoint

The primary endpoint for scheduling new commands is:

POST https://eddygrid.realtimewind.nl/api/write

Request Structure

All requests use JSON in their request body. A typical request contains:

operation: Specifies the parameters of the wind operation. For example:
- "limit": Either null or an object with either "activePower" or "activePowerPercentage", each a numeric value. Example: {"limit": {"activePower": 100}} or {"limit": {"activePowerPercentage": 30}}.
- "reactivePower": A number or null.
startAt: The UTC date and time the operation should start (ISO 8601 format).
endAt: The UTC date and time the operation should end (ISO 8601 format).
type: The type of command, e.g. "setWindOperation".

An example JSON body:

{
  "operation": {
    "limit": null,
    "reactivePower": null
  },
  "startAt": "2025-02-18T12:00:00Z",
  "endAt": "2025-02-19T18:00:00Z",
  "type": "setWindOperation"
}

Example `curl` Requests

1. Basic Scheduling Command (limit is null)

curl -ik -X POST https://eddygrid.realtimewind.nl/api/write \
  -d '{
    "operation": {"limit": null, "reactivePower": null},
    "startAt": "2025-02-18T12:00:00Z",
    "endAt": "2025-02-19T18:00:00Z",
    "type": "setWindOperation"
  }'

2. Schedule with Specific Active Power

curl -ik -X POST https://eddygrid.realtimewind.nl/api/write \
  -d '{
    "operation": {"limit": {"activePower": 80}, "reactivePower": 40},
    "startAt": "2025-02-20T00:00:00Z",
    "endAt": "2025-02-21T12:00:00Z",
    "type": "setWindOperation"
  }'

3. Schedule with Active Power Percentage

curl -ik -X POST https://eddygrid.realtimewind.nl/api/write \
  -d '{
    "operation": {"limit": {"activePowerPercentage": 50}, "reactivePower": 0},
    "startAt": "2025-03-01T08:00:00Z",
    "endAt": "2025-03-01T20:00:00Z",
    "type": "setWindOperation"
  }'

These commands demonstrate how to construct JSON bodies for the API. Adjust timestamps, operation fields, and the command type according to your needs.

Response Format

The API will return http response code 20x on success, with an empty body.

On error, the API responds with a http error code, 4xx or 5xx. An error response body might include:

{
  "key": "error_key",
}

Additional Notes

All timestamps must be in valid ISO 8601 format (e.g., YYYY-MM-DDTHH:MM:SSZ).
Ensure that your JSON payload is properly escaped if passing directly in the command line.
Refer to official scheduling documentation for additional rules regarding scheduling intervals and asset configuration.

RealtimeWind API