Ir al contenido
Floweet
Acceso pro

Conventions: requests, responses, units

camelCase JSON, prices in thousandths of a euro per liter, amounts in cents, ISO 8601 dates, HTTP statuses, response headers and data sources.

api.floweet.com/v1 · Contract 1.0.0-beta.1 · Beta

This documentation is written in English and French; it is shown to you in English.

Sections · Conventions

A JSON REST API, at https://api.floweet.com/v1. These rules apply to every operation; each resource's reference recalls them where useful.

Request and response format

  • JSON only: send Content-Type: application/json with a body.
  • Fields in camelCase; identifiers are UUIDs (an establishment, its 14-digit SIRET); instants in ISO 8601, in UTC. A missing value is null, an empty list []: the fields of a response object are always present.
  • A resource is returned as is; a list as { "data": [...], "nextCursor": "…", "hasMore": true }; a search as { "results": [...] } (see pagination).

Units

QuantityUnitExample
Fuel priceInteger, thousandths of a euro per liter2252 = 2.252 €/L
Amounts (overspend, savings, ETS2)Integer, euro cents1013800 = €10,138
Distances, durationsKilometers, minutesdistanceKm, durationMin
CoordinatesDecimal degrees (WGS 84){ "lat": 45.7485, "lng": 4.8467 }
CO2Tonnes a yearco2Tonnes

Success statuses

StatusWhenBody
200 OKRead, computation, updateThe object, a page or results
201 CreatedCreation (prospect, simulation)The created object, and the Location header
200 OKDeletion{ "ok": true }

Be tolerant

New fields, new enum values (a status, a brand, a vehicle type) and new error codes may appear without notice in /v1. Ignore the fields you do not know and treat an unknown value as a generic case. See versioning.

Headers

HeaderDirectionRole
AuthorizationrequestBearer fw_live_… or fw_test_… (authentication)
Idempotency-KeyrequestOne UUID per POST operation, reused on every retry (idempotency)
Accept-LanguagerequestLanguage of error messages: en, fr, es, it, de, pt; French without it
X-Request-IdbothYour identifier, echoed back (generated otherwise); quote it when you contact us
Floweet-VersionresponseVersion of the contract that served the request (versioning)
Floweet-Environmentresponsetest or live: the key's environment
LocationresponsePath of the resource created by a 201
RateLimit-Limit, RateLimit-Remaining, RateLimit-ResetresponseYour current limit window (rate limits)
Retry-AfterresponseSeconds to wait, on 429
Idempotent-Replayedresponsetrue when the response replays an earlier one

Sources and reuse

DataSourceLicence
Fuel prices and stationsprix-carburants.gouv.frLicence Ouverte 2.0
EV charging stationsIRVE consolidated file (data.gouv.fr)Licence Ouverte 2.0
CompaniesSIRENE directory (Insee)Licence Ouverte 2.0
Addresses (France)Base Adresse NationaleLicence Ouverte 2.0
Addresses and routes (elsewhere)OpenStreetMapODbL

Any public reuse must credit these sources. A price counts if it is less than 7 days old. A company's fleet is an estimate (NAF sector × headcount band), never actual data. Every call is written to a usage log (route, status, duration; neither IP address nor content), kept 12 months.