API endpoints

Tumble dryers

The base URL for all paths is https://staging.create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Air vented tumble dryers: arrow image

Path

/api/v1/tumble-dryers/air-vented-tumble-dryers/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Air vented tumble dryers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 110mm x 220mm when printed.

Path

/api/v1/tumble-dryers/air-vented-tumble-dryers/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
efficiencyRating Energy efficiency class of the tumble dryer.

Must be one of:
A+++
A++
A+
A
B
C
D
String
energyConsumption Weighted annual energy consumption (AEC) in kWh per year, rounded up to the nearest integer. This may be up to 3 digits long. Integer
cycleTime Cycle time corresponding to the standard cotton programme at full load in minutes per cycle. This may be up to 3 digits long. Integer
ratedCapacity Rated capacity, for the standard cotton programme at full load in kg. This may be up to 2 digits long with an optional 1 decimal place. Number
soundPowerLevel Sound power level (weighted average value — LWA), during the drying phase, for the standard cotton programme at full load, expressed in dB . This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "energyConsumption": 1, "cycleTime": 1, "ratedCapacity": 1.1, "soundPowerLevel": 1 }

Condenser tumble dryers: arrow image

Path

/api/v1/tumble-dryers/condenser-tumble-dryers/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Condenser tumble dryers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 110mm x 220mm when printed.

Path

/api/v1/tumble-dryers/condenser-tumble-dryers/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
efficiencyRating Energy efficiency class of the tumble dryer.

Must be one of:
A+++
A++
A+
A
B
C
D
String
energyConsumption Weighted annual energy consumption (AEC) in kWh per year, rounded up to the nearest integer. This may be up to 3 digits long. Integer
cycleTime Cycle time corresponding to the standard cotton programme at full load in minutes per cycle. This may be up to 3 digits long. Integer
ratedCapacity Rated capacity, for the standard cotton programme at full load in kg. This may be up to 2 digits long with an optional 1 decimal place. Number
soundPowerLevel Sound power level (weighted average value — LWA), during the drying phase, for the standard cotton programme at full load, expressed in dB . This may be up to 2 digits long. Integer
condensationEfficiencyRating Condensation efficiency class indicator.

Must be one of:
A
B
C
D
E
F
G
String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "energyConsumption": 1, "cycleTime": 1, "ratedCapacity": 1.1, "soundPowerLevel": 1, "condensationEfficiencyRating": "A" }

Gas fired tumble dryers: arrow image

Path

/api/v1/tumble-dryers/gas-fired-tumble-dryers/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The energy efficiency class indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Gas fired tumble dryers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 110mm x 220mm when printed.

Path

/api/v1/tumble-dryers/gas-fired-tumble-dryers/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
efficiencyRating Energy efficiency class of the tumble dryer.

Must be one of:
A+++
A++
A+
A
B
C
D
String
energyConsumption Weighted annual energy consumption (AEC) in kWh per year, rounded up to the nearest integer. This may be up to 3 digits long. Integer
cycleTime Cycle time corresponding to the standard cotton programme at full load in minutes per cycle. This may be up to 3 digits long. Integer
ratedCapacity Rated capacity, for the standard cotton programme at full load in kg. This may be up to 2 digits long with an optional 1 decimal place. Number
soundPowerLevel Sound power level (weighted average value — LWA), during the drying phase, for the standard cotton programme at full load, expressed in dB . This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "energyConsumption": 1, "cycleTime": 1, "ratedCapacity": 1.1, "soundPowerLevel": 1 }

Rescaled tumble dryers: arrow image

Path

/api/v1/tumble-dryers/rescaled/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
efficiencyRating The energy efficiency class indicator.

Must be one of:
A
B
C
D
E
F
G
String
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelColour The colour of the arrow image. Use a colour arrow if you can. You can use a black and white arrow if your material is being printed in black and white. You shouldn't use black and white arrows on the internet.

Must be one of:
COLOUR
BLACK_AND_WHITE
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String

Example request body

{ "efficiencyRating": "A", "productPriceHeightPx": 100, "labelColour": "COLOUR", "labelFormat": "JPEG" }

Rescaled tumble dryers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 96mm x 192mm when printed.

Path

/api/v1/tumble-dryers/rescaled/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
qrCodeUrl Enter a link to the product information sheet. Links must start with http:// or https:// and contain at least one dot (.) character. String
efficiencyRating Energy efficiency class indicator.

Must be one of:
A
B
C
D
E
F
G
String
energyConsumptionPer100Cycles Weighted average energy consumption per 100 drying cycles in kWh, rounded to the nearest integer. This may be up to 3 digits long. Integer
noiseEmissionsClass Airborne acoustic noise emission class.

Must be one of:
A
B
C
D
String
noiseEmissions Airborne acoustical noise emission of the drying cycle of the eco programme in dB(A) re 1 pW, rounded to the nearest integer. This may be up to 2 digits long. Integer
ecoCapacity The rated capacity, up to 2 digits, with an optional decimal place of either .0 or .5. Number
programmeDurationHours The number of hours for the eco programme duration, up to 1 digit. If the eco programme duration is under 1 hour, enter 0. This may be up to 1 digit long. Integer
programmeDurationMinutes The number of minutes for the eco programme duration, between 0 and 59. Integer
isCondensing Is this a condensing tumble dryer? Boolean
condensationEfficiencyClass Condensation efficiency class. Only required if isCondensing is true.

Must be one of:
A
B
C
D
String
condensationEfficiencyPercentage Condensation efficiency, as a percentage, rounded to the nearest integer. Only required if isCondensing is true. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "qrCodeUrl": "https://example.com", "efficiencyRating": "A", "energyConsumptionPer100Cycles": 1, "noiseEmissionsClass": "A", "noiseEmissions": 1, "ecoCapacity": 1.1, "programmeDurationHours": 1, "programmeDurationMinutes": 1, "isCondensing": true, "condensationEfficiencyClass": "A", "condensationEfficiencyPercentage": 1 }