gfwapiclient.resources.fourwings.report.models.response

Global Fishing Watch (GFW) API Python Client - 4Wings Report API Response Models.

Module Contents

Classes

FourWingsReportItem	4Wings report entry.
FourWingsReportResult	Result for 4Wings Report API endpoint.

Data

__all__

API

gfwapiclient.resources.fourwings.report.models.response.__all__ = ['FourWingsReportItem', 'FourWingsReportResult']

class gfwapiclient.resources.fourwings.report.models.response.FourWingsReportItem(/, **data: typing.Any)

Bases: gfwapiclient.http.models.ResultItem

4Wings report entry.

Represents a single entry in the 4Wings report result. Each entry captures multiple dimensions of vessel activity, identity, and detection using Automatic Identification System (AIS) or Synthetic Aperture Radar (SAR) data.

For more details on the 4Wings API supported report response bodies, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#create-a-report-of-a-specified-region

Attributes:

date (Optional[str]):

The date of the report entry (e.g. “2022-01-13”).

detections (Optional[int]):

The number of vessel detections (e.g. 12).

flag (Optional[str]):

The vessel’s country flag (e.g. “ESP”).

gear_type (Optional[str]):

The vessel’s gear type (e.g. “FISHING”).

hours (Optional[float]):

The number of activity hours (e.g. 26.6).

vessel_ids (Optional[int]):

The number of vessel identifiers (IDs) (e.g. 3).

vessel_id (Optional[str]):

The vessel identifier (ID) (e.g “e6154b2e7-7762-4889-fb46-976ec72875e1”).

vessel_type (Optional[str]):

The vessel type (e.g “FISHING”).

entry_timestamp (Optional[datetime.datetime]):

The timestamp when the vessel entered the observation area in ISO-8601 format (e.g “2022-01-14T14:00:00Z”).

exit_timestamp (Optional[datetime.datetime]):

The timestamp when the vessel exited the observation area in ISO-8601 format (e.g “2022-01-14T16:00:00Z”).

first_transmission_date (Optional[datetime.datetime]):

The vessel’s first AIS (Automatic Identification System) transmission date in ISO-8601 format (e.g “2019-07-12T12:08:27Z”).

last_transmission_date (Optional[datetime.datetime]):

The vessel’s last AIS (Automatic Identification System) transmission date in ISO-8601 format (e.g “2025-03-01T23:55:50Z”).

imo (Optional[str]):

The vessel’s IMO (International Maritime Organization) number (e.g “8602866”).

mmsi (Optional[str]):

The vessel’s MMSI (Maritime Mobile Service Identity) number (e.g “273453380”).

call_sign (Optional[str]):

The vessel’s call sign (e.g “UBSS9”).

dataset (Optional[str]):

The vessel information dataset (e.g “public-global-vessel-identity:v3.0”).

report_dataset (Optional[str]):

The dataset used to create the report (e.g “public-global-fishing-effort:v3.0”).

ship_name (Optional[str]):

The vessel’s ship name (e.g “ALSEY”).

lat (Optional[float]):

The vessel’s reported latitude (e.g 49.33).

lon (Optional[float]):

The vessel’s reported longitude (e.g 141.15).

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

date: Optional[str] = 'Field(...)'

detections: Optional[int] = 'Field(...)'

flag: Optional[str] = 'Field(...)'

gear_type: Optional[str] = 'Field(...)'

hours: Optional[float] = 'Field(...)'

vessel_ids: Optional[int] = 'Field(...)'

vessel_id: Optional[str] = 'Field(...)'

vessel_type: Optional[str] = 'Field(...)'

entry_timestamp: Optional[datetime.datetime] = 'Field(...)'

exit_timestamp: Optional[datetime.datetime] = 'Field(...)'

first_transmission_date: Optional[datetime.datetime] = 'Field(...)'

last_transmission_date: Optional[datetime.datetime] = 'Field(...)'

imo: Optional[str] = 'Field(...)'

mmsi: Optional[str] = 'Field(...)'

call_sign: Optional[str] = 'Field(...)'

dataset: Optional[str] = 'Field(...)'

report_dataset: Optional[str] = 'Field(...)'

ship_name: Optional[str] = 'Field(...)'

lat: Optional[float] = 'Field(...)'

lon: Optional[float] = 'Field(...)'

classmethod empty_datetime_str_to_none(value: Any) → Optional[Any]

Convert any empty datetime string to None.

Args:

value (Any):

The value to validate.

Returns:

Optional[datetime.datetime]:

The validated datetime object or None if input is empty.

class gfwapiclient.resources.fourwings.report.models.response.FourWingsReportResult(data: List[gfwapiclient.resources.fourwings.report.models.response.FourWingsReportItem])

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.fourwings.report.models.response.FourWingsReportItem]

Result for 4Wings Report API endpoint.

Represents the result of the 4Wings Report API endpoint.

Attributes:

_result_item_class (Type[FourWingsReportItem]):

The model used for individual result items.

_data (List[FourWingsReportItem]):

List of report items returned in the response.

Initialization

Initializes a new FourWingsReportResult.

Args:

data (List[FourWingsReportItem]):

The list of report items.

_result_item_class: Type[gfwapiclient.resources.fourwings.report.models.response.FourWingsReportItem] = None

_data: List[gfwapiclient.resources.fourwings.report.models.response.FourWingsReportItem] = None