API endpoints

Range hoods

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

Range hoods: arrow image

Path

/api/v1/range-hoods/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 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+++" }

Range hoods: energy label

You must display the label so that it’s easy to see and clearly related to the product. It must be at least 60mm x 120mm when printed.

Path

/api/v1/range-hoods/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 indicator.

Must be one of:
A+++
A++
A+
A
B
C
D
 String
annualEnergyConsumption Annual energy consumption - AEC hood (kWh/annum). This may be up to 3 digits long. Integer
fluidClass The Fluid Dynamic Efficiency class.

Must be one of:
A
B
C
D
E
F
G
 String
lightingSystem Does this model have a lighting system? Boolean
lightingClass The Lighting Efficiency class. Only required if lightingSystem is true.

Must be one of:
A
B
C
D
E
F
G
 String
greaseClass The Grease Filtering Efficiency class.

Must be one of:
A
B
C
D
E
F
G
 String
noiseValue The Noise Value (dB). This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "annualEnergyConsumption": 1, "fluidClass": "A", "lightingSystem": true, "lightingClass": "A", "greaseClass": "A", "noiseValue": 1 }