EPD Queries

The EC3epds class can be used for simplifying queries of EPDs in the EC3 database.

The primary method currently setup for this class is the ‘get_epds’ method. When using this the user should pass a dictionary of parameters and values for querying.

There are a large number of fields listed in the EC3 documentation that can be used to query EPDs. Users should refer to that documentation for the field names and values expected.

A small number of commonly used fields have been built into the class. Refer to documentation below to see further details.

EC3epds

class ec3.ec3_epds.EC3epds(bearer_token, response_format='json', ssl_verify=True)

Wraps functionality of EC3 EPDs

Variables
  • return_fields (list) – List of the fields you would like returned (EC3 returns everything by default), defaults to []

  • sort_by (str) – Optional name of return field to sort results by, defaults to “”

  • only_valid (bool) – If True will return only EPDs that are currently valid (set to False to also return expired EPDs), defaults to True

  • masterformat_filter (list) – Optional list of Masterformat Category names to filter by (ex: [“03 21 00 Reinforcement Bars”]), defaults to []

  • display_name_filter (list) – Optional list of Display Name Categories to filter by (ex: [“Ready Mix”]), defaults to []

Usage:
>>> ec3_epds = EC3epds(bearer_token=token, ssl_verify=False)
>>> ec3_epd_list = ec3_epds.get_epds(params=epd_param_dict)
get_epd_by_xpduuid(epd_xpd_uuid)

Returns the epd from an Open xPD UUID

Parameters

epd_xpd_uuid (str) – Open xPD UUID (Example: EC300001)

Returns

Dictionary of the matching EPD record

Return type

dict

get_epds(return_all=False, **params)

Returns matching EPDs

Parameters

return_all (bool, optional) – Set to True to return all matches. Defaults to False, which will return the quantity specified in page_size.

Returns

List of dictionaries of matching EPD records

Return type

list