Global Fishing Watch API

https://globalfishingwatch.org/our-apis/documentation
Admin
Global Fishing Watch API provides REST APIs to access vessel tracking data, fishing activity, and...
Tokens:404,407
Snippets:1,868
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Example response for get bulk report by ID

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/bulk-download/get-bulk-report-id.md

Example JSON response showing a completed bulk report with status 'done', dataset 'public-fixed-infrastructure-data:v1.1', and file details.

```shell
{
    "id": "adbb9b62-5c08-4142-82e0-b2b575f3e058",
    "dataset": "public-fixed-infrastructure-data:v1.1",
    "name": "sar-vessel-detection-example-1",
    "filepath": "sar_fixed_infrastructure_202409.csv",
    "filters": [
        "label = 'oil'",
        "structure_start_date between '2020-01-01' and '2025-01-01' "
    ],
    "status": "done",
    "geom": {
        "id": 8466,
        "type": "dataset",
        "dataset": "public-eez-areas"
    },
    "createdAt": "2025-06-27T06:43:35.571Z",
    "updatedAt": "2025-06-27T06:43:35.571Z",
    "ownerId": 509,
    "ownerType": "user-application",
    "format": "CSV",
    "fileSize": 1207
}
```

--------------------------------

### Get List of RFMOs - JavaScript

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/datasets/regions

JavaScript fetch example to retrieve the list of RFMOs. Replace [TOKEN] with your API Access Token.

```javascript
// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
  'https://gateway.api.globalfishingwatch.org/v3/datasets/public-rfmo/context-layers',
  { headers: { Authorization: 'Bearer [TOKEN]' } }
)
const data = await res.json()
```

--------------------------------

### Get List of MPAs - JavaScript

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/datasets/regions

JavaScript fetch example to retrieve the list of MPAs. Replace [TOKEN] with your API Access Token.

```javascript
// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
  'https://gateway.api.globalfishingwatch.org/v3/datasets/public-mpa-all/context-layers',
  { headers: { Authorization: 'Bearer [TOKEN]' } }
)
const data = await res.json()
```

--------------------------------

### Install gfw-api-python-client with pip

Source: https://globalfishingwatch.org/our-apis/documentation/docs/sdks/python-client.md

Install the package using pip. Requires Python 3.11 or higher; a virtual environment is recommended.

```shell
pip install gfw-api-python-client
```

--------------------------------

### GET /v3/bulk-reports/{id}/query

Source: https://globalfishingwatch.org/our-apis/documentation/docs/examples/bulk-download/get-json-example1.md

Queries a bulk report by its ID and returns the data as JSON. Supports pagination via limit and offset parameters, and sorting via the sort parameter. The example sorts by structure start date descending.

```APIDOC
## GET /v3/bulk-reports/{id}/query

### Description
Queries a bulk report by its ID and returns the data as JSON. Supports pagination via limit and offset parameters, and sorting via the sort parameter. The example sorts by structure start date descending.

### Method
GET

### Endpoint
https://gateway.api.globalfishingwatch.org/v3/bulk-reports/{id}/query

### Parameters
#### Path Parameters
- **id** (string) - Required - ID of the bulk report to query

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of records to return
- **offset** (integer) - Optional - Number of records to skip
- **sort** (string) - Optional - Sort by structure start date, descending (e.g., -structure_start_date)

### Request Example
```shell
curl --location 'https://gateway.api.globalfishingwatch.org/v3/bulk-reports/adbb9b62-5c08-4142-82e0-b2b575f3e058/query?limit=2&offset=0&sort=-structure_start_date' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer TOKEN'
```

### Response
#### Success Response (200)
- **metadata** (object) - Metadata about the response
- **limit** (integer) - The limit used for the query
- **offset** (integer) - The offset used for the query
- **nextOffset** (integer) - The next offset for pagination
- **total** (integer) - Total number of records available
- **entries** (array) - List of records
  - **detection_id** (string) - Unique identifier for the detection
  - **detection_date** (string) - Date of detection
  - **structure_id** (string) - Identifier of the structure
  - **lon** (number) - Longitude coordinate
  - **lat** (number) - Latitude coordinate
  - **structure_start_date** (string) - Start date of the structure
  - **structure_end_date** (string or null) - End date of the structure
  - **label** (string) - Label of the structure (e.g., oil)
  - **label_confidence** (string) - Confidence level of the label (e.g., low, high)

#### Response Example
```json
{
  "metadata": {},
  "limit": 2,
  "offset": 0,
  "nextOffset": 2,
  "total": 43,
  "entries": [
    {
      "detection_id": "S1AB_AD_MEDIAN_COMP_20240201T000000_20240801T000000_FULL_41_TILE_154;-65.0214080;-42.736182",
      "detection_date": "2024-05-01",
      "structure_id": "1054536",
      "lon": -65.02140773749714,
      "lat": -42.73618183211688,
      "structure_start_date": "2024-05-01",
      "structure_end_date": "2024-05-01",
      "label": "oil",
      "label_confidence": "low"
    },
    {
      "detection_id": "S1AB_AD_MEDIAN_COMP_20240501T000000_20241101T000000_FULL_23_TILE_332;-67.3234300;-53.089715",
      "detection_date": "2024-08-01",
      "structure_id": "1051638",
      "lon": -67.32289149541135,
      "lat": -53.0895574340617,
      "structure_start_date": "2024-02-01",
      "structure_end_date": null,
      "label": "oil",
      "label_confidence": "high"
    }
  ]
}
```
```

--------------------------------

### Quick start: vessel search and encounter events

Source: https://globalfishingwatch.org/our-apis/documentation/docs/sdks/gfwr.md

Load gfwr and run two example calls: a vessel search by MMSI and an encounter event query for a date range.

```r
library(gfwr)

# Vessel search by MMSI
gfw_vessel_info(query = 224224000,
                search_type = "search")

# Encounter events for a date range
gfw_event(event_type = "ENCOUNTER",
          start_date = "2020-01-01",
          end_date = "2020-01-02")
```

--------------------------------

### cURL request to get last report

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/4wings/last-report

Example cURL command to call the GET /v3/4wings/last-report endpoint. Requires an Authorization header with a Bearer token.

```bash
curl -X GET "https://example.com/v3/4wings/last-report"
```

--------------------------------

### cURL request to get vessels

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/vessels/get-vessels

Example cURL command to fetch vessel data using the GET /v3/vessels endpoint. Requires an API key for authorization.

```bash
curl -X GET "https://example.com/v3/vessels?datasets=public-global-fishing-vessels%3Alatest&datasets=public-global-carrier-vessels%3Alatest&ids=6583c51e3-3626-5638-866a-f47c3bc7ef7c"
```

--------------------------------

### Install development version of gfwr from GitHub

Source: https://globalfishingwatch.org/our-apis/documentation/docs/sdks/gfwr.md

Install the development version of gfwr from GitHub, ensuring the remotes package is available first.

```r
if (!require("remotes"))
  install.packages("remotes")

remotes::install_github("GlobalFishingWatch/gfwr",
                        dependencies = TRUE)
```

--------------------------------

### GET /api/v3/events

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/events/get-all-events.md

Retrieves all events using the GET method. Examples are available for apparent fishing events, encounter events, loitering events, and port visits.

```APIDOC
## GET /api/v3/events

### Description
Retrieves all events using the GET method. Examples are available for apparent fishing events, encounter events, loitering events, and port visits.

### Method
GET

### Endpoint
/api/v3/events

### Parameters
No parameters are explicitly documented in the source.

### Request Example
No request example is provided in the source.

### Response
#### Success Response (200)
No response fields are explicitly documented in the source.

#### Response Example
No response example is provided in the source.
```

--------------------------------

### Report running response example

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/4wings/last-report

Example response when the last report is still running. Includes the report URI and status 'running'.

```json
{
  "uri": "/v3/4wings/report?format=JSON&datasets%5B0%5D=public-global-fishing-effort%3Av3.0&date-range=2023-12-31T00%3A00%3A00.000Z%2C2024-01-10T00%3A00%3A00.000Z&spatial-aggregation=true&temporal-resolution=ENTIRE&region-dataset=public-eez-areas&group-by=VESSEL_ID",
  "status": "running",
  "lastUpdate": "2024-02-05T13:34:06+0000"
}
```

--------------------------------

### Get List of RFMOs - Response Example

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/datasets/regions

Example JSON response from the RFMO list endpoint, showing the structure with label, id, and ID fields. The response is truncated with an ellipsis.

```json
[
  {
    "label": "LTA",
    "id": "LTA",
    "ID": "LTA"
  },
  {
    "label": "SEAFDEC",
    "id": "SEAFDEC",
    "ID": "SEAFDEC"
  },
  {
    "label": "IATTC",
    "id": "IATTC",
    "ID": "IATTC"
  },
  {
    "label": "APFIC",
    "id": "APFIC",
    "ID": "APFIC"
  },
  {
    "label": "IPHC",
    "id": "IPHC",
    "ID": "IPHC"
  },
  {
    "label": "ICCAT",
    "id": "ICCAT",
    "ID": "ICCAT"
  },
  {
    "label": "WCPFC",
    "id": "WCPFC",
    "ID": "WCPFC"
  },
  {
    "label": "CCAMLR",
    "id": "CCAMLR",
    "ID": "CCAMLR"
  },
  {
    ...
  }
]
```

--------------------------------

### Search vessel by IMO with R

Source: https://globalfishingwatch.org/our-apis/documentation/docs/quick-start.md

R example using the gfwr package to search for a vessel by IMO. Requires the gfwr package to be installed. The example uses the search_type = "search" parameter.

```r
# install.packages("gfwr")
library(gfwr)

gfw_vessel_info(query = 7831410,
                search_type = "search")
```

--------------------------------

### Sample JSON response from bulk report query

Source: https://globalfishingwatch.org/our-apis/documentation/docs/examples/bulk-download/get-json-example1.md

Example response returned by the API for the query. It shows the metadata, limit, offset, nextOffset, total, and entries array with detection details.

```shell
   {
    "metadata": {},
    "limit": 2,
    "offset": 0,
    "nextOffset": 2,
    "total": 43,
    "entries": [
        {
            "detection_id": "S1AB_AD_MEDIAN_COMP_20240201T000000_20240801T000000_FULL_41_TILE_154;-65.0214080;-42.736182",
            "detection_date": "2024-05-01",
            "structure_id": "1054536",
            "lon": -65.02140773749714,
            "lat": -42.73618183211688,
            "structure_start_date": "2024-05-01",
            "structure_end_date": "2024-05-01",
            "label": "oil",
            "label_confidence": "low"
        },
        {
            "detection_id": "S1AB_AD_MEDIAN_COMP_20240501T000000_20241101T000000_FULL_23_TILE_332;-67.3234300;-53.089715",
            "detection_date": "2024-08-01",
            "structure_id": "1051638",
            "lon": -67.32289149541135,
            "lat": -53.0895574340617,
            "structure_start_date": "2024-02-01",
            "structure_end_date": null,
            "label": "oil",
            "label_confidence": "high"
        }
    ]
}
```

--------------------------------

### Successful response with download URL

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/bulk-download/download-file

Example 200 response containing the signed URL in the 'url' field. The URL points to a downloadable file hosted on Global Fishing Watch's cloud infrastructure.

```json
{
  "url": "https://example.com/download-file"
}
```

--------------------------------

### Search vessel by IMO with Python

Source: https://globalfishingwatch.org/our-apis/documentation/docs/quick-start.md

Python example using the gfw-api-python-client package to search for a vessel by IMO. Requires the package to be installed and the GFW_API_ACCESS_TOKEN environment variable set. The example uses the public-global-vessel-identity:latest dataset.

```python
# pip install gfw-api-python-client
import os
import gfwapiclient as gfw

gfw_client = gfw.Client(
    access_token=os.environ["GFW_API_ACCESS_TOKEN"],
)

result = await gfw_client.vessels.search_vessels(
    query="7831410",
    datasets=["public-global-vessel-identity:latest"],
)
```

--------------------------------

### Response with signed download URL

Source: https://globalfishingwatch.org/our-apis/documentation/docs/examples/bulk-download/download-file-example1.md

Example JSON response from the download-file-url endpoint. The url field contains a temporary signed URL to download the README file.

```shell
{
    "url": "https://storage.googleapis.com/api-bulk-release-us-central1/adbb9b62-5c08-4142-82e0-b2b575f3e058/README.md?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=896869274290-compute%40developer.gserviceaccount.com%2F20250627%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250627T110204Z&X-Goog-Expires=60&X-Goog-SignedHeaders=host&X-Goog-Signature=2b7ed1b82af29747bfe00d2abf745a2d20f6909c4548f1aeebc8f2f51e0be335872622423ee888b25daad93cb4871bc398f4c1ec279febaaf2cf16197ba3044f0d28443c05d197e46cddfcfac3401958fb87efc3d04c9ea9761dbff6567bf53a7ec634a44425e1160ad31552e7126b257441fc047ceb95a11e167620cb8b99232942afa28c08a5c414981dbef3681ee3868d1df7655d2c6a6c5123f9db3a27a73d15cd976d7508bac8de9c5bc865e6ed55dd62805b0f2a87c494484a60e521335af80711f7fce207fe25db54d5fd7efedbf46aa4119d0d539d995a575e758079ba771b07a7ed6e8fe93dfaaefbc519d45855b1f44df21307bb0ecc036f7bd36b"
}
```

--------------------------------

### cURL request to GET /api/v3/events

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/events/get-all-events

Example cURL command to fetch events with pagination parameters offset=0 and limit=1.

```bash
curl -X GET "https://example.com/api/v3/events?datasets=public-global-fishing-events%3Alatest&datasets=public-global-encounter-events%3Alatest&offset=0&limit=1"
```

--------------------------------

### cURL request to get one event

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/events/get-one-event

Example cURL command to fetch an event by ID using the public-global-fishing-events dataset.

```bash
curl -X GET "https://example.com/api/v3/events/string?dataset=public-global-fishing-events%3Alatest"
```

--------------------------------

### 200 OK response example

Source: https://globalfishingwatch.org/our-apis/documentation/docs/v3/4wings/report

Example of a successful response with report entries, including vessel details and timestamps.

```json
{
  "entries": [
    {
      "callsign": "UBSS9",
      "dataset": "public-global-vessel-identity:v3.0",
      "date": "2022-01-13",
      "detections": 12,
      "entryTimestamp": "2022-01-14T14:00:00Z",
      "exitTimestamp": "2022-01-14T16:00:00Z",
      "firstTransmissionDate": "2019-07-12T12:08:27Z",
      "flag": "ESP",
      "geartype": "FISHING",
      "hours": 26.6,
      "imo": "8602866",
      "lastTransmissionDate": "2025-03-01T23:55:50Z",
      "lat": 49.33,
      "lon": 141.15,
      "mmsi": "273453380",
      "shipName": "ALSEY",
      "vesselIDs": 3,
      "vesselId": "e6154b2e7-7762-4889-fb46-976ec72875e1",
      "vesselType": "FISHING"
    }
  ],
  "limit": 0,
  "metadata": {},
  "nextOffset": 0,
  "offset": 0,
  "total": 0
}
```
Tokens:
Raw