API v3Events
Get one Event ID
Get one event by ID: apparent fishing, encounters between vessel types, loitering, port visits and AIS gaps.
Example: Get a port vist event by ID
curl --location --request GET 'https://gateway.api.globalfishingwatch.org/v3/events/c2f0967e061f99a01793edac065de003?dataset=public-global-port-visits-events:latest' \
-H "Authorization: Bearer [TOKEN]"result = await gfw_client.events.get_event_by_id(
id="c2f0967e061f99a01793edac065de003",
dataset="public-global-port-visits-events:latest",
)// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
'https://gateway.api.globalfishingwatch.org/v3/events/c2f0967e061f99a01793edac065de003?dataset=public-global-port-visits-events:latest',
{ headers: { Authorization: 'Bearer [TOKEN]' } }
)
const data = await res.json()Make sure to replace [TOKEN] with your API Access Token. If the request is successful, the response will be:
{
"start": "2020-01-26T05:52:47.000Z",
"end": "2020-01-29T14:39:33.000Z",
"id": "c2f0967e061f99a01793edac065de003",
"type": "port_visit",
"position": {
"lat": 20.8374,
"lon": -17.0161
},
"regions": {
"mpa": [],
"eez": ["8369"],
"rfmo": ["IWC", "NAMMCO", "ACAP", "ICCAT", "SRFC"],
"fao": ["34.1", "34.1.32", "34.1.3", "34"],
"majorFao": ["34"],
"eez12Nm": [],
"highSeas": [],
"mpaNoTakePartial": [],
"mpaNoTake": []
},
"boundingBox": [-17.0147743934, 20.7287971969, -17.0301185356, 20.8284907611],
"distances": {
"startDistanceFromShoreKm": 7,
"endDistanceFromShoreKm": 2,
"startDistanceFromPortKm": 0,
"endDistanceFromPortKm": 0
},
"vessel": {
"id": "8c7304226-6c71-edbe-0b63-c246734b3c01",
"name": "FRIOFORWIN",
"ssvid": "210631000"
},
"port_visit": {
"visitId": "54a297966f51994d8bad91ba58945f8c",
"confidence": 4,
"durationHrs": 80.77944444444445,
"startAnchorage": {
"anchorageId": "0ea1bbe7",
"atDock": false,
"distanceFromShoreKm": 7,
"flag": "MRT",
"id": "mrt-cansado",
"lat": 20.72879719687954,
"lon": -17.014774393446658,
"name": "CANSADO",
"topDestination": "NOUADHIBOU"
},
"intermediateAnchorage": {
"anchorageId": "0ea1b6ad",
"atDock": false,
"distanceFromShoreKm": 4,
"flag": "MRT",
"id": "mrt-nouadhibou",
"lat": 20.885489104200627,
"lon": -17.003218026679036,
"name": "NOUADHIBOU",
"topDestination": "NOUADHIBOU"
},
"endAnchorage": {
"anchorageId": "0ea1b0c3",
"atDock": true,
"distanceFromShoreKm": 2,
"flag": "MRT",
"id": "mrt-cansado",
"lat": 20.828490761089796,
"lon": -17.030118535609358,
"name": "CANSADO",
"topDestination": "NOUADHIBOU"
}
}
}Get by event id - Specifications
Authorization
ApiKeyAuth AuthorizationBearer <token>
In: header
Path Parameters
eventId*string
Query Parameters
dataset*string
Specify the dataset that will be used to search the vessel. You can learn more about which are the possible datasets here.
raw?boolean
curl -X GET "https://example.com/api/v3/events/string?dataset=public-global-fishing-events%3Alatest"{ "boundingBox": [ "-26.6544916667", "-27.4231866667", "-58.2073683333", "-58.7976633333" ], "distances": { "endDistanceFromPortKm": "0.0", "endDistanceFromShoreKm": "0.0", "startDistanceFromPortKm": "0.0", "startDistanceFromShoreKm": "0.0" }, "end": "2015-01-04T02:20:00.000Z", "id": "a6e00481737d3e2c9903e1f565c51143", "position": { "lat": "125.2089", "lon": "12.14587" }, "regions": { "eez": [], "eez12Nm": [], "fao": [], "highSeas": [], "majorFao": [], "mpa": [], "mpaNoTake": [], "mpaNoTakePartial": [], "rfmo": [] }, "start": "2015-01-02T23:50:00.000Z", "type": "loitering", "vessel": { "flag": "ESP", "id": "a6e00481737d3e2c9903e1f565c51143", "name": "Don tito", "nextPort": {}, "publicAuthorizations": "12345789", "ssvid": "12345789", "type": "FSIHING" }}{ "error": "Unauthorized", "messages": [ { "detail": "No authorized", "metadata": {}, "title": "Unauthorized" } ], "statusCode": 401}{ "error": "Forbidden", "messages": [ { "detail": "You do not have permissions to do the action", "metadata": {}, "title": "Forbidden" } ], "statusCode": 403}{ "error": "Not Found", "messages": [ { "detail": "[resource] not found", "metadata": {}, "title": "Not Found" } ], "statusCode": 404}{ "error": "Unprocessable Entity", "messages": [ { "detail": "Validation exception", "metadata": {}, "title": "Unprocessable Entity" } ], "statusCode": 422}{ "error": "Service Unavailable", "messages": [ { "detail": "Service unavailable", "metadata": {}, "title": "Service Unavailable" } ], "statusCode": 503}