Home

Welcome to the EODMS Command-line Interface wiki!

The EODMS exposes an HTTP/HTTPS application programming interface (API) for third-party application developers to make use of its services. This interface is based on REST (REpresentational State Transfer) principles, a fundamental paradigm of the World Wide Web.

The eodms_cli Python script provides a command-line interface to search, order and/or download images from the EODMS using the REST API (RAPI).

Script Documentation

• How It Works
• Config File
• Script Parameters

Processes

• Process 1 - Search, order & download images using an AOI and/or filters
• Process 2 - Order & download images using EODMS UI search results
• Process 3 - Order and download a single or set of images using Record IDs
• Process 4 - Download requests that had status ItemsRestoring using ItemsRestored.csv file
• Process 5 - Order & download a SAR Toolbox request (for authorized users only)

Deprecated After v4.0.0

• Deprecated Process 4 - Downloads order items with status AVAILABLE_FOR_DOWNLOAD
• Deprecated Process 5 - Download existing orders using a CSV file from a previous order/download process

SAR Toolbox Ordering

• SAR Toolbox Request Example
• Method Parameters

Direct RAPI Access

If you would like information on accessing the RAPI directly, visit Directly Accessing the EODMS REST API.

Contact

If you have any questions or require support, please contact the EODMS Support Team at eodms-sgdot@nrcan-rncan.gc.ca.