Global Fishing Watch API
API v34Wings - Map Visualization

Get Raster Tiles

Get raster or vector tiles by z/x/y coordinates, in PNG or MVT format, for gridded activity datasets.

Get raster by tile coordinates

This endpoint allows you to get details of the cell of the tile (in PNG or MVT format depending on the parameter).

⚠️ Before using this endpoint, for PNG format, remember to create your STYLE that specifies how the data will be visualized. Check more detail about how to generate your style here.

Examples using AIS apparent fishing effort:

  • EXAMPLE 1 - Get AIS apparent fishing effort heatmap in PNG format
  • EXAMPLE 2 - Get AIS apparent fishing effort heatmap in MVT format

Examples using SAR (Synthetic-aperture radar) vessel detections:

  • EXAMPLE 3 - Get SAR vessel detections heatmap in PNG format
  • EXAMPLE 4 - Get SAR vessel detections heatmap in MVT format

Examples using AIS Vessel Presence:

  • EXAMPLE 5 - Get AIS vessel presence heatmap in PNG format
  • EXAMPLE 6 - Get AIS vessel presence heatmap in MVT format

Get raster

GET
/v3/4wings/tile/heatmap/{z}/{x}/{y}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

In: header

Path Parameters

z*number

Zoom level (from 0 to 12)

x*number

X index (lat) of the tile

y*number

Y index (lon) of the tile

Query Parameters

temporal-aggregation?boolean

Aggregates temporarily the data in the tile

interval?string

Tiles are available at several time resolutions (hourly, daily and 10 days), it means one frame every one hour, one day or 10 days. For each resolution, the the max displayable length items:

  • 1 hour: 20 days
  • 1 day: 1 year
  • 10 days: several years depending on the dataset for AIS Fishing effort it starts in 2012

Value in

  • "10DAYS"
  • "DAY"
  • "HOUR"
  • "MONTH"
  • "YEAR"
datasets[0]*string

Specify the datasets that will be used to create the style. You can learn more about which are the possible datasets here. The parameters should be defined using an index, in case only one dataset is going to be sent: ?dataset[0]=xxxxx, in case of multiple datasets: ?dataset[0]=xxxxx&dataset[1]=yyyyy

filters[0]?string

Filters are applied to the dataset parameter with the corresponding index. For example if we want to apply a filter to dataset[0], we should apply the filter attributes to filter[0].For AIS fishing effort, the possible filters are: flag, geartype

date-range?string

Start date and end date to filter the data

format?string

Format of response

Value in

  • "MVT"
  • "PNG"
  • "INTARRAY"
  • "4WINGS"
style?string

Id of the style obtained with endpoint /v1/4wings/generate-png

vessel-groups[0]?string

Vessel group ids to filter (separated by comma). Vessel groups applied at dataset with index 0. At the same as datasets, this query param could be send with different index to apply filters to other datasets.

curl -X GET "https://example.com/v3/4wings/tile/heatmap/1/0/0?temporal-aggregation=true&interval=10DAYS&datasets%5B0%5D=public-global-fishing-effort%3Alatest&filters%5B0%5D=flag+in+%28%27ESP%27%29&date-range=2021-01-01%2C2021-03-01&format=MVT&style=eyJjb2xvciI6WzIyLDYzLDEzN10sInJhbXAiOlswLDE4NC41MDM4ODg4ODg4ODg4Nyw2NjkuNDg3Nzc3Nzc3Nzc3OAwxNDQ2LjUwODA1NTU1NTU1NTMsMjg2OS42MjA1NTU1NTU1NTU3LDU4OTEuMDI1NTU1NTU1NTU1LDg1MjguODkxMTExMTExMTEsMTE5MTYuNjA2OTQ0NDQ0NDQ0LDE3OTMyLjI3NjM4ODg4ODg4OF18&vessel-groups%5B0%5D=1%2C2"
{}

Create a Style for PNG Tiles

Create a style document defining how 4Wings data is drawn. Required before requesting PNG tiles.

Generate Bins

Generate bins of the underlying data at a given zoom level, for example to build a color ramp.

On this page

Get raster by tile coordinatesGet raster