Parameters mapping#

EODAG maps each provider’s specific metadata parameters to a common model using OGC OpenSearch Extension for Earth Observation. Extra parameters having no equivalent in this model are mapped as is.

Depending on the provider, some parameters are queryable or not. This is configured in providers.yml:

If a parameter metadata-mapping is a list, the first element will help constructing the query (using format()), and the 2nd will help extracting its values from the query result (using jsonpath)
If a parameter metadata-mapping is a string, it will not be queryable and this string will help extracting its values from the query result (using jsonpath).

some_provider:
   search:
      metadata_mapping:
         queryableParameter:
            - 'this_is_query_string={queryableParameter}'
            - '$.jsonpath.in.result.to.parameter'
         nonQueryableParameter: '$.jsonpath.in.result.to.another_parameter'

Formatters#

An EOProduct has a properties attribute which is built based on how its metadata are set in the provider configuration. For example:

search:
   ...
   metadata_mapping:
      publicationDate: '{$.data.timestamp#to_iso_utc_datetime_from_milliseconds}'
      ...

The following converters can be used to transform the values collected from the provider:

eodag.api.product.metadata_mapping.format_metadata(search_param, *args, **kwargs)[source]#

Format a string of form {<field_name>#<conversion_function>}

The currently understood converters are:

datetime_to_timestamp_milliseconds: converts a utc date string to a timestamp in milliseconds
to_rounded_wkt: simplify the WKT of a geometry
to_bounds_lists: convert to list(s) of bounds
to_nwse_bounds: convert to North,West,South,East bounds
to_nwse_bounds_str: convert to North,West,South,East bounds string with given separator
to_geojson: convert to a GeoJSON (via __geo_interface__ if exists)
from_ewkt: convert EWKT to shapely geometry / WKT in DEFAULT_PROJ
to_ewkt: convert to EWKT (Extended Well-Known text)
from_georss: convert GeoRSS to shapely geometry / WKT in DEFAULT_PROJ
csv_list: convert to a comma separated list
to_iso_utc_datetime_from_milliseconds: convert a utc timestamp in given milliseconds to a utc iso datetime
to_iso_utc_datetime: convert a UTC datetime string to ISO UTC datetime string
to_iso_date: remove the time part of a iso datetime string
remove_extension: on a string that contains dots, only take the first part of the list obtained by splitting the string on dots
get_group_name: get the matching regex group name
replace_str: execute “string”.replace(old, new)
recursive_sub_str: recursively substitue in the structure (e.g. dict) values matching a regex
slice_str: slice a string (equivalent to s[start, end, step])
fake_l2a_title_from_l1c: used to generate SAFE format metadata for data from AWS
s2msil2a_title_to_aws_productinfo: used to generate SAFE format metadata for data from AWS
split_cop_dem_id: get the bbox by splitting the product id
split_corine_id: get the product type by splitting the product id
to_datetime_dict: convert a datetime string to a dictionary where values are either a string or a list
get_ecmwf_time: get the time of a datetime string in the ECMWF format

Parameters:

search_param (str) – The string to be formatted
args (Any) – (optional) Additional arguments to use in the formatting process
kwargs (Any) – (optional) Additional named-arguments to use when formatting

Return type:

str

Returns:

The formatted string

Queryables#

The list_queryables() method will help you to dynamically check which parameters are queryable for a given provider or product type. See Python API User Guide / Queryables for more information and examples.

The following static tables list the parameters supported by providers, and if they are queryable or not.

OpenSearch parameters (CSV)#

parameter	cop_ads	cop_cds	cop_dataspace	cop_ewds	creodias	dedt_lumi	earth_search	earth_search_cog	earth_search_gcs	eumetsat_ds	geodes	onda	peps	planetary_computer	sara	theia	usgs_satapi_aws
abstract							metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only		metadata only
accessConstraint													metadata only		metadata only	metadata only
acquisitionStation							queryable metadata	queryable metadata	queryable metadata		queryable metadata			queryable metadata		metadata only	queryable metadata
acquisitionSubType							queryable metadata	queryable metadata	queryable metadata		queryable metadata			queryable metadata		metadata only	queryable metadata
acquisitionType													metadata only		metadata only
antennaLookDirection																metadata only
archivingCenter																metadata only
availabilityTime							queryable metadata	queryable metadata	queryable metadata		queryable metadata			queryable metadata		metadata only	queryable metadata
cloudCover			queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
completionTimeFromAscendingNode	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
creationDate							queryable metadata	queryable metadata	queryable metadata		queryable metadata	metadata only	metadata only	queryable metadata	metadata only	metadata only	queryable metadata
doi							queryable metadata	queryable metadata	queryable metadata		queryable metadata			queryable metadata			queryable metadata
dopplerFrequency							queryable metadata	queryable metadata	queryable metadata		queryable metadata			queryable metadata		metadata only	queryable metadata
illuminationAzimuthAngle							queryable metadata	queryable metadata	queryable metadata		queryable metadata			queryable metadata		metadata only	queryable metadata
illuminationElevationAngle							queryable metadata	queryable metadata	queryable metadata		queryable metadata			queryable metadata		metadata only	queryable metadata
illuminationZenithAngle																metadata only
incidenceAngleVariation																metadata only
instrument			queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
keyword											metadata only		metadata only		metadata only	metadata only
lineage												queryable metadata
maximumIncidenceAngle																metadata only
minimumIncidenceAngle																metadata only
modificationDate			queryable metadata		metadata only		queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata		metadata only	queryable metadata	metadata only	metadata only	queryable metadata
orbitDirection			queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata
orbitNumber			queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata
organisationName			queryable metadata		queryable metadata								queryable metadata		queryable metadata	metadata only
parentIdentifier										queryable metadata			queryable metadata		queryable metadata	metadata only
platform			queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata	metadata only	queryable metadata	queryable metadata
platformSerialIdentifier			queryable metadata		queryable metadata		queryable metadata	metadata only	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
processingCenter													metadata only		metadata only
processingDate												metadata only				metadata only
processingLevel			queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
processingMode																metadata only
processorName													metadata only		metadata only
productQualityStatus												queryable metadata	metadata only		metadata only
productType	metadata only	metadata only	queryable metadata	metadata only	queryable metadata	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
productVersion							queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	metadata only	queryable metadata	metadata only	metadata only	queryable metadata
publicationDate			metadata only		metadata only		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata		metadata only	queryable metadata	metadata only	metadata only	queryable metadata
resolution			queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata
sensorMode			queryable metadata		queryable metadata		queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata
sensorType												queryable metadata
snowCover													queryable metadata		queryable metadata	metadata only
startTimeFromAscendingNode	metadata only	metadata only	queryable metadata	metadata only	queryable metadata	metadata only	metadata only	metadata only	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata	queryable metadata	metadata only
swathIdentifier											queryable metadata		queryable metadata		queryable metadata
title	metadata only	metadata only	metadata only	metadata only	metadata only		metadata only	metadata only	metadata only	queryable metadata	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
topicCategory												queryable metadata	metadata only		metadata only

Provider/eodag specific parameters (CSV)#

parameter	cop_ads	cop_cds	cop_dataspace	cop_ewds	cop_marine	creodias	dedt_lumi	earth_search	earth_search_cog	earth_search_gcs	eumetsat_ds	geodes	onda	peps	planetary_computer	sara	theia	usgs_satapi_aws
_date	metadata only	metadata only		metadata only
acquisitionInformation											metadata only
activity							queryable metadata
aerosol_type	queryable metadata
altitude	queryable metadata
anoffset							queryable metadata
api_product_type	queryable metadata	queryable metadata		queryable metadata
assets								metadata only	metadata only	metadata only	metadata only	metadata only			metadata only			metadata only
awsProductId																		metadata only
band	queryable metadata
cdr_type		queryable metadata
class							queryable metadata
collection			queryable metadata			queryable metadata
dataset	queryable metadata	queryable metadata		queryable metadata			queryable metadata
dataset_type		queryable metadata		queryable metadata
day	queryable metadata	queryable metadata		queryable metadata
defaultGeometry	metadata only	metadata only		metadata only	metadata only						metadata only
domain							queryable metadata
downloadLink	metadata only	metadata only	metadata only	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
download_format		queryable metadata		queryable metadata
ensemble_member		queryable metadata
experiment		queryable metadata					queryable metadata
expver							queryable metadata
extraInformation											metadata only
filter		queryable metadata
forcing_type	queryable metadata
format	queryable metadata	queryable metadata		queryable metadata
gcm		queryable metadata
generation							queryable metadata
geometry	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
grid		queryable metadata		queryable metadata
gridSquare								queryable metadata
hdate		queryable metadata
hday				queryable metadata
hmonth				queryable metadata
horizontal_resolution		queryable metadata
hydrological_model		queryable metadata		queryable metadata
hyear				queryable metadata
id	metadata only	metadata only	queryable metadata	metadata only		queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata
input_observations	queryable metadata
latitude	queryable metadata	queryable metadata
latitudeBand								queryable metadata
leadtime_hour	queryable metadata	queryable metadata		queryable metadata
leadtime_month		queryable metadata
level	queryable metadata
levelist							queryable metadata
levtype	queryable metadata						queryable metadata
links														metadata only
location	queryable metadata
longitude	queryable metadata	queryable metadata
model	queryable metadata						queryable metadata
model_level	queryable metadata
model_levels		queryable metadata		queryable metadata
modifiedAfter			queryable metadata
modifiedBefore			queryable metadata
month	queryable metadata	queryable metadata		queryable metadata
nominal_day		queryable metadata
orderLink	metadata only	metadata only		metadata only			metadata only						metadata only
origin		queryable metadata
originating_centre		queryable metadata		queryable metadata
param	queryable metadata	queryable metadata					queryable metadata
period		queryable metadata
polarizationChannels			queryable metadata			queryable metadata		queryable metadata	queryable metadata	queryable metadata		queryable metadata	metadata only		queryable metadata		metadata only	queryable metadata
polarizationMode									metadata only					queryable metadata		queryable metadata	metadata only
pressure_level	queryable metadata	queryable metadata
processing_level		queryable metadata
processing_type		queryable metadata
product	queryable metadata	queryable metadata
productIdentifier			metadata only			metadata only
productInformation											metadata only
product_version		queryable metadata
providerProductType												queryable metadata
publishedAfter			queryable metadata
publishedBefore			queryable metadata
qs	metadata only	metadata only		metadata only			metadata only
quantity	queryable metadata
quicklook			metadata only			metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
rcm		queryable metadata
realization							queryable metadata
region		queryable metadata
relativeOrbitNumber			queryable metadata
satellite		queryable metadata
sensor		queryable metadata
sensor_and_algorithm		queryable metadata
services														metadata only
size											queryable metadata
sky_type	queryable metadata
soil_level				queryable metadata
source	queryable metadata	queryable metadata
statistic		queryable metadata
step	queryable metadata	queryable metadata					queryable metadata
storageStatus	metadata only	metadata only	metadata only	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
stream							queryable metadata
system		queryable metadata
system_version		queryable metadata		queryable metadata
target	queryable metadata	queryable metadata
temporal_aggregation		queryable metadata
thumbnail			metadata only			metadata only		metadata only	metadata only	metadata only		metadata only		metadata only	metadata only	metadata only	metadata only	metadata only
tileIdentifier			queryable metadata			queryable metadata		queryable metadata					queryable metadata	queryable metadata	queryable metadata		queryable metadata
time	queryable metadata	queryable metadata		queryable metadata			queryable metadata
time_aggregation	queryable metadata	queryable metadata
time_reference	queryable metadata
time_step	queryable metadata
type	queryable metadata	queryable metadata					queryable metadata				metadata only
uid			metadata only			metadata only					metadata only	metadata only	metadata only	metadata only		metadata only	metadata only
utmZone								queryable metadata
variable	queryable metadata	queryable metadata		queryable metadata
variable_type		queryable metadata
version	queryable metadata	queryable metadata
year	queryable metadata	queryable metadata		queryable metadata

Parameters mapping

Contents

Parameters mapping#