Skip to main content
Version: 2023-01-01

Getting started with Cloud API

Our APIs provide a single, reliable source of data for feeding operations, biomass monitoring, environmental conditions, and other key metrics. This centralized approach makes it easier to integrate, analyze, and use data for better decision-making and efficiency.

Whether you're building dashboards, integrating with other systems, or automating workflows, our Cloud APIs give you the tools to access and interact with your data seamlessly.

Start using Cloud API​

This guide outlines the basic steps to authenticate and make your first API request.

Step 1: Get API access​

To access our APIs, you'll need a username and password. Contact support.digital@scaleaq.com to request your credentials.

Use your credentials to obtain an access token. This token is required for all subsequent API requests.

See Authentication for more details.

Step 2: Making a request to the API​

With the access token, you can now call any of our endpoints. Add the token to the Authorization header of your request.

Request example

curl --location 'https://api.scaleaq.com/meta/sites/1234?$include=units,info' \
--header 'Scale-Version: 2023-01-01' \
--header 'Authorization: Bearer <access_token>'

Step 3: Using the response​

After you make a request, the API will return the response status code, response headers, and potentially a response body.

Response example

{
    "siteId": 1234,
    "siteName": "Blue",
    "info": {
        "longitude": 5.756946,
        "latitude": 59.315366,
        "type": "Seafarm",
        "code": "BLU",
        "license": "XXXX",
        "maxTotalBiomass": 5000,
        "timezone": "Europe/Oslo"
    },
    "units": [
        {
            "unitId": 5678,
            "unitName": "SV01",
            "longitude": 5.756946,
            "latitude": 59.315366
        },
        {
            ...
        }
    ]
}

Use this data on your side the way you need.

Step 4: Next steps​

Now you know how to get information about your site.

For more information about other endpoints that you can use, see the rest of the documentation.