gfwapiclient.resources.bulk_downloads

Global Fishing Watch (GFW) API Python Client - Bulk Download API Resource.

This module provides the BulkDownloadResource class, which allows to interact with the Bulk Download API to:

• Create bulk reports based on specific filters and spatial parameters.

• Monitor previously created bulk report generation status.

• Get signed URL to download previously created bulk report data, metadata and

region geometry (in GeoJSON format) files. - Query previously created bulk report data records in JSON format.

For detailed information about the Bulk Download API, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#bulk-download-api

For more details on the Bulk Download data caveats, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#sar-fixed-infrastructure-data-caveats

Subpackages

• gfwapiclient.resources.bulk_downloads.file
  • gfwapiclient.resources.bulk_downloads.file.models
    • gfwapiclient.resources.bulk_downloads.file.models.request
    • gfwapiclient.resources.bulk_downloads.file.models.response
  • gfwapiclient.resources.bulk_downloads.file.endpoints
• gfwapiclient.resources.bulk_downloads.detail
  • gfwapiclient.resources.bulk_downloads.detail.models
    • gfwapiclient.resources.bulk_downloads.detail.models.response
  • gfwapiclient.resources.bulk_downloads.detail.endpoints
• gfwapiclient.resources.bulk_downloads.list
  • gfwapiclient.resources.bulk_downloads.list.models
    • gfwapiclient.resources.bulk_downloads.list.models.request
    • gfwapiclient.resources.bulk_downloads.list.models.response
  • gfwapiclient.resources.bulk_downloads.list.endpoints
• gfwapiclient.resources.bulk_downloads.query
  • gfwapiclient.resources.bulk_downloads.query.models
    • gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data
    • gfwapiclient.resources.bulk_downloads.query.models.base
  • gfwapiclient.resources.bulk_downloads.query.endpoints
• gfwapiclient.resources.bulk_downloads.create
  • gfwapiclient.resources.bulk_downloads.create.models
    • gfwapiclient.resources.bulk_downloads.create.models.request
    • gfwapiclient.resources.bulk_downloads.create.models.response
  • gfwapiclient.resources.bulk_downloads.create.endpoints
• gfwapiclient.resources.bulk_downloads.base
  • gfwapiclient.resources.bulk_downloads.base.models
    • gfwapiclient.resources.bulk_downloads.base.models.request
    • gfwapiclient.resources.bulk_downloads.base.models.response

Submodules

• gfwapiclient.resources.bulk_downloads.resources

Package Contents

Data

__all__

API

gfwapiclient.resources.bulk_downloads.__all__ = ['BulkDownloadResource']