Scroll to navigation

STAC-CLIENT(1) User Commands STAC-CLIENT(1)

NAME

stac-client - Tool for working with SpatioTemporal Asset Catalog (STAC) APIs

DESCRIPTION

usage: stac-client [-h] [--version] {collections,search} ...

STAC Client

positional arguments:

{collections,search}
Get all collections in this Catalog
Perform new search of items

options:

show this help message and exit
Print version and exit

DESCRIPTION

usage: stac-client collections [-h] [--logging LOGGING]

[--headers [HEADERS ...]]
[--add-conforms-to [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER} ...]] [--remove-conforms-to [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER} ...]] [--clear-conforms-to] [--error [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac} ...]] [--ignore [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac} ...]] [--save SAVE] url

positional arguments:

Root Catalog URL

options:

show this help message and exit
DEBUG, INFO, WARN, ERROR, CRITICAL (default: INFO)
Additional request headers (KEY=VALUE pairs) (default: None)
Specify conformance classes to add to client (default: None)
Specify conformance classes to remove from client (default: None)

--clear-conforms-to

warnings behavior:

Error on all stac-client warnings or specific warnings. (default: None)
Ignore all stac-client warnings or specific warnings. (default: None)

output options:

Filename to save collections to (default: None)

DESCRIPTION

usage: stac-client search [-h] [--logging LOGGING] [--headers [HEADERS ...]]

[--add-conforms-to [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER} ...]]
[--remove-conforms-to [{CORE,COLLECTIONS,FEATURES,ITEM_SEARCH,CONTEXT,FIELDS,SORT,QUERY,FILTER} ...]] [--clear-conforms-to] [-c [COLLECTIONS ...]] [--ids [IDS ...]] [--bbox BBOX BBOX BBOX BBOX] [--intersects INTERSECTS] [--datetime DATETIME] [--query [QUERY ...]] [-q [Q ...]] [--filter FILTER] [--filter-lang FILTER_LANG] [--sortby [SORTBY ...]] [--fields [FIELDS ...]] [--limit LIMIT] [--max-items MAX_ITEMS] [--method METHOD] [--error [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac} ...]] [--ignore [{no-conforms-to,does-not-conform-to,missing-link,fallback-to-pystac} ...]] [--matched] [--save SAVE] url

positional arguments:

Root Catalog URL

options:

show this help message and exit
DEBUG, INFO, WARN, ERROR, CRITICAL (default: INFO)
Additional request headers (KEY=VALUE pairs) (default: None)
Specify conformance classes to add to client (default: None)
Specify conformance classes to remove from client (default: None)

--clear-conforms-to

search options:

One or more collection IDs (default: None)
One or more Item IDs (ignores other parameters) (default: None)
Bounding box (min lon, min lat, max lon, max lat) (default: None)
GeoJSON Feature or geometry (file or string) (default: None)
Single datetime or begin and end datetime (e.g., 2017-01-01/2017-02-15) (default: None)
Query properties of form KEY=VALUE (>=,<=,=,<>,>,< supported) (default: None)
DEPRECATED. Use --query instead. Query properties of form KEY=VALUE (<, >, <=, >=, = supported) (default: None)
Filter on queryables using language specified in filter-lang parameter (default: None)
Filter language used within the filter parameter (default: cql2-json)
Sort by fields (default: None)
Control what fields get returned (default: None)
Page size limit (default: None)
Max items to retrieve from search (default: None)
GET or POST (default: POST)

warnings behavior:

Error on all stac-client warnings or specific warnings. (default: None)
Ignore all stac-client warnings or specific warnings. (default: None)

output options:

Print number matched (default: False)
Filename to save Item collection to (default: None)
August 2023 stac-client 0.7.3