AI4COPSEC AI4COPSEC collekt
  • Home
  • Products
  • CLI
  • Credentials
  • Manifest
  • API reference

On this page

  • GFW
    • Parameters

GFW

GFW(key='gfw', *, datasets=None, limit=None, max_events=None)

Global Fishing Watch Events API selection (fishing/port visits/encounters/loitering/gaps).

A credential-gated feature source with no variable selection. The query pages until GFW runs out of events, so a result is complete unless max_events caps it.

Example:

collekt.DatasetConfig(collekt.GFW(datasets=["public-global-fishing-events:latest"]))

Parameters

Name Type Description Default
key str Catalog key to select. Defaults to gfw. 'gfw'
datasets Iterable[str] | None GFW dataset ids to query. Defaults to the catalog’s five event datasets. None
limit int | None Rows per request (GFW’s own limit), not a cap on the result. None uses the client default of 99999, which keeps the common case to a single request. None
max_events int | None Total cap across pages. None collects everything; when a cap cuts a result short, GFWTruncatedResultWarning is raised. None

Part of AI4COPSEC.

Built with Quarto.

GitHub