gfwapiclient.resources.insights.endpoints

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

Module Contents

Classes

VesselInsightEndPoint

Get Vessels Insights API endpoint.

API

class gfwapiclient.resources.insights.endpoints.VesselInsightEndPoint(*, request_body: gfwapiclient.resources.insights.models.request.VesselInsightBody, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.PostEndPoint[gfwapiclient.http.models.RequestParams, gfwapiclient.resources.insights.models.request.VesselInsightBody, gfwapiclient.resources.insights.models.response.VesselInsightItem, gfwapiclient.resources.insights.models.response.VesselInsightResult]

Get Vessels Insights API endpoint.

This endpoint retrieves insights for specified vessels based on the provided request parameters.

Args:
request_body (VesselInsightBody):

The request body containing vessel insight parameters.

http_client (HTTPClient):

The HTTP client for making API requests.

Initialization

Initializes a new VesselInsightEndPoint API endpoint.

Args:
request_body (VesselInsightBody):

The request body containing vessel insight parameters.

http_client (HTTPClient):

The HTTP client for making API requests.