Web services
The ICES web services (APIs) called by the packages. Every day each endpoint is called with example values, and the structure of the response (the names of the fields, their types, and the format of text values such as dates) is compared with a recorded baseline. This finds changes that can break the packages, such as a field renamed from AssessmentKey to assessmentKey, a field removed, or a number returned as text. Where the API has machine-readable documentation, changes to the documented operations and their parameters are also found, and the R functions for each operation are listed, with suggestions for operations that have none. Checked 21 November 2026, 13:18 UTC.
| API | Status | Endpoints | Median time (s) | R functions | Documentation | Used by |
|---|---|---|---|---|---|---|
| Advice and Scenarios Database (ASD) | No changes | 8: 8 unchanged, 0 changed, 0 with errors | 0.135 | 4 of 6 operations | 8 operations | icesASD, icesAdviceSheet |
| DATRAS trawl surveys | Changes found | 15: 13 unchanged, 2 changed, 0 with errors | 0.220 | 15 of 23 operations | 25 operations | icesDatras |
| Stock Assessment Graphs (SAG) | No changes | 10: 10 unchanged, 0 changed, 0 with errors | 0.320 | 10 of 20 operations | 23 operations | icesSAG, buseful, fisheriesXplorer, fisheryO, icesAdviceSheet, icesASD, icesConsistenSEA, icesFO, icesTAF, icesTAFextra, icesUtils |
| VMS and Logbook Database | Errors | 18: 6 unchanged, 1 changed, 10 with errors | 0.715 | 14 of 18 operations | Yes | icesVMS |
| ICES Vocabularies | No changes | 7: 7 unchanged, 0 changed, 0 with errors | 0.140 | 4 of 6 operations | 6 operations | icesVocab, buseful, fisheriesXplorer, icesDatsuQC, icesTAF, icesTAFextra, icesUtils, icesVMS |
Adding an API or endpoint
Each web service has a folder in apis/, with a config.json that lists its endpoints, its documentation, and notes shown on its page. For each endpoint, give a path with example query values that return a stable result, such as a published assessment. Endpoints that need an ICES login are marked "auth": true, and are only checked when an ICES token is available.
Accepting a change
When a change is expected, for example after the package has been updated to use the new field names, record a new baseline:
Rscript scripts/check_apis.R --update-baselineand commit the baseline.json files in apis/.