/energystar/products

POST /api/energystar/products

Price: 1 credit

Look up one ENERGY STAR certified model by its product id. Resolves the model through the programme-wide index and then returns the full certification record from the dataset for its product category, so the answer carries the measured performance figures the category is certified on — annual energy and water use, efficiency ratios against the federal standard, capacity and dimensions — alongside the brand, model name and number, UPC, certifying partner, the markets the model is certified for, the dates it was qualified and reached the market, and whether it meets the Most Efficient criteria.

How to use it

`pd_id` is the ENERGY STAR product id, not a UPC and not a model number — take it from energystar/products/search, or resolve a barcode through energystar/upcs/search first. The measured figures live in `attributes` under the certification programme's own column names, and those names differ entirely by product category: a clothes washer reports `integrated_modified_energy_factor_imef`, a heat pump reports seasonal efficiency ratios, so compare models only within a category and read energystar/product_types for the names a category uses. Every value arrives as text, including the numbers. A handful of models are registered programme-wide but have no record in their category; those come back with the shared fields only and an empty `attributes`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• pd_id string required — ENERGY STAR product id, the identifier that keys every certified model across the whole programme (examples: "2545602", "2300603", "1723365"; minLength: 1)

Response

• @type string (default: "EnergystarProduct")
• id string required
• product_category string nullable
• product_type string nullable
• dataset_id string nullable
• dataset_name string nullable
• brand string nullable
• model_name string nullable
• model_number string nullable
• energy_star_model_identifier string nullable
• energy_star_partner string nullable
• additional_model_information string nullable
• upc string nullable
• markets array (default: [])
• is_most_efficient boolean nullable
• available_on_market_date string nullable
• qualified_date string nullable
• certified_date string nullable
• attributes object (default: {})

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No certified model carries that product id. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.