List V2

get

https://developer-api.partner.mygridshare.com/api/v2/sites

List all sites, with a richer set of filters, sorting options, and per-site data (devices, tariffs, alerts, production) than the /api/v1/sites endpoint

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

generalSearch

string

Filter for sites matching this text in their site ID, device ID, device physical ID, site reference, or address.

address

string

Filter for sites by address

centerLatitude

number

-90 to 90

Latitude (WGS84 decimal degrees) of the centre for a radius search. Must be given together with centerLongitude and radiusKm.

centerLongitude

number

-180 to 180

Longitude (WGS84 decimal degrees) of the centre for a radius search.

radiusKm

number

≥ 0.1

Radius in kilometres for a radius search. Returns sites within this great-circle distance of the centre point. Minimum 0.1. For areas larger than a few hundred kilometres prefer a bounding box.

bbox

string

Filter for sites inside a bounding box, given as four comma-separated numbers in the order west,south,east,north (i.e. minLongitude,minLatitude,maxLongitude,maxLatitude, as in GeoJSON RFC 7946). Latitudes must be between -90 and 90 and longitudes between -180 and 180. If west is greater than east the box is treated as crossing the antimeridian (180° longitude). For example -123,36.9,-121.5,38.5 covers the San Francisco Bay Area. If a radius search is also given, sites must satisfy both.

groupIds

array of strings

Filter for sites in any of the given groups.

groupIds

createdAtFrom

date-time

Filter for sites created at or after this time (inclusive).

createdAtTo

date-time

Filter for sites created before this time (exclusive).

operationMode

array of strings

Filter for sites with any of the given operation modes.

operationMode

Allowed:

operationModeTag

array of strings

Filter for sites with any of the given Lunar operation mode tags.

operationModeTag

weatherAlertsEnabled

boolean

Filter for sites with weather alerts enabled or disabled.

hasPto

boolean

Filter for sites that do or don't have a permission-to-operate date.

ptoFrom

date-time

Filter for sites with a permission-to-operate date at or after this time (inclusive).

ptoTo

date-time

Filter for sites with a permission-to-operate date before this time (exclusive).

hasAppCustomers

boolean

Filter for sites that do or don't have any app customers.

deviceOem

array of strings

Filter for sites with a device from any of the given OEMs.

deviceOem

deviceCategory

array of strings

Filter for sites with a device in a given category. Each entry is a colon-separated category:value pair, e.g. batteryStorage:any.

category is one of:

aggregateBattery — a virtual grouping of multiple battery devices
aggregateElectricVehicle — a virtual grouping of multiple EV devices
batteryStorage — a battery storage device
electricVehicle — an electric vehicle
evse — an EV charger
hotWaterTank — a hot water tank / water heating device
hvac — a heating/cooling (HVAC) device
microgridInterconnectionDevice — a microgrid interconnection device
smartBreaker — a smart breaker device
solar — a solar PV device

value is one of:

any — include sites which have at least one device in that category
none — include sites which have zero devices in that category

deviceCategory

importTariff

array of strings

Filter for sites with any of the given import tariffs, each entry encoded as companyName::tariffName.

importTariff

exportTariff

array of strings

Filter for sites with any of the given export tariffs, each entry encoded as companyName::tariffName.

exportTariff

criticalAlertsCount

integer

≥ 0

Filter for sites with at least this many critical alerts in the last 24 hours.

warningAlertsCount

integer

≥ 0

Filter for sites with at least this many warning alerts in the last 24 hours.

infoAlertsCount

integer

≥ 0

Filter for sites with at least this many info alerts in the last 24 hours.

lowProduction

boolean

Filter for sites with low (true) or normal (false) average daily solar production.

sortBy

string

enum

The field to sort results by.

sortOrder

string

enum

The order to sort results in. Defaults to asc.

Allowed:

maxResults

integer

1 to 500

Specifies the maximum number of sites that should be returned. Max 500, default 25.

nextToken

string

Used to retrieve the next batch of results.

Responses

200200 response

400400 response

401401 response

403403 response

422422 response