Inventory
The inventory endpoints provide benchmarking between AquaCloud reported biomass and official Fiskeridirektoratet figures. Routes live under /v3/inventory, are read-only GET endpoints, and reuse the v3 authentication scheme: send Authorization: Bearer <token> plus x-client-secret for non-premium farmer tiers. Empty datasets respond with 204 No Content.
Common query parameters
| Name | Type | Default | Details |
|---|---|---|---|
from_date | date | Today − 12 months | Flexible parsing (ISO 2024-03-31, 31/03/2024, mai 2024, week 13 2024, today, etc.). Partial inputs resolve to the start of the period. |
to_date | date | Today | Same parsing rules; partial inputs resolve to the end of the period. |
offset | integer ≥ 0 | 0 | Number of rows to skip. |
limit | integer (0–1000) | 1000 | Maximum number of rows returned; the service reads limit + 1 to set pagination.has_more. |
Response envelope
All endpoints return a JSON object with:
data: List of biomass comparison records.pagination: Includesoffset,limit, andhas_morewhen more data is available.metadata: Present in the schema for consistency with other v3 responses (empty for this route).
Endpoints
GET /v3/inventory/aquacloud-fiskeridirektoratet-biomass-by-month
Compares monthly biomass totals between AquaCloud reports and Fiskeridirektoratet data.
| Field | Type | Description |
|---|---|---|
month | string (ISO month date) | Month represented by the record. |
production_area_id | integer | Production area identifier, when available. |
production_region_name | string | Region label tied to the production area. |
aquacloud_biomass_in_tons | number | AquaCloud-reported biomass (tons) for the month. |
fiskeridirektoratet_biomass_in_tons | number | Official biomass (tons) from Fiskeridirektoratet. |
aquacloud_biomass_coverage | number | Coverage ratio between the two sources. |
Use this endpoint to monitor reporting alignment and identify coverage gaps across months or regions.
Example request
GET /v3/inventory/aquacloud-fiskeridirektoratet-biomass-by-month?from_date=2023-01-01&to_date=2024-01-31&limit=500 HTTP/1.1
Host: api.aquacloud.io
Authorization: Bearer <token>
x-client-secret: <client-secret>
The response includes the comparison rows in data alongside pagination metadata so you can continue paging through historical records.