シーン検索の条件に指定できるパラメータ
シーン検索の条件に指定できるパラメータ
Tellus Satellite Data Traveler API の /data-search/ でシーンを検索する際に指定できるパラメータについて説明します。
検索条件パラメータ
| キー | キー | 型 | 説明 |
|---|---|---|---|
| datasets | str[] |
検索したいデータセットID 全データセットを対象とする際は指定しない。 例） ["1a41a4b1-4594-431f-95fb-82f9bdc35d6b", "b0e16dea-6544-4422-926f-ad3ec9a3fcbd"] |
|
| intersects | Polygon |
GeoJSONのPolygon（座標はEPSG:4326）で指定した検索範囲 180度線をまたぐ際は190度のように+360で指定する。 例） {
"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 |
絞り込みたいシーン情報 以下に示す項目は全シーン共通でキーに指定できる。 例） {
値に利用できる比較演算子は別表「queryで利用可能な比較演算子」を参照してください。 |
|
| start_datetime | str |
撮影開始日時 |
|
| end_datetime | str |
撮影終了日時 |
|
| tellus:published_datetime | str |
Tellusでのシーン公開日時 |
|
| tellus:name | str |
シーン名 |
|
| tellus:can_ordered | bool |
注文が必要なシーンかどうか |
|
| sortby | dict[] |
ソート条件 プロパティとそのソート方向を指定したオブジェクトの配列 例） [{"field": "properties.end_datetime", "direction": "desc"}]
|
|
| paginate | dict |
ページネーションの指定 size: 一度に取得するシーンの数（10以上1000以下） 例） {"size":10,"cursor":None}
|
queryで利用可能な比較演算子
| 演算子 | 説明 |
|---|---|
| eq | 指定した値と等しい 大文字小文字を区別しない |
| neq | 指定した値と等しくない 大文字小文字を区別しない |
| gt | 指定した値より大きい |
| lt | 指定した値より小さい |
| gte | 指定した値以上 |
| lte | 指定した値以下 |
| startsWith | 指定した文字列で始まる 大文字小文字を区別しない |
| endsWith | 指定した文字列で終わる 大文字小文字を区別しない |
| contains | 指定した文字列を含む 大文字小文字を区別しない |
| in | 指定した複数の値の少なくとも一つに等しい 大文字小文字を区別しない |
データセット毎に指定可能なプロパティ
シーン検索の条件において、query で使用できるデータセットプロパティ（カタログ情報）は、 API /dataset-properties/ を実行すると取得することができます。
TOKEN("TOKENXXXXXXXXXXXXXXXXXX"と表示されている部分)にご自身のAPIトークンを貼り付けてください。
import requests
TOKEN = "TOKENXXXXXXXXXXXXXXXXXX"
# API 呼び出しの共通設定
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("エラー：{}".format(err))
return res.json()
print(get_props())
Travelerの画面上でもデータセットプロパティ（カタログ情報）を調べることができます。
データセット詳細ページのその他の欄に「カタログ情報」として掲載されており、データセットごとに異なります。
「詳細」をクリックして「カタログ情報詳細」を確認すると、値の情報などを確認することができます。