Skip to main content
POST
/energystar/products/search

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:
boilers,
ceiling_fans,
commercial_boilers,
commercial_clothes_washers,
commercial_coffee_brewers,
commercial_dishwashers,
commercial_electric_cooktops,
commercial_fryers,
commercial_griddles,
commercial_hot_food_holding_cabinet,
commercial_ice_machines,
commercial_ovens,
commercial_refrigerators_and_freezers,
commercial_steam_cookers,
commercial_water_heaters,
computers_v9_0,
data_center_storage_block_i_o,
data_center_storage_file_i_o,
dehumidifiers,
displays,
electric_vehicle_supply_equipment_ac_output,
electric_vehicle_supply_equipment_dc_output,
enterprise_servers,
furnaces,
geothermal_heat_pumps,
heat_pumps,
imaging_equipment,
laboratory_grade_refrigerators_and_freezers,
large_network_equipment,
light_commercial_hvac,
light_fixtures_downlights,
medical_imaging_equipment,
pool_pumps,
residential_clothes_dryers,
residential_clothes_washers,
residential_dishwashers,
residential_electric_cooking_products,
residential_freezers,
residential_refrigerators,
room_air_cleaners_v3_0,
room_air_conditioners,
smart_thermostats,
storm_windows,
telephones,
televisions,
uninterruptible_power_supplies,
vending_machines,
ventilating_fans,
water_coolers,
water_heaters
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_name
string | null
Minimum string length: 1
model_number
string | null
Minimum string length: 1
product_type
string | null
Minimum string length: 1
energy_star_partner
string | null
Minimum string length: 1
upc
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
most_efficient
boolean | null
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