Skip to main content
Ctrl+K
Welcome! Coincident is in early development. APIs may change significantly

Coincident

  • User Guide
  • Examples
  • Datasets
  • API reference
  • GitHub
  • User Guide
  • Examples
  • Datasets
  • API reference
  • GitHub

Section Navigation

  • coincident.search.search
  • coincident.search.cascading_search
  • coincident.search.to_pystac_items
  • coincident.search.to_geopandas
  • coincident.search.wesm.read_wesm_csv
  • coincident.search.wesm.load_by_fid
  • coincident.search.wesm.get_swath_polygons
  • coincident.overlaps.geographic_area
  • coincident.overlaps.subset_by_minimum_area
  • coincident.overlaps.subset_by_temporal_overlap
  • coincident.overlaps.subset_by_maximum_duration
  • coincident.io.sliderule.subset_gedi02a
  • coincident.io.sliderule.subset_atl06
  • coincident.io.sliderule.process_atl06sr
  • coincident.io.sliderule.sample_3dep
  • coincident.io.xarray.to_dataset
  • coincident.io.xarray.open_maxar_browse
  • coincident.io.xarray.load_usgs_dem
  • coincident.io.xarray.load_neon_dem
  • coincident.io.xarray.load_noaa_dem
  • coincident.io.xarray.load_ncalm_dem
  • coincident.io.download.download_item
  • coincident.io.download.read_href
  • coincident.io.download.build_usgs_ept_pipeline
  • coincident.io.download.download_usgs_dem
  • coincident.io.download.download_neon_dem
  • coincident.io.download.download_noaa_dem
  • coincident.io.download.download_ncalm_dem
  • coincident.io.download.fetch_lpc_tiles
  • coincident.io.download.build_usgs_ept_pipeline
  • coincident.io.download.download_files
  • coincident.plot.plot_maxar_browse
  • coincident.plot.plot_esa_worldcover
  • coincident.plot.plot_dem
  • coincident.plot.compare_dems
  • coincident.plot.plot_altimeter_points
  • coincident.plot.boxplot_terrain_diff
  • coincident.plot.hist_esa
  • coincident.datasets.general.Dataset
  • API reference
  • coincident.search.search

coincident.search.search#

coincident.search.search(dataset, intersects=None, datetime=None, **kwargs)#

Perform a search for geospatial data using STAC or non-STAC APIs for a single dataset.

Parameters:
  • dataset (str or Dataset) – The dataset to search. Can be a string alias or a Dataset object.

  • intersects (gpd.GeoDataFrame) – A GeoDataFrame containing a single row, or GeoSeries containing a geometry to restrict the search area.

  • datetime (str or None, optional) – The datetime range for the search in ISO 8601 format. If None, no datetime filter is applied.

  • **kwargs (Any) – Additional keyword arguments to pass to the search functions. see https://pystac-client.readthedocs.io/en/latest/api.html#item-search

Returns:

A GeoDataFrame containing the search results.

Return type:

gpd.GeoDataFrame

Raises:

ValueError – If the provided dataset alias is not supported.

previous

API reference

next

coincident.search.cascading_search

On this page
  • search()
Edit on GitHub

© Copyright 2025, UW TACO Lab.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.