Cooperata Python API Docs | dltHub
Build a Cooperata-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Cooperata is Global Fishing Watch’s REST API portal providing vessel identity, events, insights, 4Wings map/reporting and bulk‑download endpoints for ocean and vessel data. The REST API base URL is https://gateway.api.globalfishingwatch.org/v3 and All requests require a Bearer token provided in the Authorization header..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Cooperata data in under 10 minutes.
What data can I load from Cooperata?
Here are some of the endpoints you can load from Cooperata:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| vessels | /v3/vessels | GET | Search and retrieve vessel identity details. | |
| events | /v3/events | GET | Retrieve encounter, fishing, loitering, port‑visit and other event records. | |
| 4wings_report | /v3/4wings/report | GET | entries | Create or fetch aggregated map/report results; response includes an "entries" array. |
| insights_vessels | /v3/insights/vessels | POST | Vessel‑level aggregated insights; returns a single JSON object. | |
| bulk_reports | /v3/bulk-reports | GET | entries | List bulk reports for the user; response includes an "entries" array. |
| bulk_report_by_id | /v3/bulk-reports/{id} | GET | Get single bulk report status and signed download URL; returns a single object. |
How do I authenticate with the Cooperata API?
The API uses HTTP Bearer token authentication. Include header: Authorization: Bearer <YOUR_TOKEN>. Some endpoints also require Content-Type: application/json and Accept: application/json.
1. Get your credentials
- Register or sign in to a Global Fishing Watch account: https://globalfishingwatch.org/our-apis/tokens/signup
- Open the API Access Tokens page: https://globalfishingwatch.org/our-apis/tokens
- Create a new API access token and copy the generated token.
- Store this token securely (see secrets_toml_example below).
2. Add them to .dlt/secrets.toml
[sources.cooperata_source] api_key = "your_api_token_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Cooperata API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python cooperata_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline cooperata_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset cooperata_data The duckdb destination used duckdb:/cooperata.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline cooperata_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads vessels and events from the Cooperata API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def cooperata_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://gateway.api.globalfishingwatch.org/v3", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "vessels", "endpoint": {"path": "v3/vessels"}}, {"name": "events", "endpoint": {"path": "v3/events"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="cooperata_pipeline", destination="duckdb", dataset_name="cooperata_data", ) load_info = pipeline.run(cooperata_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("cooperata_pipeline").dataset() sessions_df = data.events.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM cooperata_data.events LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("cooperata_pipeline").dataset() data.events.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Cooperata data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Troubleshooting
Authentication failures
If you receive 401 Unauthorized or 403 Forbidden, verify your Authorization header is exactly "Authorization: Bearer " and that the token is active. Regenerate a token from the API Access Tokens page if needed.
Rate limits and Terms of Use
Requests are limited by the API Terms of Use — ensure you include your API token for each request and avoid high‑frequency polling. The docs show example 429 responses for rate‑limited endpoints (e.g., 4Wings reporting). Cache GET requests where possible.
Pagination and offsets
List endpoints use limit and offset query parameters. Example list responses include top‑level fields: total, limit, offset, nextOffset and a paginated array in entries for some endpoints. Use offset += limit to page through results.
Report jobs and bulk downloads
Bulk report creation returns a report object with status (pending/done) and, when done, a signed URL in a url field for downloading the report. Repeated GETs for the same report may return a running‑status object.
Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Cooperata?
Request dlt skills, commands, AGENT.md files, and AI-native context.