How to use Copernicus Dataspace provider

[aleksandaratanasov]

Hi all.

I have a valid Copernicus Dataspace account that I have used numerous times (incl. when working with SNAP and the Sentinel toolbox). I used to use the sentinelsat Python library but that one is now obsolete after the change in the API for accessing Copernicus data. I wrote some code using the ODATA examples and it works. However, for convenience and also due to the fact I would like to e.g. download some USGS Landsat data as well, I found EODAG.

I installed eodag[all] and eodag[all-providers] via pip.

I have tried loading my credentials (username and password) through the following YAML file:

cop_dataspace:
    priority: 100
    download:
        extract: false
        output_dir: tmp/sentinel/
    auth:
        credentials:
            username: "XXXXXXXXXXXXXX"
            password: "YYYYYYYYYYYYYYY"

as well as using the environment variables directly in my script, e.g.

os.environ['EODAG__COP_DATASPACE__AUTH__CREDENTIALS__USERNAME'] = 'XXXXXXXXXXXXXX'
os.environ['EODAG__COP_DATASPACE__AUTH__CREDENTIALS__PASSWORD'] = 'YYYYYYYYYYYYYYY'

but both fail when the download step of a product is executed. This step obviously requires authentication unlike simply querying the available products. I keep getting the following traceback:

Traceback (most recent call last):
  File "/storage/shared/envs/envs/changedetection/lib/python3.10/site-packages/eodag/plugins/authentication/base.py", line 53, in validate_config_credentials
    credentials = self.config.credentials
AttributeError: 'PluginConfig' object has no attribute 'credentials'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/storage/shared/changedetection/gis/acquire_data_eodag.py", line 72, in <module>
    best_product.download(outputs_prefix=workspace)
  File "/storage/shared/envs/envs/changedetection/lib/python3.10/site-packages/eodag/api/product/_product.py", line 346, in download
    self.downloader_auth.authenticate()
  File "/storage/shared/envs/envs/changedetection/lib/python3.10/site-packages/eodag/plugins/authentication/generic.py", line 47, in authenticate
    self.validate_config_credentials()
  File "/storage/shared/envs/envs/changedetection/lib/python3.10/site-packages/eodag/plugins/authentication/base.py", line 55, in validate_config_credentials
    raise MisconfiguredError(
eodag.utils.exceptions.MisconfiguredError: Missing credentials configuration for provider peps

The Missing credentials configuration for provider peps exception is (without checking the code) probably the catch block if the selected provider (in my case cop_dataspace) fails during loading for some reason and to fall back to the default (as per documentation), namely PEPS.

Further note that I am able to find a product for downloading so it's not like the search results is empty.

The code I am using is as follows (this version loads from a YAML config file):

from pathlib import Path
import json
import os
from eodag import EODataAccessGateway, setup_logging

workspace = Path('tmp/sentinel/').mkdir(parents=True, exist_ok=True)

setup_logging(verbose=1)
dag_config = Path.cwd().absolute().joinpath('eodag_conifg.yml')
print(dag_config)
dag = EODataAccessGateway(user_conf_file_path=dag_config)
print(dag.available_providers())

dag.set_preferred_provider('cop_dataspace')
search_geom = (1, 43, 2, 44)
search_results = dag.search(
    product_type='S2_MSI_L2A',
    cloudCoverage=5,
    start='2025-10-15',
    end='2026-01-30',
    geom=search_geom
)

if search_results:
    search_results.sort(key=lambda p: p.properties['cloudCover'])
    best_product = search_results[0]
    print(f'''
    Best product:
        Title: {best_product.properties["title"]}
        Cloud cover: {best_product.properties["cloudCover"]}
    ''')

    print('Downloading product')
    best_product.download(outputs_prefix=workspace)

[sbrunato]

Hi @aleksandaratanasov , looking at your code there might be several things to try updating:

• in you yml user conf file:

auth:
   credentials:
       username: "XXXXXXXXXXXXXX"
       password: "YYYYYYYYYYYYYYY"

Remove quotes around username and password values. See configuration / yaml-user-configuration-file.

• configuration file path

dag_config = Path.cwd().absolute().joinpath('eodag_conifg.yml')

Check if file exists as there might be a typo in filename (eodag_conifg vs eodag_config ?)

• product type parameter: should be productType instead of product_type

search_results = dag.search(
   product_type='S2_MSI_L2A',
   ...

• The command dag.set_preferred_provider('cop_dataspace') sets the provider as preferred one. But if search fails, eodag will search using the next provider until it finds results. See search / Fallback-in-case-of-error.
  Try increasing verbosity to INFO level to check what happens: setup_logging(2) (3 for DEBUG level).
  If you want products from cop_dataspace, you can also specify the provider as search parameter. This will disable search fallback:

search_results = dag.search(provider="cop_dataspace", productType="S2_MSI_L2A", **remaining_kwargs)

See search / id-and-provider

• also, outputs_prefix in download() was renamed to output_dir in v3.0.0, see download / Dynamically-configure-some-download-options

Note that productType will be renamed to collection in incoming v4.0.0 to align with STAC. v4.0.0b1 is already available, major changes are listed in doc @latest / migration guide.

Let us know if you manage to make it work.