Imaging Atlas Search API

The PDS Imaging Atlas is the data product search for planetary image data. This user interface harnesses the power of Apache Solr to allow for faceted, Google-like search capabilities.

We have extended these search capabilities to allow for simple software interfacing with the search index through a search API (or protocol). This API is an extension of the PDS Search Protocol for product-level search.

The default output from the search API is JSON.

PDS Imaging Atlas Search API
What can you query?
Advanced Query Syntax

What can you query?

The following table includes parameters that can be used to query the Imaging Atlas Search API.

Some additional information for understanding how to use this API:

<base_url> = https://pds-imaging.jpl.nasa.gov/solr/pds_archives/search
The parameters are not case-sensitive.
Search looks for exact value specified. Use * to allow for fuzzy searching. i.e. identifier=*N1845993031* will match for identifier=1_N1845993031.118.

Name Description Examples

identifier In PDS4, every artifact is considered a product, and every product is assigned an identifier and a version. This parameter represents that identifier and is used to uniquely identify a product or multiple versions of a product. This parameter maps to the logical_identifier attribute specified in a product label or the combination of the logical_identifier and version_id attributes. The former case may return multiple versions of a product where the latter case should return one product. Both of these attributes are located in the Identification_Area class in PDS4 product labels.

This is also mapped to the PDS3 PRODUCT_ID.

<base_url>?identifier=some_lidvid

<base_url>?identifier=1_N1845993031.118

<base_url>?identifier=*N1845993031*

product_id Search by PDS3 PRODUCT_ID.

<base_url>?product_id=1_N1845993031.118

<base_url>?product_id=*N1845993031*

instrument Search by instrument used to take the image. This will match against the instrument name, instrument ID, and any instrument alias names.

<base_url>?instrument=iss

<base_url>?instrument=imaging*science*subsystem*

instrument_host This parameter is used to identify products associated with or captured from an instrument on a specific instrument host or spacecraft <base_url>?instrument_host=cassini

spacecraft See instrument_host parameter <base_url>?spacecraft=cassini

investigation This parameter is used to identify products associated with a specific investigation or mission. <base_url>?investigation=mars*science*laboratory

mission See investigation parameter. <base_url>?mission=mars*science*laboratory

start_time This parameter is used to identify products within a specific date/time range based on the product labeled start time. Depending on the mission, this may also map to local time and/or image time. Formation rule: YYYY-MM-DDThh:mm:ss[.fff]. <base_url>start_time=[2001-01-01T00:00:00Z TO 2002-01-01T00:00:00Z] (images from 2001)

stop_time This parameter is used to identify products within a specific date/time range based on the product labeled stop time. Formation rule: YYYY-MM-DDThh:mm:ss[.fff]. <base_url>stop_time=[2001-01-01T00:00:00Z TO 2002-01-01T00:00:00Z] (images from 2001)

target This parameter is used to identify products associated with or containing data for a specific target <base_url>?target=mars

term This parameter does not directly map to a specific attribute found in PDS product labels but can be used to query against several attributes based on the configuration of the underlying implementation. <base_url>?term=mars

title This parameter is used to identify products by their name or alternate name. This parameter maps to the title and alternate_title attributes <base_url>?title=*mars*

image_content Search for content of images based on image classifiers available for MSL, MRO HiRISE, Cassini ISS, and Galileo NIMS (i.e crater, streak, body - full, etc.) <base_url>?image_content=crater

filter Search for the commonly-used name of the instrument filter through which an image or measurement was acquired. <base_url>?filter=red

product_type Search for a specific product type in the PDS. These include both the general 'EDR' and 'RDR' terminology, but also the more detailed derived product types, such as "calibrated", "radiometrically calibrated", etc. <base_url>?product_type=calibrated

planet_day_number Search for a range of specific mission planet day numbers for image products.

<base_url>?mission=mars science laboratory&planet_day_number=15

<base_url>?mission=mars science laboratory&planet_day_number=[15 TO 50]

orbit_number Search based on a range of orbits for a particular mission.

<base_url>?mission=lunar recon*&orbit_number=2000

<base_url>?mission=lunar recon*&orbit_number=[2000 TO 3000]

center_latitude Search based on a range of center latitudes of images. <base_url>?target=mars&center_latitude=[13 TO 28]

center_longitude Search based on a range of center longitudes of images. <base_url>?target=mars&center_latitude=[13 TO 28]

Other Keyword/Attribute Queries

pds.* Search for any PDS keywords/attributes we have in the index. i.e. pds.emission_angle, pds.phase_angle, pds.product_creation_time, etc. <base_url>?target=jupiter&pds.emission_angle=[0 to 10]

Name	Description	Examples
identifier	In PDS4, every artifact is considered a product, and every product is assigned an identifier and a version. This parameter represents that identifier and is used to uniquely identify a product or multiple versions of a product. This parameter maps to the logical_identifier attribute specified in a product label or the combination of the logical_identifier and version_id attributes. The former case may return multiple versions of a product where the latter case should return one product. Both of these attributes are located in the Identification_Area class in PDS4 product labels. This is also mapped to the PDS3 PRODUCT_ID.	<base_url>?identifier=some_lidvid <base_url>?identifier=1_N1845993031.118 <base_url>?identifier=N1845993031
product_id	Search by PDS3 PRODUCT_ID.	<base_url>?product_id=1_N1845993031.118 <base_url>?product_id=N1845993031
instrument	Search by instrument used to take the image. This will match against the instrument name, instrument ID, and any instrument alias names.	<base_url>?instrument=iss <base_url>?instrument=imagingsciencesubsystem*
instrument_host	This parameter is used to identify products associated with or captured from an instrument on a specific instrument host or spacecraft	<base_url>?instrument_host=cassini
spacecraft	See instrument_host parameter	<base_url>?spacecraft=cassini
investigation	This parameter is used to identify products associated with a specific investigation or mission.	<base_url>?investigation=marssciencelaboratory
mission	See investigation parameter.	<base_url>?mission=marssciencelaboratory
start_time	This parameter is used to identify products within a specific date/time range based on the product labeled start time. Depending on the mission, this may also map to local time and/or image time. Formation rule: YYYY-MM-DDThh:mm:ss[.fff].	<base_url>start_time=[2001-01-01T00:00:00Z TO 2002-01-01T00:00:00Z] (images from 2001)
stop_time	This parameter is used to identify products within a specific date/time range based on the product labeled stop time. Formation rule: YYYY-MM-DDThh:mm:ss[.fff].	<base_url>stop_time=[2001-01-01T00:00:00Z TO 2002-01-01T00:00:00Z] (images from 2001)
target	This parameter is used to identify products associated with or containing data for a specific target	<base_url>?target=mars
term	This parameter does not directly map to a specific attribute found in PDS product labels but can be used to query against several attributes based on the configuration of the underlying implementation.	<base_url>?term=mars
title	This parameter is used to identify products by their name or alternate name. This parameter maps to the title and alternate_title attributes	<base_url>?title=mars
image_content	Search for content of images based on image classifiers available for MSL, MRO HiRISE, Cassini ISS, and Galileo NIMS (i.e crater, streak, body - full, etc.)	<base_url>?image_content=crater
filter	Search for the commonly-used name of the instrument filter through which an image or measurement was acquired.	<base_url>?filter=red
product_type	Search for a specific product type in the PDS. These include both the general 'EDR' and 'RDR' terminology, but also the more detailed derived product types, such as "calibrated", "radiometrically calibrated", etc.	<base_url>?product_type=calibrated
planet_day_number	Search for a range of specific mission planet day numbers for image products.	<base_url>?mission=mars science laboratory&planet_day_number=15 <base_url>?mission=mars science laboratory&planet_day_number=[15 TO 50]
orbit_number	Search based on a range of orbits for a particular mission.	<base_url>?mission=lunar recon&orbit_number=2000 <base_url>?mission=lunar recon&orbit_number=[2000 TO 3000]
center_latitude	Search based on a range of center latitudes of images.	<base_url>?target=mars&center_latitude=[13 TO 28]
center_longitude	Search based on a range of center longitudes of images.	<base_url>?target=mars&center_latitude=[13 TO 28]
Other Keyword/Attribute Queries
pds.*	Search for any PDS keywords/attributes we have in the index. i.e. pds.emission_angle, pds.phase_angle, pds.product_creation_time, etc.	<base_url>?target=jupiter&pds.emission_angle=[0 to 10]

Advanced Query Syntax

TBD