Skip to content
Retailer
/
/
Retailer API (v1.0.0)

Retailer API (1.0.0)

The retailer interface to Emulate. Backwards incompatible changes WILL BE communicated with sufficient lead time and a deprecation period. Backward compatible changes WILL NOT BE communicated ahead of time - such as the addition of new fields/attributes to responses, or new status code responses and error types. Clients should be written in a way that accomodates backwards compatible changes.

Download OpenAPI description
retailer.json
retailer.yaml
Languages
Servers
Mock server
https://dev.emulate.energy/_mock/api/retailer/retailer/
Production server
https://api.emulate.network/v1/retailer/
Staging server
https://api.stage.emulate.network/v1/retailer/
Development server
https://api.dev.emulate.network/v1/retailer/

onboarding

Operations relating to onboarding of new devices

Operations

facilities

Operations relating to facilities (places with a meter)

Operations

devices

Operations relating to devices (electric vehicles, chargers, heat pumps, etc.)

Operations

optimization

Operations relating to spot price optimization

Operations

customers

Operations relating to customers of the retailer

Operations

reporting

Operations providing reports about devices

Operations

notifications

Operations relating to webhooks for notifications of events

Operations

miscellaneous

Assorted operations not needed in typical use of the API

Operations

legacy

Legacy operations that are deprecated and will be removed

A test route while we get the composite API gateway working

Request

curl -i -X GET \
  https://dev.emulate.energy/_mock/api/retailer/retailer/example-brp

Responses

Success

Update customer's device's custom name

Request

Sets the device's label custom_device_name to the value supplied in the request body

Path
customerIdstringrequired

String ID of the customer

deviceIdstring(uuid)required

UUID of the device

Bodyapplication/jsonrequired
custom_device_namestringrequired

Custom name that is to be set

curl -i -X PATCH \
  'https://dev.emulate.energy/_mock/api/retailer/retailer/customers/{customerId}/devices/{deviceId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_device_name": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "custom_device_name": "string"
  }
}

Get gateways among given device IDs

Request

Bodyapplication/jsonrequired
device_idsArray of strings(uuid)required
curl -i -X POST \
  https://dev.emulate.energy/_mock/api/retailer/retailer/gateways/by-device-ids \
  -H 'Content-Type: application/json' \
  -d '{
    "device_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

List of gateway IDs

Bodyapplication/json
dataobjectrequired
data.​device_idsArray of strings(uuid)required
Response
application/json
{
  "data": {
    "device_ids": [ … ]
  }
}

virtual-batteries

Operations

predefined-schedules

Operations

gateways

Operations

my-gateways

Operations

simulation

Operations

downtime

Operations

vbatt

Operations

gateway

Operations

notification

Operations

btm-ops

Operations

markets

Operations