Stock assessment graphs

ICES Marine Data

Stock Assessment Graphs

The Standard graphs web services provide the ability to search and retrieve data from database by providing access to the data.

Each part of the web services is provided by a web service API, which defines the name, input to, and output from the service for a particular data request.

This page lists all the Standard graphs Web Service APIs with a description that includes the information provided by the API, the input needed to get data from the API, and the data that is returned by the API.

DEPRECATED: ICES also provides a Web Service Description Language (WSDL) document that fully describes the Standard graphs Web Service.
These webservices have now been replaced and will be phased out in the future.
Below, in the example sections, you can now find the links to the new web services.

R package interface to Stock Assessment Graphs database web services

If you use R you can install the R package that uses this web services to query standard graphs.
You can find the documentation about the R Package here .

The following web service APIs are provided:

Name

getListStocks(year)

Description

This API of the webservice returns the list of all the fishstocks found in the database.

Input

The year of the assessment.
If the year is 0 then it will return all the assessment years
If there are no matches, an empty result set will be returned.

Output

Returns the year of the assessment, the species , the fishstock name, the ecoregion and the assessmentKey of the fishstocks/assessment year.

Example

Example to get the list of all the stocks
Example to get the list of all the stocks in 2013
Example to get the list of all the stocks in 2013 that were modified after 2022/03/30

Name

getLatestStockAdviceList()

Description

This API of the webservice returns the list of all the active advices in the database.

Input

None

Output

Returns the year of the assessment, the species , the fishstock name and the assessmentKey of the fishstocks/assessment year.

Example

Example to get the list of the stocks

Name

getStockDownloadData(AssessmentKey)

Description

This API of the webservice returns the data of the specified stock

Input

The assessmentKey of the assessment
Example would be 7919 for Herring in Subareas I, II, V and Divisions IVa and XIVa in the assessment year of 2016.
If there are no matches, an empty result set will be returned.

Output

Returns the json of the table

Example

Example of the table of data for the specified stock

Name

getLandingsGraph(AssessmentKey)

Description

This API of the webservice returns the url to the actual version of landings graph given a key.

Input

The key of the assessment
Example would be 1786 for the Cod in Subarea IV (North Sea), Divison VIId (Eastern Channel) and IIIa West (Skagerrak) (cod-347d) in the assessment year of 2013.
If there are no matches, an empty result set will be returned.

Output

Returns a link for the graph specified (image).

Example

Example of the Landings for the Cod in the Subarea IV (North Sea), Divison VIId (Eastern Channel) and IIIa West (Skagerrak) (cod-347d) in the assessment year of 2013

Name

getRecruitmentGraph(AssessmentKey)

Description

This API of the webservice returns the url to the actual version of recruitment graph given a key.

Input

Output

Returns a link for the graph specified (image).

Example

Example of the Recruitment for Cod in Subarea IV (North Sea), Divison VIId (Eastern Channel) and IIIa West (Skagerrak) (hd-iris) in the assessment year of 2013

Name

getFishingMortalityGraph(AssessmentKey)

Description

This API of the webservice returns the url to the actual version of Fishing mortality graph given a key.

Input

Output

Returns a link for the graph specified (image).

Example

Example of the Fishing Mortality for the Cod in the Baltic Sea (cod-2532) in the assessment year of 2013

Name

getSpawningStockBiomassGraph(AssessmentKey)

Description

This API of the webservice returns the url to the actual version of Spawning Stock Biomass graph given a key.

Input

The key of the assessment
Example would be 1802 for the Hake in Division VIIIc and IXa (Southern stock) (hke-soth) in the assessment year of 2013.
If there are no matches, an empty result set will be returned.

Output

Returns a link for the graph specified (image).

Example

Example of the Spawning Stock Biomass for the Hake in Division VIIIc and IXa (Southern stock) (hke-soth) in the assessment year of 2013

Name

getstock_recruitment(AssessmentKey) - ????

Description

This API of the webservice returns the url to the actual version of stock - recruitment graph given a key.

Input

The key of the assessment
Example would be 1748 for the Haddock in Division VIb (Rockall) (had-rock) in the assessment year of 2013.
If there are no matches, an empty result set will be returned.

Output

Returns a link for the graph specified (image).

Example

Example of the stock - recruitment for the Haddock in Division VIb (Rockall) (had-rock) in the assessment year of 2013

Name

getYSSB(AssessmentKey) - ????

Description

This API of the webservice returns the url to the actual version of yield and spawning stock biomass per recruit graph given a key.

Input

The key of the assessment
Example would be 1807 for the Plaice Subarea IV (North Sea) (ple-nsea) in the assessment year of 2010.
If there are no matches, an empty result set will be returned.

Output

Returns a link for the graph specified (image).

Example

Example of the yield and spawning stock biomass per recruit graph for the Plaice Subarea IV (North Sea) (ple-nsea) in the assessment year of 2013

Name

getSSBHistoricalPerformance(AssessmentKey)

Description

This API of the webservice returns the url to the actual version of spawning stock biomass historical performance graph given a key.

Input

The key of the assessment
Example would be 1825 for the whiting in the North Sea (whg-47d) in the assessment year of 2013.
If there are no matches, an empty result set will be returned.

Output

Returns a link for the graph specified (image).

Example

Example of the spawning stock biomass historical performance graph for the whiting in the North Sea (whg-47d) in the assessment year of 2013

Name

getFishingMortalityHistoricalPerformance(AssessmentKey)

Description

This API of the webservice returns the url to the actual version of fishing mortality historical performance graph given a key.

Input

The key of the assessment
Example would be 1825 for the whiting in the North Sea (whg-47d) in the assessment year of 2013.
If there are no matches, an empty result set will be returned.

Output

Returns a link for the graph specified (image).

Example

Example of the fishing mortality historical performance graph for the whiting in the North Sea (whg-47d) in the assessment year of 2013

Name

getRecruitmentHistoricalPerformance(AssessmentKey)

Description

This API of the webservice returns the url to the actual version of recruitment historical performance graph given a key.

Input

The key of the assessment
Example would be 1825 for the whiting in the North Sea (whg-47d) in the assessment year of 2013.
If there are no matches, an empty result set will be returned.

Output

Returns a link for the graph specified (image).

Example

Example of the recruitment historical performance graph for the whiting in the North Sea (whg-47d) in the assessment year of 2013

Name

getSummaryTable(AssessmentKey)

Description

This API of the webservice returns the Summary table of the stock

Input

Output

Returns the json of the table

Example

Example for the Cod in Subarea IV (North Sea), Divison VIId (Eastern Channel) and IIIa West (Skagerrak) (cod-347d) in the assessment year of 2013

Name

getFishStockReferencePoints(AssessmentKey)

Description

This API of the webservice returns the reference points of the stock

Input

Output

Returns the json of the table

Example

Example of fish stock reference points for the Cod in Subarea IV (North Sea), Divison VIId (Eastern Channel) and IIIa West (Skagerrak) (cod-347d) in the assessment year of 2013

Name

getStockStatusTable(AssessmentKey)

Description

This API of the webservice returns the link to the image with the stock status table

Input

The key of the assessment
Example would be 7919 for Herring in Subareas I, II, V and Divisions IVa and XIVa in the assessment year of 2016.
If there are no matches, an empty image will be returned.

Output

Returns the link for the image

Example

Example of the Stock Status table

Name

getStockStatusValues(AssessmentKey)

Description

This API of the webservice returns the reference points of the stock

Input

The key of the assessment
Example would be 7919 for Herring in Subareas I, II, V and Divisions IVa and XIVa in the assessment year of 2016.
If there are no matches, an empty result set will be returned.

Output

Returns the json of the table

Example

Example of the Stock Status values