gfwapiclient.resources.references.resources

Global Fishing Watch (GFW) API Python Client - References Data API Resource.

Module Contents

Classes

ReferenceResource

References data API resource.

Data

__all__

API

gfwapiclient.resources.references.resources.__all__ = ['ReferenceResource']

class gfwapiclient.resources.references.resources.ReferenceResource(*, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.resources.BaseResource

References data API resource.

This resource provides access to reference data endpoints, such as EEZ, MPA, and RFMO regions. See the API documentation for more details: https://globalfishingwatch.org/our-apis/documentation#regions

Initialization

Initialize a new BaseResource.

Args:

http_client (HTTPClient):

The HTTP client to send requests.

async get_eez_regions(**kwargs: Dict[str, Any]) → gfwapiclient.resources.references.regions.models.EEZRegionResult

Get available Exclusive Economic Zone (EEZ) regions data.

Retrieves a list of Exclusive Economic Zone (EEZ) regions.

Args:

**kwargs (Dict[str, Any]):

Additional keyword arguments to pass to the EEZ region endpoint’s request.

Returns:

EEZRegionResult:

An EEZRegionResult instance containing the EEZ regions data.

async get_mpa_regions(**kwargs: Dict[str, Any]) → gfwapiclient.resources.references.regions.models.MPARegionResult

Get available Marine Protected Area (MPA) regions data.

Retrieves a list of Marine Protected Area (MPA) regions.

Args:

**kwargs (Dict[str, Any]):

Additional keyword arguments to pass to the MPA region endpoint’s request.

Returns:

MPARegionResult:

An MPARegionResult instance containing the MPA regions data.

async get_rfmo_regions(**kwargs: Dict[str, Any]) → gfwapiclient.resources.references.regions.models.RFMORegionResult

Get available Regional Fisheries Management Organization (RFMO) regions data.

Retrieves a list of Regional Fisheries Management Organization (RFMO) regions.

Args:

**kwargs (Dict[str, Any]):

Additional keyword arguments to pass to the RFMO region endpoint’s request.

Returns:

RFMORegionResult:

An RFMORegionResult instance containing the RFMO regions data.