LAADS Web Service Classic API

This Application Programming Interface (API) encompasses a library of functions that provides programmatic data access and processing services to MODIS Level-1 and Atmosphere data products. These routines enable both SOAP and REST based web service calls against the data archives maintained by the LAADS DAAC. These routines mirror existing LAADS DAAC Search and Order services.

Sample implementation using this API are provided in the Quick Start Guide. Issues and bugs are listed at Known Issues.

Information about the production, archive and distribution of the data products in LAADS can be found at the MODAPS Services web site.

API Methods

Product Information


Searching


Processing Information


Ordering


Status


Data Structures

Product Information

  • listSatelliteInstruments

    Returns a list of available satellite/instruments.

    ParameterTypeDescriptionRequiredValuesDefault
    None

    ReturnTypeDescription
    instrumentsList of NameValuePairA list of satellite/instrument names, along with their descriptions.


  • listCollections

    Returns a list of available collections. Deprecated because collections can vary between products. Use getCollections instead.

    ParameterTypeDescriptionRequiredValuesDefault
    None

    ReturnTypeDescription
    collectionsList of NameValuePairA list of collections, along with their descriptions.


  • getCollections

    Returns a list of available collections for the given product.

    ParameterTypeDescriptionRequiredValuesDefault
    productstringProduct/ESDT shortnameYesAny productN/A

    ReturnTypeDescription
    collectionsList of NameValuePairA list of collections, along with their descriptions.


  • listProducts

    Returns a list of available products.

    ParameterTypeDescriptionRequiredValuesDefault
    None

    ReturnTypeDescription
    productsList of NameValuePairA list of products, along with their descriptions.


  • listProductGroups

    Returns a list of available product groups for the given instrument.

    ParameterTypeDescriptionRequiredValuesDefault
    instrumentStringThe satellite/instrument name.yesA valid satellite/instrument name, see listSatelliteInstruments.N/A

    ReturnTypeDescription
    groupsList of NameValuePairA list of product groups, along with their descriptions.


  • listProductsByInstrument

    Returns a list of products available for the given satellite/instrument.

    ParameterTypeDescriptionRequiredValuesDefault
    instrumentStringThe satellite/instrument name.yesA valid satellite/instrument name, see listSatelliteInstruments.N/A
    groupStringThe product group namenoA valid group name, see listProductGroups.N/A

    ReturnTypeDescription
    productsList of StringsA list of product names for this satellite/instrument.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getFileProperties

    Returns the data file properties for the given file IDs.

    ParameterTypeDescriptionRequiredValuesDefault
    fileIdsStringThe file IDs for the data files, in a comma-delimited string.yesAny valid file ID, see searchForFiles or searchForFilesByName.N/A

    ReturnTypeDescription
    propertiesList of FilePropertiesA list of data file properties, including name, id, size, format, ingest time, data start time, and online status.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getFileOnlineStatuses

    Returns the data file online statuses for the given file IDs.

    ParameterTypeDescriptionRequiredValuesDefault
    fileIdsStringThe file IDs for the data files, in a comma-delimited string.yesAny valid file ID, see searchForFiles or searchForFilesByName.N/A

    ReturnTypeDescription
    statusesList of FileOnlineStatusA list of data files statues, including the date until the data file is required online.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getFileUrls

    Returns the data file download URLs for the given file IDs.

    ParameterTypeDescriptionRequiredValuesDefault
    fileIdsStringThe file IDs for the data files, in a comma-delimited string.yesAny valid file ID, see searchForFiles or searchForFilesByName.N/A

    ReturnTypeDescription
    urlsList of StringsA list of data file download URLs. If a data file is not online, a NULL is returned.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getBrowse

    Returns browse fileIds for the given fileId.

    ParameterTypeDescriptionRequiredValuesDefault
    fileIdStringThe fileId for which you want browse filesyesAny valid file ID, see searchForFiles or searchForFilesByName.N/A

    ReturnTypeDescription
    browseFilesList of BrowseFilesA structure containing info for each available browse file: fileId, product name, description.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getDateCoverage

    Returns the range of dates covered by the given product in the given collection. This range marks the extreme first and last dates and does NOT account for gaps in the data coverage between those points.

    ParameterTypeDescriptionRequiredValuesDefault
    collectionIntegerThe collection number.yesA valid collection number, see listCollections.N/A
    productStringThe product name.yesA valid product name, see listProducts.N/A

    ReturnTypeDescription
    dateRangeDateRangeA start date and an end date.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getMaxSearchResults

    Returns maximum number of file IDs that will be returned from a search.

    ParameterTypeDescriptionRequiredValuesDefault
    None

    ReturnTypeDescription
    maxResultsIntegerThe maximum number of file IDs that will be returned from a search, see searchForFiles and searchForFilesByName.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.

Searching

  • searchForFiles

    Returns a list of file IDs matching the given search criteria.

    ParameterTypeDescriptionRequiredValuesDefault
    productsStringThe product names in a comma-delimited string.yesAny valid product name, see listProducts.N/A
    collectionIntegerThe collection number.noA valid collection number, see getCollections.Default collection for product,see getCollections
    startTimeStringThe start date (and optional time) of the temporal window.yesYYYY-MM-DD or YYYY-MM-DD hh:mm:ssN/A
    endTimeStringThe end date (and optional time) of the temporal window.yesYYYY-MM-DD or YYYY-MM-DD hh:mm:ssN/A
    northFloatNorth boundary of the spatial window.yes-90 to 90 for coords or 0 to 17 for tiles.N/A
    southFloatSouth boundary of the spatial window.yes-90 to 90 for coords or 0 to 17 for tiles.N/A
    eastFloatEast boundary of the spatial window.yes-180 to 180 for coords or 0 to 35 for tiles.N/A
    westFloatWest boundary of the spatial window.yes-180 to 180 for coords or 0 to 35 for tiles.N/A
    coordsOrTilesStringSpecifies whether the north/south/west/east parameters are coords or tiles. The north/south/west/east parameters are ignored if global.yescoords, tiles, or globaN/A
    dayNightBothStringSpecifies whether to include data files which only have day data (D), only have night data (N), or only have both day and night data (B).noD,N,B,DN,DB,NB,DNBDNB

    ReturnTypeDescription
    fileIdsList of IntegersA list of file IDs, which uniquely identify the data files.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • searchForFilesByName

    Returns a list of fileIDs matching the given file name.

    ParameterTypeDescriptionRequiredValuesDefault
    collectionIntegerThe collection number.yesA valid collection number, see getCollections.N/A
    patternStringA file name pattern.yesA string of at least 15 characters that may contain wildcards (*, ?, []) after the first 15 characters.N/A

    ReturnTypeDescription
    fileIdsList of IntegersA list of file IDs, which uniquely identify the data files.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • searchDatasets

    Returns a list of products matching the supplied keywords. The keywords are OR'd, and will match product shortname, longname, and name of any SDS's contained in the product. This OpenSearch Description Document describes this dataset-level search.

    ParameterTypeDescriptionRequiredValuesDefault
    patternStringWhitespace delimited list of keywordsyesAny stringN/A

    ReturnTypeDescription
    productsatom+xmlA list of data products, in an opensearch-compatible atom format.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getOSDD

    Returns an OpenSearch Description Document for a granule-level search of a product.

    ParameterTypeDescriptionRequiredValuesDefault
    productStringA product nameyesA valid product, see searchDatasets, or listProductsN/A

    ReturnTypeDescription
    OpenSearch Descriptionatom+xmlAn OpenSearch Description Document
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getOpenSearch

    Returns the data files matching the given search criteria in an OpenSearch compatible atom format.

    ParameterTypeDescriptionRequiredValuesDefault
    productsStringThe product names in a comma-delimited string.yesAny valid product name, see listProducts.N/A
    collectionIntegerThe collection numberNoA valid collection number, see getCollections.Default collections for product, see getCollections
    startStringThe start date (and optional time) of the temporal window.yesYYYY-MM-DD or YYYY-MM-DD hh:mm:ssN/A
    stopStringThe end date (and optional time) of the temporal window.yesYYYY-MM-DD or YYYY-MM-DD hh:mm:ssN/A
    bboxStringBoundary of the spatial window.yeswest,south,east,north where south and north are -90 to 90 for coords or 0 to 17 for tiles and west and east are -180 to 180 for coords or 0 to 35 for tiles.N/A
    coordsOrTilesStringSpecifies whether the bbox parameter are coords or tiles. The bbox parameter is ignored if global.nocoords, tiles, or globalcoords
    dayNightBothStringSpecifies whether to include data files which only have day data (D), only have night data (N), or only have both day and night data (B).noD,N,B,DN,DB,NB,DNBDNB

    ReturnTypeDescription
    filesThe data files are returned in an OpenSearch compatible atom format.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


Processing Information

  • getPostProcessingTypes

    Returns a list of available post-processing operations for the given products.

    ParameterTypeDescriptionRequiredValuesDefault
    productsList of StringsThe product names.yesAny valid product name, see listProducts.N/A

    ReturnTypeDescription
    postProcessingTypesList of StringsA list of post-processing operations.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getBands

    Returns a list of available bands for the given product.

    ParameterTypeDescriptionRequiredValuesDefault
    productStringThe product name.yesA valid product name, see listProducts.N/A

    ReturnTypeDescription
    bandsList of NameValuePairA list of band names, along with their descriptions.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getDataLayers

    Returns a list of available data layers for the given product.

    ParameterTypeDescriptionRequiredValuesDefault
    productStringThe product name.yesA valid product name, see listProducts.N/A

    ReturnTypeDescription
    dataLayersList of NameValuePairA list of data layer names, along with their descriptions.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • listMapProjections

    Returns a list of available map projections.

    ParameterTypeDescriptionRequiredValuesDefault
    None

    ReturnTypeDescription
    projectionsList of NameValuePairA list of map projection names, along with their descriptions.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • listReprojectionParameters

    Returns a list of reprojection parameters available for the given map projection.

    ParameterTypeDescriptionRequiredValuesDefault
    reprojectionNameStringThe map projection name.yesA valid map projection, see listMapProjections.N/A

    ReturnTypeDescription
    parametersList of ReprojectionParameterA list of reprojection parameters, including the name, description, and unit of measurement.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


Ordering

  • orderFiles

    Creates one or more orders for the given user and file IDs. The requested file IDs are first separated by file type, e.g., online or processing on demand. If any of these orders is too large, they will be broken up into several smaller orders. Several post-processing options are available, depending on the product.

    ParameterTypeDescriptionRequiredValuesDefault
    emailStringUser's email address. A notification email will be sent to this address when the order is complete.yesAny valid email address.N/A
    fileIdsList of Integers The file IDs that identify the data files to order, in a comma-delimited string.yesAny valid file ID, see searchForFiles or searchForFilesByName.N/A
    reformatTypeStringSpecifies the format you would like the data files. Data files are in HDF format by default.nogeotiff, jpegN/A
    doMosiacBooleanSpecifies whether you would like to create a mosaic of the data files.notrue, falseN/A
    geoSubsetNorthFloatNorth boundary for geographic subsetting.no-90 to 90N/A
    geoSubsetSouthFloatSouth boundary for geographic subsetting.no-90 to 90N/A
    geoSubsetWestFloatWest boundary for geographic subsetting.no-180 to 180N/A
    geoSubsetEastFloatEast boundary for geographic subsetting.no-180 to 180N/A
    reprojectionNameStringSpecifies the map projection you would like the data files.noA valid map projection name, see listMapProjections.N/A
    reprojectionOuputPixelSizeStringThe output pixel size parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe output pixel size value in meters.N/A
    reprojectionFalseEastingStringThe false easting parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe false easting value in meters.N/A
    reprojectionFalseNorthingStringThe false northing parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe false northing value in meters.N/A
    reprojectionStandardParallel1StringThe latitude of first standard parallel parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe latitude of first standard parallel value in degrees.N/A
    reprojectionStandardParallel2StringThe latitude of second standard parallel parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe latitude of second standard parallel value in degrees.N/A
    reprojectionCentralMeridianStringThe longitude of central meridian parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe longitude of central meridian value in degrees.N/A
    reprojectionOriginLatStringThe latitude of projection origin parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe latitude of projection origin value in degrees.N/A
    reprojectionCenterLonStringThe longitude of center of projection parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe longitude of center of projection value in degrees.N/A
    reprojectionCenterLatStringThe latitude of center of projection parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe latitude of center of projection value in degrees.N/A
    reprojectionTrueScaleLatStringThe latitude of true scale parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe latitude of true scale value in degrees.N/A
    reprojectionLongitudePoleStringThe longitude below pole parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe longitude below pole value in degrees.N/A
    reprojectionScaleFactorStringThe scale factor at central meridian parameter for a reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noThe scale factor at central meridian value in meters.N/A
    reprojectionResampleTypeStringThe resample type parameter for the reprojection, see listReprojectionParameters to determine if this parameter may be used with the specified reprojectionName.noNearest, BilinearN/A
    subsetDataLayerList of StringsSpecifies the data layers to extract from the data files.noAny valid data layer, see getDataLayers.N/A
    subsetBandList of StringsSpecifies the bands to extract from the data files.noAny valid band, see getBands.N/A

    ReturnTypeDescription
    orderIdsList of IntegersA list of order IDs which are used to uniquely identify the order. The order IDs will also be referenced in the notification email.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • orderFilesProcessed (deprecated)

    orderFiles now accepts post processing options as optional parameters. See orderFiles for a description of functionality. This method will remain active for now, but it is essentially an alias for orderFiles.


Status

  • getAllOrders

    Returns a list of order IDs associated with the user's email address.

    ParameterTypeDescriptionRequiredValuesDefault
    emailStringUser's email address.yesA valid email address.N/A

    ReturnTypeDescription
    orderIdsList of IntegersA list of order IDs which are used to uniquely identify the order.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getOrderStatus

    Returns the order status of the given order ID.

    ParameterTypeDescriptionRequiredValuesDefault
    orderIdIntegerThe order ID for the order.yesA valid order ID, see getAllOrders.N/A

    ReturnTypeDescription
    statusStringA status description.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • getOrderUrl

    Returns the order download URL for the given order ID.

    ParameterTypeDescriptionRequiredValuesDefault
    orderIdIntegerThe order ID for the order.yesA valid order ID, see getAllOrders.N/A

    ReturnTypeDescription
    urlStringAn order download URL.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


  • releaseOrder

    Releases an order so that it can be removed from the download site to free up space.

    ParameterTypeDescriptionRequiredValuesDefault
    orderIdIntegerThe order ID for the order.yesA valid order ID, see getAllOrders.N/A
    emailStringUser's email address.yesA valid email address.N/A

    ReturnTypeDescription
    successInteger1 if the order was successfully released, 0 otherwise.
    ErrorException ClassDescription
    Invalid ParametersInvalidParameterExceptionOne or more of the required parameters are missing, or a supplied parameter is invalid.


Data Structures

  • FileProperties

    A set of file properties.

    FieldNotes
    checksum
    fileId
    fileName
    fileSizeBytes
    fileType
    ingestTime
    online
    startTime


  • FileOnlineStatus

    A file's online status and related information

    FieldNotes
    archiveAutoDelete
    fileId
    requireUntil


  • NameValuePair

    A pair that maps a modaps identifier such as an SDS or satellite instrument name to a human readable description.

    FieldNotes
    NameThe identifier to be used in web service calls
    ValueA human readable description of the identifier


  • DateRange

    A date range.

    FieldNotes
    endDateYYYY-MM-DD
    StartDateYYYY-MM-DD

Last updated: May 30, 2018