gfwapiclient.resources.vessels.detail.endpoints

Global Fishing Watch (GFW) API Python Client - Get Vessel by ID API EndPoint.

This module defines the endpoint for retrieving vessel details by ID.

Module Contents

Classes

VesselDetailEndPoint

Get vessel by ID API endpoint.

Data

__all__

API

gfwapiclient.resources.vessels.detail.endpoints.__all__ = ['VesselDetailEndPoint']

class gfwapiclient.resources.vessels.detail.endpoints.VesselDetailEndPoint(*, vessel_id: str, request_params: gfwapiclient.resources.vessels.detail.models.request.VesselDetailParams, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.GetEndPoint[gfwapiclient.resources.vessels.detail.models.request.VesselDetailParams, gfwapiclient.http.models.RequestBody, gfwapiclient.resources.vessels.detail.models.response.VesselDetailItem, gfwapiclient.resources.vessels.detail.models.response.VesselDetailResult]

Get vessel by ID API endpoint.

This endpoint retrieves vessel details by ID and other provided request parameters.

Initialization

Initializes a new VesselDetailEndPoint API endpoint.

Args:

vessel_id (str):

The ID of the vessel to retrieve.

request_params (VesselDetailParams):

The request parameters for the API call.

http_client (HTTPClient):

The HTTP client used to make the API call.