Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Global Fishing Watch API Client documentation v0.1.0
Logo
  • Getting Started
  • Installation
  • Usage Guides
    • 4Wings API
    • Vessels API
    • Events API
    • Insights API
    • Reference Data API

Project

  • Development Guides
    • Setup
    • Git Workflow
    • Contributing
    • Code of conduct
    • Security
    • Changelog
    • License
  • API Reference
    • gfwapiclient
      • gfwapiclient.resources
        • gfwapiclient.resources.insights
          • gfwapiclient.resources.insights.models
            • gfwapiclient.resources.insights.models.request
            • gfwapiclient.resources.insights.models.response
          • gfwapiclient.resources.insights.resources
          • gfwapiclient.resources.insights.endpoints
        • gfwapiclient.resources.vessels
          • gfwapiclient.resources.vessels.search
            • gfwapiclient.resources.vessels.search.models
              • gfwapiclient.resources.vessels.search.models.request
              • gfwapiclient.resources.vessels.search.models.response
            • gfwapiclient.resources.vessels.search.endpoints
          • gfwapiclient.resources.vessels.detail
            • gfwapiclient.resources.vessels.detail.models
              • gfwapiclient.resources.vessels.detail.models.request
              • gfwapiclient.resources.vessels.detail.models.response
            • gfwapiclient.resources.vessels.detail.endpoints
          • gfwapiclient.resources.vessels.list
            • gfwapiclient.resources.vessels.list.models
              • gfwapiclient.resources.vessels.list.models.request
              • gfwapiclient.resources.vessels.list.models.response
            • gfwapiclient.resources.vessels.list.endpoints
          • gfwapiclient.resources.vessels.base
            • gfwapiclient.resources.vessels.base.models
              • gfwapiclient.resources.vessels.base.models.request
              • gfwapiclient.resources.vessels.base.models.response
          • gfwapiclient.resources.vessels.resources
        • gfwapiclient.resources.references
          • gfwapiclient.resources.references.regions
            • gfwapiclient.resources.references.regions.models
              • gfwapiclient.resources.references.regions.models.response
            • gfwapiclient.resources.references.regions.endpoints
          • gfwapiclient.resources.references.resources
        • gfwapiclient.resources.datasets
        • gfwapiclient.resources.events
          • gfwapiclient.resources.events.detail
            • gfwapiclient.resources.events.detail.models
              • gfwapiclient.resources.events.detail.models.request
              • gfwapiclient.resources.events.detail.models.response
            • gfwapiclient.resources.events.detail.endpoints
          • gfwapiclient.resources.events.list
            • gfwapiclient.resources.events.list.models
              • gfwapiclient.resources.events.list.models.request
              • gfwapiclient.resources.events.list.models.response
            • gfwapiclient.resources.events.list.endpoints
          • gfwapiclient.resources.events.base
            • gfwapiclient.resources.events.base.models
              • gfwapiclient.resources.events.base.models.request
              • gfwapiclient.resources.events.base.models.response
          • gfwapiclient.resources.events.stats
            • gfwapiclient.resources.events.stats.models
              • gfwapiclient.resources.events.stats.models.request
              • gfwapiclient.resources.events.stats.models.response
            • gfwapiclient.resources.events.stats.endpoints
          • gfwapiclient.resources.events.resources
        • gfwapiclient.resources.fourwings
          • gfwapiclient.resources.fourwings.report
            • gfwapiclient.resources.fourwings.report.models
              • gfwapiclient.resources.fourwings.report.models.request
              • gfwapiclient.resources.fourwings.report.models.response
            • gfwapiclient.resources.fourwings.report.endpoints
          • gfwapiclient.resources.fourwings.resources
      • gfwapiclient.exceptions
        • gfwapiclient.exceptions.client
        • gfwapiclient.exceptions.http
        • gfwapiclient.exceptions.base
        • gfwapiclient.exceptions.validation
      • gfwapiclient.http
        • gfwapiclient.http.endpoints
          • gfwapiclient.http.endpoints.post
          • gfwapiclient.http.endpoints.get
          • gfwapiclient.http.endpoints.base
          • gfwapiclient.http.endpoints.abc
        • gfwapiclient.http.models
          • gfwapiclient.http.models.request
          • gfwapiclient.http.models.response
        • gfwapiclient.http.client
        • gfwapiclient.http.resources
      • gfwapiclient.client
        • gfwapiclient.client.client
      • gfwapiclient.base
        • gfwapiclient.base.models
      • gfwapiclient.__version__
  • GitHub

Useful Links

  • Website
  • Our APIs
  • Terms of Use
  • FAQs
  • R package
Back to top
View this page

Development GuidesΒΆ

The sections below will help you get started with development, testing, and documentation.

  • Setup
  • Git Workflow
  • Contributing
  • Code of conduct
  • Security
  • Changelog
  • License
Next
Setup
Previous
Reference Data API
Copyright © 2025, Global Fishing Watch
Made with Sphinx and @pradyunsg's Furo