sources

Get metada for Frost API sources.

Get metadata for the source entitites defined in the Frost API. Use the query parameters to filter the set of sources returned. Leave the query parameters blank to select all sources.

get/sources/v0.{format}

Request

  • Base URL: https://frost.met.no
  • URL: https://frost.met.no/sources/v0.{format}
  • Auth: none declared

Path parameters

format'jsonld' required

The output format of the result.

Query parameters

idsstring

The Frost API source ID(s) that you want metadata for. Enter a comma-separated list to select multiple sources. For sources of type SensorSystem or RegionDataset, the source ID must be of the form <prefix><int> where <prefix> is SN for SensorSystem and TR, NR, GR, or GF for RegionDataset. The integer following the prefix may contain wildcards, e.g. SN18*7* matches both SN18700 and SN18007.

types'SensorSystem' | 'InterpolatedDataset' | 'RegionDataset'

The type of Frost API source that you want metadata for.

elementsstring

If specified, only sources for which observations are available for all of these elements may be included in the result. Enter a comma-separated list of <a href=concepts2.html#searchfilter>search filters</a>.

geometrystring

Get Frost API sources defined by a specified geometry. Geometries are specified as either nearest(POINT(...)) or POLYGON(...) using <a href='https://en.wikipedia.org/wiki/Well-known_text'>WKT</a>; see the reference section on the <a href=concepts2.html#geometryspecification>Geometry Specification</a> for documentation and examples. If the nearest() function is specified, the output will include the distance in kilometers from the reference point.

nearestmaxcountstring

The maximum number of sources returned when using nearest(POINT(...)) for geometry. The default value is 1.

validtimestring

If specified, only sources that have been, or still are, valid/applicable during some part of this interval may be included in the result. Specify <date>/<date>, <date>/now, <date>, or now, where <date> is of the form YYYY-MM-DD, e.g. 2017-03-06. The default is 'now', i.e. only currently valid/applicable sources are included.

namestring

If specified, only sources whose 'name' attribute matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

countrystring

If specified, only sources whose 'country' or 'countryCode' attribute matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

countystring

If specified, only sources whose 'county' or 'countyId' attribute matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

municipalitystring

If specified, only sources whose 'municipality' or 'municipalityId' attribute matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

wmoidstring

If specified, only sources whose 'wmoId' attribute matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

stationholderstring

If specified, only sources whose 'stationHolders' attribute contains at least one name that matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

externalidsstring

If specified, only sources whose 'externalIds' attribute contains at least one value that matches any of the specified, comma-separated list of <a href=concepts2.html#searchfilter>search filters</a> may be included in the result.

icaocodestring

If specified, only sources whose 'icaoCodes' attribute contains at least one name that matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

shipcodestring

If specified, only sources whose 'shipCodes' attribute contains at least one name that matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

wigosidstring

If specified, only sources whose 'wigosId' attribute matches this <a href=concepts2.html#searchfilter>search filter</a> may be included in the result.

ontologyidstring

A comma-separated list of the ontologyids that should be present in the response. Default if not set is to include all.

fieldsstring

A comma-separated list of the fields that should be present in the response. If set, only those properties listed here will be visible in the result set; e.g.: name,country will show only those two entries in the result in addition to the id which is always shown.

Response

successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.