API endpoints

Televisions

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

Televisions and electronic displays: arrow image

Path

/api/v1/televisions/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
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
efficiencyRating Energy efficiency class for SDR content.

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

Example request body

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

Televisions and electronic displays: energy label

You must display the label so that it’s easy to see and clearly related to the product. Labels must usually be at least 96mm x 192mm when printed. If the diagonal size of the visible screen area is less than 127cm (50 inches) you can scale down the the label, but it must still be at least 57.6mm x 115.2mm. If you scale down the label you must test that the QR code can still be read when printed, for example by using a smartphone camera.

Path

/api/v1/televisions/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
screenSizeCm Visible diagonal screen size in centimetres. This may be up to 4 digits long. Integer
screenSizeInch Visible diagonal screen size in inches. This may be up to 3 digits long. Integer
efficiencyRatingSdr Energy efficiency class for SDR content.

Must be one of:
A
B
C
D
E
F
G
 String
energyConsumptionSdr1000h On-mode energy consumption in kWh per 1000 hours, when playing SDR content. This may be up to 4 digits long. Integer
isHdr Can this product display HDR content? Boolean
efficiencyRatingHdr Energy efficiency class for HDR content.

Must be one of:
A
B
C
D
E
F
G
 String
energyConsumptionHdr1000h On-mode energy consumption in kWh per 1000 hours, when playing HDR content. This may be up to 4 digits long. Integer
horizontalPixels Horizontal resolution in pixels. This may be up to 5 digits long. Integer
verticalPixels Vertical resolution in pixels. This may be up to 5 digits long. Integer
qrCodeUrl Enter a link to the product information sheet. Links must start with http:// or https:// and contain at least one dot (.) character. String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "screenSizeCm": 1, "screenSizeInch": 1, "efficiencyRatingSdr": "A", "energyConsumptionSdr1000h": 1, "isHdr": true, "efficiencyRatingHdr": "A", "energyConsumptionHdr1000h": 1, "horizontalPixels": 1, "verticalPixels": 1, "qrCodeUrl": "https://example.com" }