The Fremby ProAPI gives you programmatic, read-only access to your fleet's telemetry and daily aggregates — the same data that powers Fremby dashboards and the Microsoft Power BI / Power Flow integrations.
Endpoints return JSON or CSV. Where an endpoint supports more than one format, select it
with the Accept header:
Accept: application/json → a JSON array of records.Accept: application/stream+json → the same records as a newline-delimited JSON stream,
friendlier for very large fleets.Accept: text/csv → a CSV download whose first row is the column header.Not every endpoint offers every format: some are JSON-only (e.g. the project listings) and
some are CSV-only (e.g. raw equipment telemetry). For endpoints that support CSV, a request
with no Accept header returns CSV.
All endpoints require a JWT Bearer token: Authorization: Bearer <token>.
To get a token your organization needs Fremby Insight. Create the token on the
organization's API keys page in the Fremby app, for example
https://app.fremby.no/acme/organization/api-keys for the organization acme.
Tokens are issued per organization. If you authenticate with a personal token that
spans more than one organization, also pass the orgID query parameter to select which
organization to read. With an organization-scoped token, orgID is not needed.
Identifiers are opaque strings, passed back unchanged:
equipmentProfileID / equipmentID: the id of a fleet row (/bi/v5/fleet) or of a
project's equipment (/v1/project/fleet). Both parameter names take the same identifier.
It is not the equipmentID field of a fleet row, which is the owner's own label.digitalEquipmentID: the digitalEquipmentID column of /bi/v1/equipment/telemetry.projectID: the id of a project (/v3/projects).locationID: the id column of /bi/v1/location/timeseries/dailysummarizedsnapshot,
which has one row per location with data in the range; pass fullRange=true to list
every location that has ever had data.workSiteID, shareContractID, shareConnectorID: not listed by any endpoint of this API.All timestamps are UTC, formatted as RFC 3339 / ISO 8601. Reports accept a
rangeStart and rangeEnd (both inclusive); when omitted, default to the last 7 days (project/fleet listings to all history).
Pass fullRange=true to ignore the range and return the entire available history.
Each report is versioned on its own in the path, for example /bi/v5/fleet,
/v3/projects and /bi/v6/timeseries/dailysnapshot. Always prefer the highest version
available for a given report; lower versions are kept for compatibility and are
marked deprecated.
carbonEmissionLast24 is the CO₂ emitted that day in kilograms, calculated from the
day's consumption: fuel used in liters × 2.62 kg/L plus energy used in kWh × 26 g/kWh.
Project reports use the project's own factors when the project has set them.
A failed request returns the matching 4xx/5xx status with an RFC 7807 problem
body (application/problem+json): {"type": …, "title": …, "status": …, "detail": …}.
Every equipment that has belonged to the fleet, with its current attributes.
Raw and per-sample measurement series for individual equipment and metrics.
Pre-aggregated daily values (last-24h and cumulative) per equipment, location, project or work site.
Project listings and project-scoped equipment reports.
Share-contract, work-site and connector reports for shared equipment.