Filtering by time period and gear type | Global Fishing Watch API

Example 4Wings PNG style request for AIS apparent fishing effort over a time period, filtered by gear type.

Query parameters

Parameter	Value	Description
`interval`	`DAY`	Daily temporal resolution
`datasets[0]`	`public-global-fishing-effort:latest`	AIS apparent fishing effort dataset
`filters[0]`	`geartype in ("tuna_purse_seines","driftnets")`	Filter by gear type. See Gear Types supported
`date-range`	`2020-01-01,2020-01-31`	Filter to January 2020

Request

# Make sure to replace [TOKEN] with your API Access Token.
curl --location --request POST 'https://gateway.api.globalfishingwatch.org/v3/4wings/generate-png?interval=DAY&datasets[0]=public-global-fishing-effort:latest&filters[0]=geartype%20in%20(%22tuna_purse_seines%22,%22driftnets%22)&date-range=2020-01-01,2020-01-31'  \
  -H "Authorization: Bearer [TOKEN]"

// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
  'https://gateway.api.globalfishingwatch.org/v3/4wings/generate-png?interval=DAY&datasets[0]=public-global-fishing-effort:latest&filters[0]=geartype%20in%20(%22tuna_purse_seines%22,%22driftnets%22)&date-range=2020-01-01,2020-01-31',
  {
    method: 'POST',
    headers: { Authorization: 'Bearer [TOKEN]' },
  }
)
const data = await res.json()

Response

{
  "colorRamp": {
    "stepsByZoom": {
      "0": [
        {
          "color": "rgba(22,63,137,25)",
          "value": 26
        },
        {
          "color": "rgba(22,63,137,102)",
          "value": 384
        },
        {
          "color": "rgba(22,63,137,255)",
          "value": 1936
        },
        {
          "color": "rgba(22,63,137,0)",
          "value": 0
        },
        {
          "color": "rgba(22,63,137,76)",
          "value": 186
        },
        {
          "color": "rgba(22,63,137,127)",
          "value": 822
        },
        {
          "color": "rgba(22,63,137,153)",
          "value": 1114
        },
        {
          "color": "rgba(22,63,137,178)",
          "value": 1502
        },
        {
          "color": "rgba(22,63,137,51)",
          "value": 88
        }
      ]
    }
  },
  "url": "https://gateway.api.globalfishingwatch.org/v3/4wings/tile/heatmap/{z}/{x}/{y}?format=PNG&interval=DAY&datasets[0]=public-global-fishing-effort:latest&filters[0]=geartype in (\"tuna_purse_seines\",\"driftnets\")&date-range=2020-01-01,2020-01-31&style=eyJjb2xvciI6WzIyLDYzLDEzN10sInJhbXAiOlswLDI2LjE2NjM4ODg4ODg4ODg5Myw4OC4yMjgwNTU1NTU1NTU2MSwxODYuMzI1ODMzMzMzMzMzMywzODQuODIwNTU1NTU1NTU1Niw4MjIuOTk1NTU1NTU1NTU0OCwxMTE0LjMyNDcyMjIyMjIyMjEsMTUwMi4wNjA4MzMzMzMzMzMyLDE5MzYuNzA0MTY2NjY2NjY1XX0="
}