DATA REQUESTS (UP TO 1 GB)

    A direct, or synchronous, data request will return the files that belong to the requested dataset(s) that cover the requested timespan. These requests are known as synchronous because the files will be downloaded as soon as the compressed tar package is ready. Authentication is not necessary for this type of download.

    If the package requested is over 1 GB (compressed), you could either do an Asynchronous request (up to 50 GB) or reduce your request.

    Certain applications require a Streamed download to retrieve a single CEF file immediately.

    For CEF files, new CEF files are created by extracting the data from the original files for the timespan given and concatenating them as directed in the request. The file format (CEF, CDF or ISTP) can be specified, as can the time interval that the delivered files will cover (e.g., hourly, daily, etc). For non-CEF source files, the files delivered are direct copies of the files stored at the archive.

    The package delivered will be a gzipped tarball (note: extension is .tgz) by default.

    There are two types of data requests:

    which depend on the value of the RETRIEVAL_TYPE parameter: RETRIEVAL_TYPE=PRODUCT for data requests and RETRIEVAL_TYPE=HEADER for header requests (parameter and values are case insensitive).

     

    PRODUCT REQUESTS

    A synchronous data retrieval has a limit of 1GB (compressed).

    The Base

    The details of the request need to be built on the following base:

    https://csa.esac.esa.int/csa-sl-tap/data?

    Then add the RETRIEVAL_TYPE, DATASET_ID, START_DATE and END_DATE details, which are mandatory:

    PARAMETER NAME(S)

    DESCRIPTION

    MANDATORY?

    POSSIBLE VALUES

    RETRIEVAL_TYPE

    Type of retrieval. PRODUCT (Cluster data file) or HEADER

    YES

    PRODUCT or HEADER

    DATASET_ID

    Unique identifier of the dataset whose data we want to retrieve.
    It can appear more than once, and can contain wild cards ('*')

    YES

    Any of the Cluster datasets.

    START_DATE

    Start time of the time range that the retrieved files should cover.

    YES

    ISO time format: 'yyyy-MM-ddTHH:mm:ssZ'

    END_DATE

    End time of the time range that the retrieved files should cover.

    YES

    ISO time format: 'yyyy-MM-ddTHH:mm:ssZ'

    If the dates aren't included, the request will be accepted but the dates will default to the start and end of the Cluster mission.

    The optional parameters are listed here:

    PARAMETER NAME(S)

    DESCRIPTION

    MANDATORY?

    POSSIBLE VALUES

    DELIVERY_FORMAT

    Delivery format, applicable only to CEF files. By default, CEF

    NO

    CEF, CDF, CDF_2_7 or CDF_ISTP

    DELIVERY_INTERVAL

    Specifies the delivery file interval in time. By default, "Daily"

    NO

    All, Daily, TenMin, Hourly, hourly3, hourly6, hourly12

    FLAT

    By default, FLAT=FALSE and files will be returned in a directory structure for each dataset ID. With FLAT=TRUE, all files will be returned in a single directory.

    NO

    FALSE or TRUE; 0 or 1

    FORCEPACK

    By default TRUE: package will be tarballed, then gzipped.

    If FALSE, package is not tarballed, and a zip will download.

    NO

    TRUE or FALSE; 1 or 0

    GZIP

    By default, GZIP=FALSE and the files inside the package are not gzipped themselves; make GZIP=TRUE to have all the files within the package gzipped - good for large CEF files, and many programs can read gzipped ASCII files without gunzipping.

    NO

    FALSE or TRUE

    INCLUDE_EMPTY

    By default, INCLUDE_EMPTY=1 and if the files corresponding to the dataset requested are empty (they do not contain any records) they will be included in the delivery. Set this to 0 if the empty dataset files are not wanted.

    NO

    FALSE or TRUE; 0 or 1

    INGESTED_SINCE

    Only download files that have been ingested since a particular date.

    NO

    ISO time format: 'yyyy-MM-ddTHH:mm:ssZ'

    MAX_FILE_SIZE

    The size of the maximum amount of uncompressed data that can be downloaded in kB. If the query results in a delivery that exceeds the specified file size the user will receive an error message.

    NO

    A positive integer representing the maximum file size in kB

    REF_DOC

    By default, REF_DOC=1 and the files in the request are delivered WITH their reference document if available. Referenced documents are typically CAVEAT or SETTINGS data. Set this to 0 if the referenced files are not wanted.

    NO

    1 or 0

     

    Product (Data) Use Cases

    Data UC1 - DATASET_ID, START_DATE and END_DATE

    Request ASPOC products observed at Cluster-3 with dataset identifier 'C3_CP_ASP_ION*' for time range '2004-06-18 11:35:00 / 2004-06-19 18:35:00':

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=product&DATASET_ID=C3_CP_ASP_ION*&START_DATE=2004-06-18T11:35:00Z&END_DATE=2004-06-19T18:35:00Z

     

    Data UC2 - DOUBLE STAR

    Request DOUBLE STAR FGM products observed at D1 with dataset identifier 'D1_CP_FGM_SPIN' for time range '2004-01-08 04:00:00 / 2004-01-08 06:00:00':

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=product&DATASET_ID=D1_CP_FGM_SPIN&START_DATE=2004-01-08T04:00:00Z&END_DATE=2004-01-08T06:00:00Z

     

    Data UC3 - CDF

    Request DWP products observed at Cluster-1 with dataset identifier 'C1_CP_DWP_CORR_ST' for time range '2001-06-10 22:12:14 / 2001-06-11 06:12:14' in CDF format and file interval '3 hours':

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=product&DATASET_ID=C1_CP_DWP_CORR_ST&START_DATE=2001-06-10T22:12:14Z&END_DATE=2001-06-11T06:12:14Z&DELIVERY_FORMAT=CDF&DELIVERY_INTERVAL=hourly3

     

    Data UC4 - RESTRICT DOWNLOAD SIZE

    This use case retrieves a particular product, with the additional criteria that the assembled (compressed) package cannot exceed a total size limit. If the request does exceed the size given, an error will result.

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=product&DATASET_ID=C1_CP_EDI_EGD&START_DATE=2001-02-01T00:00:00Z&END_DATE=2001-02-15T00:00:00Z&DELIVERY_INTERVAL=Daily&MAX_FILE_SIZE=9216

     

    Data UC5 - NON CEF FILES

    Request non-CEF products from WBD observed at Cluster-4 with dataset identifier 'C4_CG_WBD_GIFPLOT' for time range '2008-01-30 05:55:00 / 2008-01-30 05:57:00':

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=product&DATASET_ID=C4_CG_WBD_GIFPLOT&START_DATE=2008-01-30T05:55:00Z&END_DATE=2008-01-30T05:57:00Z

     

    Data UC6 - DATA INGESTED SINCE DATE

    Request EDI products observed at Cluster-1 with dataset identifier 'C1_CP_EDI_EGD' for time range '2001-02-01 00:00:00 / 2001-02-05 00:00:00' that have been ingested since '2010-03-10T10:21:00Z'. Note that there may be no results if data for this interval was ingested before the date given.

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=product&DATASET_ID=C1_CP_EDI_EGD&START_DATE=2001-02-01T00:00:00Z&END_DATE=2001-02-05T00:00:00Z&DELIVERY_INTERVAL=Daily&INGESTED_SINCE=2010-03-10T10:21:00Z

     

    Data UC7 - TWO DATASETS FOR SAME TIME INTERVAL

    Request ASPOC and EFW products for the same time range:

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=product&DATASET_ID=C3_CP_ASP_IONC&DATASET_ID=C1_CP_EFW_L1_P2&START_DATE=2004-06-18T11:35:00Z&END_DATE=2004-06-19T18:35:00Z

     

    Data UC8 - DON'T DELIVER EMPTY FILES

    Request FGM products observed at Cluster-1 with dataset identifier 'C1_CP_FGM_SPIN' for time range '2001-02-05T00:00:00 / 2001-02-07T00:00:00'
    Empty data record files will not be included in the delivery.

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=product&DATASET_ID=C1_CP_FGM_SPIN&START_DATE=2001-02-05T00:00:00Z&END_DATE=2001-02-07T00:00:00Z&DELIVERY_INTERVAL=hourly&INCLUDE_EMPTY=0

     

    HEADER REQUESTS

    PARAMETER NAME(S)

    DESCRIPTION

    MANDATORY?

    POSSIBLE VALUES

    RETRIEVAL_TYPE

    Type of retrieval. For this request, "HEADER"

    YES

    PRODUCT or HEADER

    DATASET_ID

    Unique identifier of the dataset whose metadata header we want to retrieve.
    It can appear more than once, and can contain wild cards ('*')

    YES

    Any of the Cluster datasets.

     

    Note that currently, these requests are taking a while to process - please be patient while we work to improve the performance.

     

    Header Use Cases

    Data UC9 - HEADERS

    Request dataset metadata header files for all CIS Dataset for RPA mode:

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=header&DATASET_ID=C*_CIS-CODIF_RPA_*

     

    Data UC10 - HEADERS FOR 2 INSTRUMENTS

    Request dataset metadata header files for EDI and RAPID:

    https://csa.esac.esa.int/csa-sl-tap/data?RETRIEVAL_TYPE=header&DATASET_ID=*_EDI_*&DATASET_ID=*_RAP_*