API Reference
Core
Request a region and time window, fetch, and inspect the result.
| version | |
| Request | A request to collect data. |
| Region | Geographic region of interest. |
| Fetcher | Fetch source-native data for a request. |
| Result | Result returned by collekt fetch operations. |
| Assembler | Convert a downloaded collection into analysis-ready objects. |
| run_doctor | Run environment and configuration checks. |
| DoctorCheck | One diagnostic check result. |
| available_datasets | Return every catalog dataset as a flat mapping keyed by dataset key. |
| describe_datasets | Return a human-readable, provider-grouped listing of the catalog. |
Datasets
Select datasets from the bundled catalog and set their provider parameters.
| DatasetConfig | Datasets and provider parameters requested for one collection run. |
| CMEMS | Copernicus Marine dataset selection. |
| ECMWFOpenData | ECMWF Open Data forecast selection. |
| ERA5 | ERA5 reanalysis selection. |
| GFS | NOAA GFS analysis selection. |
| eOdyn | eOdyn dataset selection. |
| Local | Local, tabular-archive dataset selection. |
| SkyTruth | SkyTruth Cerulean slick selection. |
| CopernicusDataSpace | Copernicus Data Space product selection. |
| Hozint | HOZINT threat-intelligence report selection. |
| GFW | Global Fishing Watch Events API selection (fishing/port visits/encounters/loitering/gaps). |