ExamplesEvents
Get encounter events for a vessel (GET)
Example GET request for encounter events of a single vessel over a date range.
Query parameters
| Parameter | Value | Description |
|---|---|---|
datasets[0] | public-global-encounters-events:latest | Encounter events dataset |
vessels[0] | 8c7304226-6c71-edbe-0b63-c246734b3c01 | Vessel id to filter events for |
limit | 1 | Max number of events returned |
offset | 0 | Pagination offset |
Request
# Make sure to replace [TOKEN] with your API Access Token.
curl --location --request GET 'https://gateway.api.globalfishingwatch.org/v3/events?datasets[0]=public-global-encounters-events:latest&vessels[0]=8c7304226-6c71-edbe-0b63-c246734b3c01&limit=1&offset=0' \
-H "Authorization: Bearer [TOKEN]"result = await gfw_client.events.get_all_events(
datasets=["public-global-encounters-events:latest"],
vessels=["8c7304226-6c71-edbe-0b63-c246734b3c01"],
limit=1,
offset=0,
)gfw_event(event_type = "ENCOUNTER",
vessels = "8c7304226-6c71-edbe-0b63-c246734b3c01")// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
'https://gateway.api.globalfishingwatch.org/v3/events?datasets[0]=public-global-encounters-events:latest&vessels[0]=8c7304226-6c71-edbe-0b63-c246734b3c01&limit=1&offset=0',
{ headers: { Authorization: 'Bearer [TOKEN]' } }
)
const data = await res.json()Response
{
"metadata": {
"datasets": ["public-global-encounters-events:v3.0"],
"vessels": ["8c7304226-6c71-edbe-0b63-c246734b3c01"],
"dateRange": {
"from": null,
"to": null
},
"encounterTypes": [
"FISHING-FISHING",
"FISHING-CARRIER",
"FISHING-SUPPORT",
"CARRIER-FISHING",
"SUPPORT-FISHING"
]
},
"limit": 1,
"offset": 0,
"nextOffset": 1,
"total": 2,
"entries": [
{
"start": "2016-07-23T00:00:00.000Z",
"end": "2016-07-23T11:50:00.000Z",
"id": "da55e5723374f99f91887d4f51256d5a.2",
"type": "encounter",
"position": {
"lat": 72.0866,
"lon": 8.0857
},
"regions": {
"mpa": [],
"eez": [],
"rfmo": ["NEAFC", "IWC", "NASCO", "NAMMCO", "ACAP", "ICES"],
"fao": ["27", "27.2.a.1", "27.2", "27.2.a"],
"majorFao": ["27"],
"eez12Nm": [],
"highSeas": ["63203"],
"mpaNoTakePartial": [],
"mpaNoTake": []
},
"boundingBox": [8.085723348900002, 72.0865557573, 8.085723348900002, 72.0865557573],
"distances": {
"startDistanceFromShoreKm": 426,
"endDistanceFromShoreKm": 426,
"startDistanceFromPortKm": 425.01421899999997,
"endDistanceFromPortKm": 425.01421899999997
},
"vessel": {
"id": "8c7304226-6c71-edbe-0b63-c246734b3c01",
"name": "FRIOFORWIN",
"ssvid": "210631000"
},
"encounter": {
"vessel": {
"id": "208659960-0142-40c1-339a-c816edcab44b",
"flag": "RUS",
"name": "FORPOST",
"type": "fishing",
"ssvid": "273355780"
},
"medianDistanceKilometers": 0.065,
"medianSpeedKnots": 0.5,
"type": "carrier-fishing",
"potentialRisk": false
}
}
]
}