Skip to content

Search and export

The search and export tool is designed to search the database based on species information. Some defaults are maintained such as if no geometry is provided a global geometry is assumed and if no date ranges are provided a month is chosen from currrent date. If only start or end dates are provided a month is added to the start or deducted from the end date. The tool fetches additional information like geolocation accuracy and license information and adds it to the export. The export can be a GeoJSON file or a CSV.


The bare minima arguments required are an export file path and the species. The tool will automatically select one month from today and use a global geometry to run the search.


happywhale search -h
usage: happywhale search [-h] --export EXPORT --species SPECIES [--geom GEOM] [--start START] [--end END]

  -h, --help         show this help message and exit

Required named arguments.:
  --export EXPORT    Full path to export file ending in .geojson or .csv
  --species SPECIES  Species name or keyword for example Humpback Whale or humpback_whale

Optional named arguments:
  --geom GEOM        Input geometry file in geojson format defaults to Global
  --start START      Start date in format YYYY-MM-DD
  --end END          End date in format YYYY-MM-DD

Last update: 2023-11-08
Created: 2023-11-08