Skip to main content
POST
/energystar/products/most_efficient

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
product_category
enum<string>
required
Available options:
air_source_heat_pumps,
ceiling_fans,
clothes_dryers,
clothes_washers,
dehumidifiers,
dishwashers,
displays,
ducted_heat_pumps,
geothermal_heat_pumps,
mini_split_heat_pumps,
residential_freezers,
residential_refrigerators,
room_air_cleaners,
room_air_conditioners,
ventilating_fans
count
integer
required
Required range: 1 <= x <= 150000
timeout
integer
default:300
Required range: 20 <= x <= 1500
brand
string | null
Minimum string length: 1
model_number
string | null
Minimum string length: 1
text
string | null
Minimum string length: 1
market
enum<string> | null
Available options:
United States,
Canada,
Taiwan,
Japan,
Switzerland,
Europe,
Australia,
New Zealand
filters
object | null
min_values
object | null
max_values
object | null
sort
string | null
Minimum string length: 1
order
enum<string>
default:ASC
Available options:
ASC,
DESC

Response

Successful Response

id
string
required
@type
string
default:EnergystarProduct
product_category
string | null
product_type
string | null
dataset_id
string | null
dataset_name
string | null
brand
string | null
model_name
string | null
model_number
string | null
energy_star_model_identifier
string | null
energy_star_partner
string | null
additional_model_information
string | null
upc
string | null
markets
string[]
is_most_efficient
boolean | null
available_on_market_date
string | null
qualified_date
string | null
certified_date
string | null
attributes
object