Generic Material Data

For the /get_generic_materials endpoint in the 2050 Materials API, the following filter options and output fields are included

Filter options

Filter options can be retrieved dynamically using the get_generic_material_filters endpoint. This endpoint can also take the same filtering as the get_generic_materials endpoint, to dynamically return the available filters within a response (e.g. for implementing dropdowns to further filter a response).

  1. product_types uses ID (use get_generic_material_filters to see IDs)

  2. material_type uses ID (use get_generic_material_filters to see IDs)

  3. building_applications uses ID (use get_generic_material_filters to see IDs)

  4. material_name uses a string which matches the exact or partial material name If you're including special characters (like +, &, or =) in filters, be sure to encode them properly, or results may not match as expected.

  5. data_source uses a string which matches the exact or partial data_source name (e.g. data_source=CLF-Material-Baselines (2023-04)) or the ID (use get_generic_material_filters for the IDs and full list)

  6. functional_unit_unit Filter by the declared unit using the exact string (eg. functional_unit_unit=m3 )

  7. data=mini returns a smaller dictionary which only include the following fields. This can be used to show information for dropdown menus without retrieving the full API response.

       {'id': 27444,
       'material_name': 'Aerated concrete P2 04 non-reinforced',
       'data_source': 'OKOBAUDAT (English) - 2024',
       'generic_api_url': ''},

Output Fields

Each object in the results array contains the following fields:

Field
Type
Description

id

integer

Unique identifier of the material.

source_uuid

string

Unique identifier of the data source (e.g., PR_01_23_4_50_1_1_1).

material_name

string

Name of the material.

group_elements_nrm_1

array of strings

List of group elements according to NRM 1 standards.

elements_nrm_1

array of strings

List of elements according to NRM 1 standards.

product_type

string

Product type.

product_type_family

array of strings

Product type family classifications.

uniclass_systems

array of strings

UniClass systems classification codes.

uniclass_products

array of strings

UniClass products classification codes.

uniclass_materials

array of strings

UniClass materials classification codes.

material_type

string

Material type.

material_type_family

string

Material type family.

data_source

string

Data source name.

data_source_url

string

URL to the data source (e.g., certificate or database link).

functional_unit_quantity

string

Functional unit quantity value.

functional_unit_unit

string

Unit of the functional unit (e.g., m3, piece, kg).

total_co2e_kg_mf

number

Total CO₂ equivalent (kg) at manufacturing stage.

total_biogenic_co2e

number

Total biogenic CO₂ equivalent (kg).

carbon_a1a3

number

Carbon emissions for stages A1–A3 (kg CO₂e).

carbon_a5

number

Carbon emissions for stage A5 (kg CO₂e).

carbon_b1b5

number

Carbon emissions for stages B1–B5 (kg CO₂e).

carbon_c1c4

number

Carbon emissions for stages C1–C4 (kg CO₂e).

freshwater_use_a1a3

number

Freshwater use in stages A1–A3.

recycled_content

number

Percentage of recycled content.

recyclable_content

number

Percentage of recyclable content.

reuse_potential

number

Percentage potential for reuse.

energy_recovery_possibility

number

Percentage possibility of energy recovery.

odp

string

Ozone depletion potential.

density

number

Density of the material.

density_estimated

boolean

Whether density is estimated.

grammage

number

Grammage of the material.

grammage_estimated

boolean

Whether grammage is estimated.

linear_density

number

Linear density [kg/m].

linear_density_estimated

boolean

Whether linear density is estimated.

mass_per_piece

number

Mass per piece [kg].

mass_per_piece_estimated

boolean

Whether mass per piece is estimated.

thickness

number

Thickness of the material (m).

thickness_estimated

boolean

Whether thickness is estimated.

cross_sectional_area

number

Cross-sectional area [m²].

cross_sectional_area_estimated

boolean

Whether cross-sectional area is estimated.

mass_per_declared_unit

number

Mass per declared unit [kg].

mass_per_declared_unit_estimated

boolean

Whether mass per declared unit is estimated.

grey_energy_total

number

Total grey energy [kWh oil-eq].

grey_energy_fabrication_total

number

Grey energy from fabrication [kWh oil-eq].

grey_energy_recovery_fabrication

number

Grey energy recovery from fabrication [kWh oil-eq].

grey_energy_material_recovery_fabrication

number

Grey energy from material recovery in fabrication [kWh oil-eq].

grey_energy_elimination

number

Grey energy from elimination [kWh oil-eq].

created

string (date-time)

Date and time when the material record was created.

updated

string (date-time)

Date and time when the material record was last updated.


Pagination Fields

In addition to results, the API response includes pagination metadata:

Field
Type
Description

TotalMaterials

integer

Total number of materials matching the query.

countMaterialsOnPage

integer

Number of materials in the current page of results.

current_page

integer

Current page number.

material_range

array of integers

Range of material indices on the current page (e.g., [1, 200]).

next

string or null

URL of the next page, or null if there is no next page.

previous

string or null

URL of the previous page, or null if there is no previous page.

Additional Information

  • The API uses JWT authentication and requires the user to be authenticated.

  • The endpoint supports pagination

  • Different user roles and permissions are handled, with specific access and rate limits.

  • Various response statuses are managed, including "200 OK" for successful requests, "401 Unauthorized" for access issues, and "429 Too Many Requests" for rate limit exceeding.

This endpoint provides a detailed overview of generic materials, including environmental impacts and technical specifications, which is vital for users focused on sustainability and environmental impact in the construction and building materials industry.

Last updated

Was this helpful?