gfwapiclient.resources.references.regions.endpoints

Global Fishing Watch (GFW) API Python Client - Regions API EndPoints.

Module Contents

Classes

EEZRegionEndPoint	Get Exclusive Economic Zone (EEZ) regions API endpoint.
MPARegionEndPoint	Get Marine Protected Area (MPA) regions API endpoint.
RFMORegionEndPoint	Get Regional Fisheries Management Organization (RFMO) regions API endpoint.

Data

__all__

API

gfwapiclient.resources.references.regions.endpoints.__all__ = ['EEZRegionEndPoint', 'MPARegionEndPoint', 'RFMORegionEndPoint']

class gfwapiclient.resources.references.regions.endpoints.EEZRegionEndPoint(*, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.GetEndPoint[gfwapiclient.http.models.RequestParams, gfwapiclient.http.models.RequestBody, gfwapiclient.resources.references.regions.models.EEZRegionItem, gfwapiclient.resources.references.regions.models.EEZRegionResult]

Get Exclusive Economic Zone (EEZ) regions API endpoint.

This endpoint retrieves a list of Exclusive Economic Zone (EEZ) regions. See the API documentation for more details: https://globalfishingwatch.org/our-apis/documentation#regions

Initialization

Initializes a new EEZRegionEndPoint.

Args:

http_client (HTTPClient):

The HTTP client to send requests.

class gfwapiclient.resources.references.regions.endpoints.MPARegionEndPoint(*, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.GetEndPoint[gfwapiclient.http.models.RequestParams, gfwapiclient.http.models.RequestBody, gfwapiclient.resources.references.regions.models.MPARegionItem, gfwapiclient.resources.references.regions.models.MPARegionResult]

Get Marine Protected Area (MPA) regions API endpoint.

This endpoint retrieves a list of Marine Protected Area (MPA) regions. See the API documentation for more details: https://globalfishingwatch.org/our-apis/documentation#regions

Initialization

Initializes a new MPARegionEndPoint.

Args:

http_client (HTTPClient):

The HTTP client to send requests.

class gfwapiclient.resources.references.regions.endpoints.RFMORegionEndPoint(*, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.GetEndPoint[gfwapiclient.http.models.RequestParams, gfwapiclient.http.models.RequestBody, gfwapiclient.resources.references.regions.models.RFMORegionItem, gfwapiclient.resources.references.regions.models.RFMORegionResult]

Get Regional Fisheries Management Organization (RFMO) regions API endpoint.

This endpoint retrieves a list of Regional Fisheries Management Organization (RFMO) regions. See the API documentation for more details: https://globalfishingwatch.org/our-apis/documentation#regions

Initialization

Initializes a new RFMORegionEndPoint.

Args:

http_client (HTTPClient):

The HTTP client to send requests.