Skip to main content

VMS and Logbook Database

VMS and logbook data, data call summaries, fisheries overview and WGFBIT products, c-squares and gear lookup tables, from the ICES VMS and Logbook Database.

Base url: https://data.ices.dk/vms/api · Documentation · Website

Checked 21 November 2026, 13:18 UTC. Responses are compared with the baseline recorded on 2026-10-21.

Important10 of 18 endpoints return errors
  • fisheriesoverviews/fishingactivity: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • fisheriesoverviews/effortmap: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • fisheriesoverviews/effort: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • fisheriesoverviews/landings: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • footprint/passive: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • wgfbit/dataset1: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • wgfbit/dataset2: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • wgfbit/dataset3: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • GetVMSData: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • GetLogbookData: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

Endpoints that need a login are checked with an ICES token that expires on 2026-11-12.

Used by

Directly: icesVMS

Through a dependency: none

Notes

Topic Observation Affects
Login Most endpoints need an ICES token: VMS and logbook data, effort and landings summaries, the effort map, the passive gear footprint, and WGFBIT datasets 1 and 2. Without a valid token they return HTTP 401, except GetLogbookData, which returns 400. gearwidths, MetierLookup, csquares, vmssummary and the SAR map are open, and so is wgfbit/dataset3, although datasets 1 and 2 are not. These endpoints are checked only when a token is available (the ICES_TOKEN environment variable, or the token stored by icesConnect); otherwise they are shown as not checked. icesVMS sends a token for vmssummary, the SAR map and wgfbit/dataset3 too, although they do not need one.
Documentation The operations are listed on an HTML page, with no machine-readable description (no OpenAPI), so the operations and parameters are not checked. The paths in the documentation mix case (API/GearWidths, api/gearwidths); the service ignores case. Nothing at present.
Effort summaries The documentation lists FisheriesOverviews/effort/{EcoRegion}, kW fishing hours by country, year and gear category. get_fo_effort(), documented as returning kW fishing hours by country and year, calls fisheriesoverviews/effortmap/{ecoregion} instead, which is the effort map by c-square (about 24 MB for the Celtic Seas). get_fo_effort() returns the effort map rather than the effort summary, and no function calls fisheriesoverviews/effort.
WGFBIT filters wgfbit/dataset1 and wgfbit/dataset3 accept fishing_category or benthis_metier, but return HTTP 400 when both are given (e.g. wgfbit/dataset3/2020?fishing_category=Dredge&benthis_metier=DRB_MOL). get_wgfbit_data1() and get_wgfbit_data3() return NULL, with a message, when both fishing_category and benthis_metier are given.
Swept area ratio by metier getSARBy_YearAndMetier4_GeoJSON/{Year}/{Metier4} returns HTTP 500, including for the example in the documentation (2022/OTT); getSARBy_YearAndMetier4_Shapefile returns a zip file. FisheriesOverviews/fishingactivity/{EcoRegion} also returns HTTP 500. get_sar() is deprecated and points users to the GeoJSON endpoint, which does not work.
Size of responses VMS and logbook data are returned for a whole country and year, and month, gear and metier are filtered in R: GetVMSData/DK?year=2021 is about 180 MB. wgfbit/dataset3/{year} without filters is about 200 MB. get_vms() and get_wgfbit_data3() can be slow and use a lot of memory.
Empty results An ecoregion or year with no data returns HTTP 200 with [] (e.g. fisheriesoverviews/sarmap/Azores?year=2020). An unknown screening session returns HTTP 204 with no content from getScreeningDetails, and [] from getScreeningSessionMessages; these two are not checked here, as they need a session of the user’s own. Functions return empty results rather than an error for a wrong ecoregion or year.
Screening files ScreenVMSFile (POST, a file upload) screens a VMS or logbook file, and SendFileToQC/{ID} sends a screened file on. They change data and are not called by this check. screen_vms_file() is not checked.

Endpoints checked

Endpoint Status HTTP Time (s) Size (kB) Records Fields
gearwidths No changes 200 0.68 3.6 14 14
MetierLookup No changes 200 0.75 717.5 2316 14
csquares, by rectangle No changes 200 0.19 46.9 198 11
vmssummary No changes 200 0.55 21.6 279 6
vmssummary, by data call No changes 200 0.48 21.6 279 6
fisheriesoverviews/sarmap Changed 200 2.91 341.9 1142 11
getSARBy_YearAndMetier4_GeoJSON No baseline 200 27.56 9593.4 1 18
getSARBy_YearAndMetier4_Shapefile No changes 200 23.18 1196.1 0 4
fisheriesoverviews/fishingactivity Error 0
fisheriesoverviews/effortmap Error 0
fisheriesoverviews/effort Error 0
fisheriesoverviews/landings Error 0
footprint/passive Error 0
wgfbit/dataset1 Error 0
wgfbit/dataset2 Error 0
wgfbit/dataset3 Error 0
GetVMSData Error 0
GetLogbookData Error 0

Changes since the baseline

  • fisheriesoverviews/fishingactivity: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • fisheriesoverviews/effortmap: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • fisheriesoverviews/effort: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • fisheriesoverviews/landings: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • footprint/passive: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • wgfbit/dataset1: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • wgfbit/dataset2: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • wgfbit/dataset3: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • GetVMSData: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • GetLogbookData: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret
  • fisheriesoverviews/sarmap: Field ‘[].stat_rec’ changed type from string | string (number) to string

Documented operations

No machine-readable documentation, so changes to the operations and parameters are not checked.

R functions

The packages are designed with one R function for each endpoint, and further functions that combine endpoints into a dataset. Functions are found by reading the code of icesVMS. 14 of the 18 operations that read data have an R function; a function name is suggested for the others.

Operations and R functions

Operation R function Also used in
GET /vms/api/gearwidths (not documented) get_benthis_parameters()
GET /vms/api/MetierLookup (not documented) get_metier_lookup()
GET /vms/api/csquares (not documented) get_csquare()
GET /vms/api/vmssummary (not documented) get_upload_summary()
GET /vms/api/vmssummary/{datacall} (not documented) get_upload_summary()
GET /vms/api/fisheriesoverviews/sarmap/{ecoregion} (not documented) get_sar_map()
GET /vms/api/getSARBy_YearAndMetier4_GeoJSON/{year}/{metier4} (not documented) missing: suggest getSARBy_YearAndMetier4_GeoJSON()
GET /vms/api/getSARBy_YearAndMetier4_Shapefile/{year}/{metier4} (not documented) missing: suggest getSARBy_YearAndMetier4_Shapefile()
GET /vms/api/fisheriesoverviews/fishingactivity/{ecoregion} (not documented) missing: suggest getFisheriesoverviewsfishingactivity()
GET /vms/api/fisheriesoverviews/effortmap/{ecoregion} (not documented) get_effort_map(), get_fo_effort()
GET /vms/api/fisheriesoverviews/effort/{ecoregion} (not documented) missing: suggest getFisheriesoverviewseffort()
GET /vms/api/fisheriesoverviews/landings/{ecoregion} (not documented) get_fo_landings()
GET /vms/api/footprint/passive/{ecoregion}/{year} (not documented) get_passive_footprint()
GET /vms/api/wgfbit/dataset1/{ecoregion}/{year} (not documented) get_wgfbit_data1()
GET /vms/api/wgfbit/dataset2/{ecoregion}/{year} (not documented) get_wgfbit_data2()
GET /vms/api/wgfbit/dataset3/{year} (not documented) get_wgfbit_data3()
GET /vms/api/GetVMSData/{country} (not documented) get_vms()
GET /vms/api/GetLogbookData/{country} (not documented) get_logbook()

Combined functions

None.

Endpoint details

gearwidths

https://data.ices.dk/vms/api/gearwidths

Called by: get_benthis_parameters()

Operation: GET /vms/api/gearwidths

HTTP 200 · application/json · 0.68 s · 14 records

Field Type
(root) array
[] object
[].avFspeed string (number)
[].avKw string (number)
[].avLoa string (number)
[].benthisMet string
[].contactModel string
[].firstFactor number
[].gearCoefficient string
[].gearModel string
[].gearWidth number
[].id number
[].secondFactor number
[].subsurfaceProp string (number)

MetierLookup

https://data.ices.dk/vms/api/MetierLookup

Called by: get_metier_lookup()

Operation: GET /vms/api/MetierLookup

HTTP 200 · application/json · 0.75 s · 2316 records

Field Type
(root) array
[] object
[].benthisMetiers null | string
[].benthisMetiers2016Wrong null | string
[].description string
[].ecomarClassification null | string
[].fishingCategory string
[].fishingCategoryFo string
[].fishingHours null
[].id number
[].jnccGrouping null | string
[].leMetLevel6 string
[].metierLevel4 string
[].metierLevel5 string

csquares, by rectangle

https://data.ices.dk/vms/api/csquares?stat_rec=40F1

Called by: get_csquare()

Operation: GET /vms/api/csquares

HTTP 200 · application/json · 0.19 s · 198 records

Field Type
(root) array
[] object
[].c_square string
[].csquare_area number
[].ecoregion string
[].ices_area string
[].id number
[].lat number
[].lon number
[].stat_rec string
[].wkt string

vmssummary

https://data.ices.dk/vms/api/vmssummary

Called by: get_upload_summary()

Operation: GET /vms/api/vmssummary

HTTP 200 · application/json · 0.55 s · 279 records

Field Type
(root) array
[] object
[].country string
[].lastUpdate string (date-time)
[].noRecs number
[].year number

vmssummary, by data call

https://data.ices.dk/vms/api/vmssummary/2024

Called by: get_upload_summary()

Operation: GET /vms/api/vmssummary/{datacall}

HTTP 200 · application/json · 0.48 s · 279 records

Field Type
(root) array
[] object
[].country string
[].lastUpdate string (date-time)
[].noRecs number
[].year number

fisheriesoverviews/sarmap

https://data.ices.dk/vms/api/fisheriesoverviews/sarmap/Oceanic%20Northeast%20Atlantic?year=2020

Called by: get_sar_map()

Operation: GET /vms/api/fisheriesoverviews/sarmap/{ecoregion}

HTTP 200 · application/json · 2.91 s · 1142 records

Field Type
(root) array
[] object
[].c_square string
[].csquare_area number
[].ecoregion string
[].lat number
[].lon number
[].stat_rec string
[].subsurface_sar number
[].surface_sar number
[].wkt string

getSARBy_YearAndMetier4_GeoJSON

https://data.ices.dk/vms/api/getSARBy_YearAndMetier4_GeoJSON/2022/OTT

Operation: GET /vms/api/getSARBy_YearAndMetier4_GeoJSON/{year}/{metier4}

HTTP 200 · application/geo+json · 27.56 s · 1 records

Field Type
(root) object
features array
features[] object
features[].geometry object
features[].geometry.coordinates array
features[].geometry.coordinates[] array
features[].geometry.coordinates[][] array
features[].geometry.coordinates[][][] number
features[].geometry.type string
features[].properties object
features[].properties.c_square string
features[].properties.fishing_hours number
features[].properties.Metier4 string
features[].properties.SubSurFaceSweptArea number
features[].properties.Surface_SweptAreaRatio number
features[].properties.year number
features[].type string
type string

getSARBy_YearAndMetier4_Shapefile

https://data.ices.dk/vms/api/getSARBy_YearAndMetier4_Shapefile/2022/OTT

Operation: GET /vms/api/getSARBy_YearAndMetier4_Shapefile/{year}/{metier4}

HTTP 200 · application/zip · 23.18 s · 0 records

Field Type
(root) zip
VMS_FishingHours_Year_#_Methier#_OTT.dbf file
VMS_FishingHours_Year_#_Methier#_OTT.shp file
VMS_FishingHours_Year_#_Methier#_OTT.shx file

fisheriesoverviews/fishingactivity

https://data.ices.dk/vms/api/fisheriesoverviews/fishingactivity/Azores

Operation: GET /vms/api/fisheriesoverviews/fishingactivity/{ecoregion}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

fisheriesoverviews/effortmap

https://data.ices.dk/vms/api/fisheriesoverviews/effortmap/Azores?year=2020

Called by: get_effort_map(), get_fo_effort()

Operation: GET /vms/api/fisheriesoverviews/effortmap/{ecoregion}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

fisheriesoverviews/effort

https://data.ices.dk/vms/api/fisheriesoverviews/effort/Azores

Operation: GET /vms/api/fisheriesoverviews/effort/{ecoregion}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

fisheriesoverviews/landings

https://data.ices.dk/vms/api/fisheriesoverviews/landings/Azores

Called by: get_fo_landings()

Operation: GET /vms/api/fisheriesoverviews/landings/{ecoregion}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

footprint/passive

https://data.ices.dk/vms/api/footprint/passive/Baltic%20Sea/2020

Called by: get_passive_footprint()

Operation: GET /vms/api/footprint/passive/{ecoregion}/{year}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

wgfbit/dataset1

https://data.ices.dk/vms/api/wgfbit/dataset1/Norwegian%20Sea/2020?benthis_metier=OT_DMF

Called by: get_wgfbit_data1()

Operation: GET /vms/api/wgfbit/dataset1/{ecoregion}/{year}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

wgfbit/dataset2

https://data.ices.dk/vms/api/wgfbit/dataset2/Norwegian%20Sea/2020

Called by: get_wgfbit_data2()

Operation: GET /vms/api/wgfbit/dataset2/{ecoregion}/{year}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

wgfbit/dataset3

https://data.ices.dk/vms/api/wgfbit/dataset3/2020?benthis_metier=TBB_MOL

Called by: get_wgfbit_data3()

Operation: GET /vms/api/wgfbit/dataset3/{year}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

GetVMSData

https://data.ices.dk/vms/api/GetVMSData/LV?year=2021

Called by: get_vms()

Operation: GET /vms/api/GetVMSData/{country}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret

GetLogbookData

https://data.ices.dk/vms/api/GetLogbookData/EE?year=2021

Called by: get_logbook()

Operation: GET /vms/api/GetLogbookData/{country}

Needs an ICES login.

Error: the ICES token expired on 2026-11-12. Update the ICES_TOKEN repository secret