Overview

This schema represents the foundational structure for data entries served over the API. At this stage, all attributes are defined within a single model for simplicity. However, we recognize that more structured representations—such as dedicated models for activities, locations, products, and measurements—would improve clarity, reusability, and validation. These improvements are planned for Version 1, which will introduce a more modular and extensible schema while maintaining backward compatibility where possible.

For now, this prototype serves as a working implementation that supports early integrations. Developers should expect refinements in future releases. Feedback is welcome as we iterate toward a more robust v1!

Forming queries

Searches are served by GET requests to the /footprint-<tier> endpoint. For best performance we recommend being as specific as you can, and use thecountry, activityID, scope, year values to construct a query. However, all fields are optional and are used to filter records in our impact factor database.

• These fields can accept lists of values (e.g. "country":["Namibia","Norway"]) and run the query with a logical OR filter on that field (in that example, returning results from both countries).
• The number of requests that can be processed in a single batch is capped at 100, so requests with long lists in multiple fields may not return all the relevant results. It’s recommended to use batch queries instead.

Example query parameters

This example will retrieve the direct and indirect

 {**'activityID': 'wheat',
  'impactCategory': ['Water_stress_Agriculture_water_stress',
   'Land_use_Extensive_forestry'],
  'country': 'India'}**

Match criteria

All fields are case-insensitive. activityID ,company, and product allow partial matches (e.g. "activityID":"Rice" will match paddy_rice) whereas all other fields require exact matches. Use the aggregation endpoints to obtain lists of possible values for other field types.

String format conventions

Fields in our database, and in your query parameters, have names in camel-case, with capitalized acronyms (see below). In contrast, endpoint URLs

Returned values

The body of the HTTPS request returned by the API may contain several records, which contain the following fields:

Activity information

• activityID : Human-readable description of the activity (e.g., 'Fishing products', 'Kiwi fruit').
• activityClassificationSystem : The classification standard used for activities (e.g., ANZSIC).