This API provides functionality for Charge Point Operators (CPOs) to send home charging activity to AllStar.
\n\n\nYou must have \"Client Credentials\" issued to you to be able to start using this API.
\n
Please get in touch if you do not have this information.
Use dataProvider.chargePoint.findMany.v2 endpoint to list Charge Points registered with our system
This is scoped to return only your Charge Points
\nWe recommend using this endpoint regularly to ensure you have picked up any recently onboarded chargers, for example either:
\nCall the endpoint once every time you intend to push charge session data
\nCall the endpoint on a frequent schedule (e.g. every 30 mins - 1 hour)
\nUse dataProvider.charges.addWithIntervals endpoint to send charge session data
This endpoint allows for granular charge data segmented into 30 minute intervals - our preferred method
\nIf interval data is unavailable you may use the dataProvider.charges.add endpoint to send charge sessions with only a start/stop time. However this affects our ability to properly price customer charges, so this endpoint is only to be used in the absence of interval data.
(Optional) Use dataProvider.charges.findMany endpoint to list charges we have sucessfully received between a given set of dates.
You may find this endpoint useful for:
\nChecking if there are gaps in the charge session data we hold for a user
\nProviding a \"Synced with AllStar\" status to your App users
\nOAuth 2.0 authentication with the client_credentials grant type is used to authenticate with the API.
An example request can be seen below
\nPOST https://login.chargepass.co.uk/oauth2/ausa4dehw4Wb8CLSd417/v1/token
grant_type: \"client_credentials\"\nscope: \"chargepass.homecharge.charge.write\"\nclient_id: \"CLIENT_ID\"\nclient_secret: \"CLIENT_SECRET\"\n\nClient ID: Your new client ID (The username of your shared credentials)
\nClient Secret: Your new client secret (The password of your shared credentials)
\nAccess Token URL: https://login.chargepass.co.uk/oauth2/ausa4dehw4Wb8CLSd417/v1/token
Scope: chargepass.homecharge.charge.write
\n\nNote:
\n
Token lifetime is 1 hour, after which time a fresh token will need to be requested
When sending us charges, you can use the status value for each charge on the response to understand whether the charge has been successfully received.
The possible status values are:
\nSuccess - You can be assured that we've received and stored the charge
Duplicate - We recognise the charge as one you have sent previously (based on the chargeExternalId and chargePointExternalId values). The charge will be ignored and will not be persisted
If a 400 Bad Request is returned, the whole request will be rejected by our validation rules. In this case, none of the charges on the request will be ingested in our system.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27848775","collectionId":"f3987b4f-2d97-479e-ade1-3a3f8db16d0b","publishedId":"2sA3rwLDeo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"666666","highlight":"f2d400"},"publishDate":"2026-07-09T13:07:15.000Z"},"item":[{"name":"dataProvider.chargePoint.findMany.v2","id":"034eabe5-21e6-4dd9-9b68-4c1323ea8b08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.mina.co.uk/dataProvider.chargePoint.findMany.v2?since=2024-01-01T00:00:00.000Z","description":"Outcome:
Retrieves a list of chargers registered in our system
Purpose:
Enables you to identify which charge points you need to send data for.
Charge points are identified by externalId
The purpose of externalId is for you to be able to identify the charge point in your own system
In most cases externalId is the charge point serial number
You will also receive a startsOn and endsOn timestamp. This represents the valid subscription period of this charger on our system and generally speaking you should only send charges which occur between these dates (or after the startsOn date if endsOn is null)
You will also receive the current isActive status of each charge point, which indicates whether it is currently onboarded/offboarded on our system
\n\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"Note regarding charge point onboarding:
\n
The process of onboarding new charge points onto our system is undertaken directly between fleets and Allstar, there is no provision for onboarding within this API.
The datetime (ISO 8601) when to find chargers from.
\n","type":"text/plain"},"key":"since","value":"2024-01-01T00:00:00.000Z"}],"variable":[]}},"response":[{"id":"61603ec9-b115-4522-ab4a-442b8e5c4229","name":"Active Charger (200 OK)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.mina.co.uk/dataProvider.chargePoint.findMany?since=2024-01-01T00:00:00.000Z","host":["https://api.mina.co.uk"],"path":["dataProvider.chargePoint.findMany"],"query":[{"key":"since","value":"2024-01-01T00:00:00.000Z","description":"The datetime (ISO 8601) when to find chargers from."}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"externalId\": \"test.evseId1\",\n \"creationTimestamp\": \"2023-01-01T00:00:00+00:00\",\n \"startsOn\": \"2026-06-30T12:00:00+00:00\",\n \"endsOn\": null,\n \"isActive\": true\n }\n ]\n}"},{"id":"7c7aca6e-bd53-437d-bd6b-16900a9e0d58","name":"Inactive Charger (200) OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.mina.co.uk/dataProvider.chargePoint.findMany?since=2024-01-01T00:00:00.000Z","host":["https://api.mina.co.uk"],"path":["dataProvider.chargePoint.findMany"],"query":[{"key":"since","value":"2024-01-01T00:00:00.000Z","description":"The datetime (ISO 8601) when to find chargers from."}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"externalId\": \"test.evseId1\",\n \"creationTimestamp\": \"2023-01-01T00:00:00+00:00\",\n \"startsOn\": \"2026-06-30T12:00:00+00:00\",\n \"endsOn\": \"2026-07-04T12:00:00+00:00\",\n \"isActive\": false\n }\n ]\n}"}],"_postman_id":"034eabe5-21e6-4dd9-9b68-4c1323ea8b08"},{"name":"dataProvider.chargePoint.findMany","id":"499fcd5c-e043-4c0d-80c7-6a3ab42ccd76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.mina.co.uk/dataProvider.chargePoint.findMany?since=2024-01-01T00:00:00.000Z","description":"\n\nWe recommend using our v2 endpoint - it provides more detail on the charge points registered on our system, including explicit status and timestamps for onboarding / offboarding.
\n
Outcome:
Retrieves a list of chargers registered in our system
Purpose:
\nEnables you to identify which charge points you need to send data for.
\nCharge points are identified by \"externalId\"
\nThe purpose of externalId is for you to be able to identify the charge point in your own system
\nIn most cases externalId is the charge point serial number
\nWhen chargepoints are offboarded from our system they will stop being returned by this endpoint
\n\n\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"Note regarding charge point onboarding:
\n
The process of onboarding new charge points onto our system is undertaken directly between fleets and Allstar, there is no provision for onboarding within this API.
The datetime (ISO 8601) when to find chargers from.
\n","type":"text/plain"},"key":"since","value":"2024-01-01T00:00:00.000Z"}],"variable":[]}},"response":[{"id":"a9617cf6-dffb-451a-ab5e-4d31bc8546b2","name":"Success (200 OK)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.mina.co.uk/dataProvider.chargePoint.findMany?since=2021-01-01T06:34:56.000000Z","host":["https://api.mina.co.uk"],"path":["dataProvider.chargePoint.findMany"],"query":[{"key":"since","value":"2021-01-01T06:34:56.000000Z","description":"The date/time (ISO 8601) when to find chargers from"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"externalId\": \"chargePoint-1\",\n \"creationTimestamp\": \"2021-03-04T12:17:30.000000Z\"\n },\n {\n \"externalId\": \"chargePoint-2\",\n \"creationTimestamp\": \"2021-09-21T15:06:16.000000Z\"\n }\n ]\n}"}],"_postman_id":"499fcd5c-e043-4c0d-80c7-6a3ab42ccd76"},{"name":"dataProvider.charges.addWithIntervals","id":"e0ca2a79-032f-477a-b19d-18a4c850db88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"charges\": [\r\n {\r\n // The unique ID for the charge.\r\n \"chargeExternalId\": \"{{chargeExternalId}}\", \r\n\r\n // The unique ID for the charge point.\r\n \"chargePointExternalId\": \"{{chargePointExternalId}}\", \r\n\r\n // One or more charge intervals - each has a maximum duration of 30 minutes and a minimum duration of 1 minute.\r\n \"intervals\": [ \r\n {\r\n // ISO 8601 date/time when the charge interval started.\r\n \"from\": \"{{from}}\",\r\n\r\n // ISO 8601 date/time when the charge interval finished.\r\n \"to\": \"{{to}}\",\r\n\r\n // Energy consumption for the charge interval in kWh.\r\n \"consumption\": {{consumption}}\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mina.co.uk/dataProvider.charges.addWithIntervals","description":"\n\nImportant:
\n
\n\nThis is the preferred method of receiving charge sessions (compared with
\ncharges.add) because it produces the highest quality of data. When intervals are provided, we can accurately calculate payment amounts for all drivers including those on multi-rate or dynamic tariffs.
Purpose:
\nSend one or more charges to us.
\nCharges include a collection of 30 minute intervals.
\nWe'll determine when each charge started/finished based on the first/last interval respectively.
\nCharge consumption will be calculated by summing the consumption values for all intervals.
\n\n\nImportant:
\n
\n\nThis is the most basic method of ingesting charges. Consumption will be evenly distributed across the duration of the charge in 30-minute intervals. As a result, drivers on variable tariff won't receive 100% accurate reimbursement amounts.
\n
\n\nWe recommend using this endpoint only if you are unable to support interval data as required by the
\ncharges.addWithIntervalsendpoint
Purpose:
\nSend us one or more charges based on when they started/finished.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"Retrieves a list of charges successfully received by our system.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"