gfwapiclient.resources.datasets.endpoints

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

Module Contents

Classes

SARFixedInfrastructureEndPoint

Get SAR fixed infrastructure API endpoint.

API

class gfwapiclient.resources.datasets.endpoints.SARFixedInfrastructureEndPoint(*, z: int, x: int, y: int, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.get.GetEndPoint[gfwapiclient.http.models.RequestParams, gfwapiclient.http.models.RequestBody, gfwapiclient.resources.datasets.models.response.SARFixedInfrastructureItem, gfwapiclient.resources.datasets.models.response.SARFixedInfrastructureResult]

Get SAR fixed infrastructure API endpoint.

This endpoint retrieves SAR fixed infrastructure data based on the provided request parameters.

Initialization

Initializes a new SARFixedInfrastructureEndPoint API endpoint.

Args:
z: (int):

Zoom level (from 0 to 9 for SAR fixed infrastructure dataset). Example: 1.

x: (int):

X index (lat) of the tile. Example: 0.

y: (int):

Y index (lon) of the tile. Example: 1.

http_client (HTTPClient):

The HTTP client for making API requests.