Skip to main content

Areas

Aquacloud has a special areas endpoint accessible at v3/areas which returns a list of areas, which are an aggregation level to use when querying data. We have larger areas such as South, Midand North as well as the individual production areas. Note that some production areas are not possible to query separately due to the minimum number of farmers needed in each production area to uphold anonymity. In that case we give the option to query on a group of areas such as PO12 and PO13 which are not queryable separately.

Querying an endpoint filtering by an area​

To query an endpoint and only getting results for a particular area first query the endpoint like this:

curl -X GET "https://api.aquacloud.ai/v3/common/aquacloud-areas" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."

Which returns a json like this

{
  "data": [
    {
      "area_id": "recJU...",
      "name": "Sør",
      "name_english": "Southern Norway",
      "production_area_ids": [1, 2, 3, 4]
    },
    {
      "area_id": "recfAQ...",
      "name": "PO 2 & 3",
      "name_english": "PO 2 & 3",
      "production_area_ids": [2, 3]
    }
  ]
}

Then you can query an endpoint such as:

curl -X 'GET' \
  'https://api.aquacloud.ai/v3/environment/temperature-by-week-and-region?areas=recJUWzZe9K6v8ZlY' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...'

Note: you can now also query on the areas with their common names like:

curl -X 'GET' \
  'https://api.aquacloud.ai/v3/environment/temperature-by-week-and-region?areas=midt,sor,PO 2 & 3' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...'