How to Use｜Tellus

Back to Page

Parameters that can be specified as search criteria for scenes

This section describes the search parameters to search for scenes at the endpoint /data-search/ of Tellus Satellite Data Traveler APIs.

Search parameters

Key	Key	Type	Description
datasets		str[]	Dataset ID to be searched Not specified when targeting all datasets. Example: ["1a41a4b1-4594-431f-95fb-82f9bdc35d6b", "b0e16dea-6544-4422-926f-ad3ec9a3fcbd"]
intersects		Polygon	Search range specified by GeoJSON Polygon (coordinates based on EPSG:4326) When crossing the 180-degree line, specify as +360, e.g., 190 degrees. Example: { "type":"Polygon","coordinates":[ [ [-162.33,11.55], [-149.32,11.55], [-149.32,24.07], [-162.33,24.07], [-162.33,11.55] ] ] }
query		dict	Filtering conditions for scenes The following items can be specified as keys for all scenes in common. In addition, each dataset's own properties (catalog elements) can be used for keys. Example: { "start_datetime": {"gte": "2022-01-12T00:00:00Z"}, "end_datetime": {"lte": "2022-01-20T23:59:59Z"} } For comparison operators that can be used for values, refer to the separate table “Comparison operators accepted in queries”.
	start_datetime	str	Start date and time of data acquisition
	end_datetime	str	End date and time of data acquisition
	tellus:published_datetime	str	Date and time when the scene was published on Tellus
	tellus:name	str	Scene’s name
	tellus:can_ordered	bool	Whether the scene needs to be ordered
sortby		dict[]	Sort criteria Array of objects specifying properties and their sort directions Example: [{"field": "properties.end_datetime", "direction": "desc"}]
paginate		dict	Specification of pagination size: Number of scenes to get at one time (10 or more, 1000 or less) cursor: Send null for the first request, and use the returned cursor value in subsequent requests Example: {"size":10,"cursor":None}

Comparison operators accepted in queries

Operators	Description
eq	Equal to the specified value Case-insensitive
neq	Not equal to the specified value Case-insensitive
gt	Greater than the specified value
lt	Less than the specified value
gte	Greater than or equal to the specified value
lte	Less than or equal to the specified value
startsWith	Starts with the specified string Case-insensitive
endsWith	Ends with the specified string Case-insensitive
contains	Includes the specified string Case-insensitive
in	Equal to at least one of the specified values Case-insensitive

Properties that can be specified for each dataset

To see which dataset properties (catalog elements) can be used as keys in “query” of search criteria for scenes, please get the properties by calling the API /dataset-properties/.

Paste your own API token into TOKEN (marked as “TOKENXXXXXXXXXXXXXXXXXX”).

import requests
TOKEN = "TOKENXXXXXXXXXXXXXXXXXX"
# Common settings for API calls
BASE_URL = "https://www.tellusxdp.com/api/traveler/v1"
REQUESTS_HEADERS = {
    "Authorization": "Bearer " + TOKEN,
    "Content-Type": "application/json",
}
def get_props():
    url = "{}/dataset-properties/".format(BASE_URL)  
    res = requests.get(url, headers=REQUESTS_HEADERS)
    try:
        res.raise_for_status()
    except Exception as err:
        raise SystemError("error：{}".format(err))
    return res.json()
print(get_props())

You can also check the dataset properties (catalog elements) on the Tellus Traveler's website.

They are listed as “Catalog elements” in the field “Others” of the Dataset Details page. Each dataset has its own definition of properties.

For more information on values of each property, click on the "Details" button and refer to the "Catalog elements details."

Back to List