Skip to main content
GET
Get a list of database footprints

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string

The search term

Example:

"plastic"

unitType
string

The unit type

Example:

"volume"

taxonomy
string

The taxonomy UUID

Example:

"aa17223a-471c-4eb7-9ff5-7800fd023960"

source
string

The UUID of the supplier, database, etc.

Example:

"aa17223a-471c-4eb7-9ff5-7800fd023960"

impacts
string

Which environmental impact indicators to include in the impacts field. Absent or empty returns only GWP-fossil. Pass all for every indicator, or a comma-separated list of canonical codes to filter (case-insensitive). all is only honored on its own — combining it with other codes (e.g. all,gwp-fossil) is treated as an unknown code. An unknown code returns 400. See the Impacts concept and the full indicator catalog.

Example:

"gwp-fossil,odp,ap"

geoLocation
string

ISO 3166-1 alpha-2 country code. Returns datasets located in that country; with geoScope, returns datasets in either.

geoScope
string

Region key (for example europe, north-america, scandinavia). Returns datasets in the region's countries or located at the region itself. world returns Rest of World (RoW) and global (GLO) datasets.

orderBy
enum<string>

Sort the results. co2e sorts by stored CO₂e per declared unit and ranks premium datasets whose impacts are withheld too; popularity sorts most-used first. Omit to sort by relevance.

Available options:
co2e,
name,
popularity
orderDir
enum<string>

Sort direction for co2e and name. Defaults to asc. Ignored by popularity.

Available options:
asc,
desc

Response

A list of database footprints

count
integer
Example:

1500

page
integer
Example:

1

pageSize
integer
Example:

100

data
object[]