Data

Retrieve licensed STOREtrack project and market-trends data using a bearer token issued by the Data Portal API.

1. Request a bearer token

Send a POST request to:

https://delta-portal-webapp-prd-uks-app.azurewebsites.net/external-api/auth/token

With your email address and API key:

{
  "email": "{{email}}",
  "apiKey": "{{apiKey}}"
}

Use the returned token as a bearer token when calling the STOREtrack API:

Authorization: Bearer {{token}}
Content-Type: application/json

The data returned is restricted according to the STOREtrack products, countries, and data covered by your API licence.

2. Retrieve projects

Send a POST request to:

https://storetrack-api-prd-uks-app.azurewebsites.net/api/ExternalApi/Projects

The request body is optional. Omitting it returns all projects available under your API licence.

A filter object can be supplied to restrict the results:

{
  "countries": ["GB"],
  "technologies": ["Lithium-ion"],
  "operational": ["Operational"],
  "pumpedStorage": false
}

The response is a JSON array containing the accessible STOREtrack projects which match the supplied filters.

3. Retrieve market trends

Send a POST request to:

https://storetrack-api-prd-uks-app.azurewebsites.net/api/ExternalApi/MarketTrends

An empty filter object can be used to request the default market-trends results:

{}

The external API defaults to:

  • Forecast data
  • Pumped storage excluded
  • All accessible countries, segments, installations and technologies

These defaults can be overridden in the request body:

{
  "countries": ["AA"],
  "segments": ["AA"],
  "installations": ["AA"],
  "technologies": ["AA"],
  "operational": [],
  "pumpedStorage": true,
  "actual": 1
}

The response contains aggregated STOREtrack market-trends data, including annual and cumulative power, storage capacity, and project-count figures.

Filter values

The following common filters can be supplied to either endpoint:

PropertyTypeDescription
countriesstring[]Country codes to include. Use "AA" or omit the property for all accessible countries.
segmentsstring[]Market segments to include. Use "AA" or omit the property for all segments.
installationsstring[]Installation types to include. Use "AA" or omit the property for all installation types.
technologiesstring[]Technologies to include. Use "AA" or omit the property for all technologies.
operationalstring[]Project statuses to include.
pumpedStoragebooleanWhether pumped-storage projects should be included.
actualnumberSelects actual or forecast data. See the values below.

Actual and forecast values

ValueMeaning
1Actual
2Forecast

For the Market Trends endpoint, actual defaults to 2 and pumpedStorage defaults to false. Both values can be explicitly overridden in the POST body.

Additional project filters

The Projects endpoint also supports the following optional filters:

PropertyTypeDescription
useDateRangebooleanEnables filtering using dateRange.
dateRangeobjectDate range containing startDate and endDate.
usePowerCapacityRangebooleanEnables filtering using powerCapacityRange.
powerCapacityRangeobjectPower range containing minimum and maximum.
useStorageCapacityRangebooleanEnables filtering using storageCapacityRange.
storageCapacityRangeobjectStorage range containing minimum and maximum.
useDurationRangebooleanEnables filtering using durationRange.
durationRangeobjectDuration range containing minimum and maximum.
useOperationalDateRangebooleanEnables filtering using operationalDateRange.
operationalDateRangeobjectOperational-year range containing minimum and maximum.
useUnderConstructionDateRangebooleanEnables filtering using underConstructionDateRange.
underConstructionDateRangeobjectConstruction-year range containing minimum and maximum.
useLatestUpdateWithinbooleanEnables filtering by how recently a project was updated.
latestUpdateWithinnumberMaximum age of the latest project update.
valueStreamsstring[]Value streams to include.
projectsLookingForAstringFilters projects by what they are seeking.
companiesInvolvedstring[]Companies involved in a project.
companyRolesstring[]Company roles to include.

For example:

{
  "countries": ["GB"],
  "technologies": ["Lithium-ion"],
  "pumpedStorage": false,
  "usePowerCapacityRange": true,
  "powerCapacityRange": {
    "minimum": 10,
    "maximum": 100
  },
  "useOperationalDateRange": true,
  "operationalDateRange": {
    "minimum": 2024,
    "maximum": 2030
  }
}