Examples4Wings Reports
Generate fishing effort report grouped by gear type, using existing regions (Russian EEZ) in CSV format
Example 4Wings report for apparent fishing effort in the Russian EEZ, grouped by gear type, as CSV.
To get details of existing regions, check Regions in the Reference data section
GET
Query parameters
| Parameter | Value | Description |
|---|---|---|
spatial-resolution | LOW | Low spatial resolution |
temporal-resolution | MONTHLY | Aggregate by month |
group-by | GEARTYPE | Group results by gear type |
datasets[0] | public-global-fishing-effort:latest | AIS apparent fishing effort dataset |
date-range | 2022-01-01,2022-05-01 | Filter to this time period |
format | CSV | Response format |
region-id | 5690 | Russian EEZ region id |
region-dataset | public-eez-areas | Existing region dataset |
Request
# Make sure to replace [TOKEN] with your API Access Token.
curl --location -g --request GET 'https://gateway.api.globalfishingwatch.org/v3/4wings/report?spatial-resolution=LOW&temporal-resolution=MONTHLY&group-by=GEARTYPE&datasets[0]=public-global-fishing-effort:latest&date-range=2022-01-01,2022-05-01&format=CSV®ion-id=5690®ion-dataset=public-eez-areas' \
--header 'Authorization: Bearer [TOKEN]' \
--header 'Content-Type: application/json'result = await gfw_client.fourwings.create_report(
datasets=["public-global-fishing-effort:latest"],
spatial_resolution="LOW",
temporal_resolution="MONTHLY",
group_by="GEARTYPE",
start_date="2022-01-01",
end_date="2022-05-01",
region={"dataset": "public-eez-areas", "id": 5690},
)gfw_ais_fishing_hours(
spatial_resolution = "LOW",
temporal_resolution = "MONTHLY",
start_date = "2022-01-01",
end_date = "2022-05-01",
region = 5690,
region_source = "EEZ",
group_by = "GEARTYPE"
)// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
'https://gateway.api.globalfishingwatch.org/v3/4wings/report?spatial-resolution=LOW&temporal-resolution=MONTHLY&group-by=GEARTYPE&datasets[0]=public-global-fishing-effort:latest&date-range=2022-01-01,2022-05-01&format=CSV®ion-id=5690®ion-dataset=public-eez-areas',
{ headers: { Authorization: 'Bearer [TOKEN]' } }
)
const data = await res.json()POST
Query parameters
| Parameter | Value | Description |
|---|---|---|
spatial-resolution | LOW | Low spatial resolution |
temporal-resolution | MONTHLY | Aggregate by month |
group-by | GEARTYPE | Group results by gear type |
datasets[0] | public-global-fishing-effort:latest | AIS apparent fishing effort dataset |
date-range | 2022-01-01,2022-05-01 | Filter to this time period |
format | CSV | Response format |
Request body
| Field | Value | Description |
|---|---|---|
region.dataset | public-eez-areas | Existing region dataset |
region.id | 5690 | Russian EEZ region id |
Request
# Make sure to replace [TOKEN] with your API Access Token.
curl --location -g --request POST 'https://gateway.api.globalfishingwatch.org/v3/4wings/report?spatial-resolution=LOW&temporal-resolution=MONTHLY&group-by=GEARTYPE&datasets[0]=public-global-fishing-effort:latest&date-range=2022-01-01,2022-05-01&format=CSV' \
--header 'Authorization: Bearer [TOKEN]' \
--header 'Content-Type: application/json' \
--output 'report-grouped.json' \
--data-raw '{
"region": {
"dataset": "public-eez-areas",
"id": 5690
}
}'result = await gfw_client.fourwings.create_report(
datasets=["public-global-fishing-effort:latest"],
spatial_resolution="LOW",
temporal_resolution="MONTHLY",
group_by="GEARTYPE",
start_date="2022-01-01",
end_date="2022-05-01",
region={"dataset": "public-eez-areas", "id": 5690},
)gfw_ais_fishing_hours(
spatial_resolution = "LOW",
temporal_resolution = "MONTHLY",
start_date = "2022-01-01",
end_date = "2022-05-01",
region = 5690,
region_source = "EEZ",
group_by = "GEARTYPE"
)// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
'https://gateway.api.globalfishingwatch.org/v3/4wings/report?spatial-resolution=LOW&temporal-resolution=MONTHLY&group-by=GEARTYPE&datasets[0]=public-global-fishing-effort:latest&date-range=2022-01-01,2022-05-01&format=CSV',
{
method: 'POST',
headers: {
Authorization: 'Bearer [TOKEN]',
'Content-Type': 'application/json',
},
body: JSON.stringify({
region: { dataset: 'public-eez-areas', id: 5690 },
}),
}
)
const data = await res.blob()Response
Report AIS vessel presence - cargo and carrier vessels only (JSON)
Example 4Wings report of AIS vessel presence filtered to cargo and carrier vessels, as JSON.
Generate report with total fishing hours per Lat/Lon grid cell using existing regions (MPA Dorsal de Nasca) in JSON format
Example 4Wings report of total fishing hours per lat/lon grid cell in the Dorsal de Nasca MPA, as JSON.