Arvetrak API Documentation

Getting started

Connect your backend to your company’s licensed fleet. Start with the status request, then list vehicles and query their data.

1. Add your server’s fixed outbound IP to the allowlist.
2. Generate an API key and secret in the management panel.
3. Call the status endpoint with both authentication headers.

Authentication & IP allowlist

Every REST request needs the key ID and secret in separate headers. Requests from unapproved IP addresses are rejected before fleet data is read.

Vehicle access & license periods

Only vehicles explicitly granted to this API client are returned. Real-time values are hidden after the license or grant expires. Historical queries are restricted to the intersection of granted and licensed periods.

Service status

Check credentials, client identity, active scopes and limits.

Required scope: status:read

Response · JSON

{
    "data": {
        "service": "Arvetrak Customer Fleet API",
        "version": "v1",
        "status": "ok",
        "client": {
            "code": "YOUR_CLIENT_CODE",
            "name": "Integration",
            "company": "Example",
            "abilities": [
                "status:read",
                "vehicles:read",
                "locations:read",
                "realtime:read"
            ]
        },
        "limits": {
            "requests_per_minute": 60,
            "history_requests_per_minute": 15,
            "max_page_size": 100,
            "max_history_days": 7,
            "max_history_points": 2000
        },
        "server_time": "2026-09-25T12:00:00Z"
    }
}

List vehicles

Paginated vehicles granted to this client. Expired vehicles remain listed without live values.

Required scope: vehicles:read

Parameters

Response · JSON

{
    "data": [
        {
            "id": 42,
            "imei": "353742378000001",
            "plate": "34 ABC 123",
            "license": {
                "status": "active"
            },
            "live_data_available": true,
            "latitude": 41.01,
            "longitude": 28.97,
            "speed_kmh": 0,
            "ignition": false,
            "online": true
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 100,
        "total": 1,
        "last_page": 1
    },
    "links": {
        "previous": null,
        "next": null
    }
}

Vehicle details

Get one granted vehicle and its current snapshot. An unknown or ungranted IMEI returns 404.

Required scope: vehicles:read

Parameters

Response · JSON

{
    "data": {
        "imei": "353742378000001",
        "plate": "34 ABC 123",
        "location_valid": true,
        "latitude": 41.01,
        "longitude": 28.97,
        "speed_kmh": 0,
        "ignition": false,
        "last_seen_at": "2026-09-25T12:00:00Z"
    },
    "meta": {
        "generated_at": "2026-09-25T12:00:01Z"
    }
}

Location history

Read GPS history within granted license periods. The newest points in the selected window are returned in ascending time order. If has_more is true, query an earlier window to continue.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [
        {
            "recorded_at": "2026-09-25T11:59:00Z",
            "latitude": 41.01,
            "longitude": 28.97,
            "speed_kmh": 31.2,
            "heading_deg": 90,
            "ignition": true
        }
    ],
    "meta": {
        "count": 1,
        "has_more": false,
        "order": "ascending"
    }
}

Report endpoints

Every report card on the web Reports screen is listed below individually. Animation endpoints return their underlying data, not rendered video. Each endpoint uses a granted vehicle and paginated rows.

Required scope: locations:read

Response · JSON

{
    "data": [
        {
            "type": "ignition",
            "label": "Kontak Açma/Kapatma",
            "endpoint": "/vehicles/{imei}/reports/ignition"
        },
        {
            "type": "alarms",
            "label": "Alarm Raporu",
            "endpoint": "/vehicles/{imei}/reports/alarms"
        },
        {
            "type": "detail",
            "label": "Detay Raporu",
            "endpoint": "/vehicles/{imei}/reports/detail"
        },
        {
            "type": "trips",
            "label": "Seyahat Raporu",
            "endpoint": "/vehicles/{imei}/reports/trips"
        },
        {
            "type": "canbus",
            "label": "CAN Bus / OBD-II",
            "endpoint": "/vehicles/{imei}/reports/canbus"
        },
        {
            "type": "current-location",
            "label": "Anlık Konum",
            "endpoint": "/vehicles/{imei}/reports/current-location"
        },
        {
            "type": "vehicles",
            "label": "Araç Listesi",
            "endpoint": "/vehicles/{imei}/reports/vehicles"
        },
        {
            "type": "vehicle-score",
            "label": "Araç Skoru",
            "endpoint": "/vehicles/{imei}/reports/vehicle-score"
        },
        {
            "type": "vehicle-summary",
            "label": "Araç Performans Özeti",
            "endpoint": "/vehicles/{imei}/reports/vehicle-summary"
        },
        {
            "type": "blockage",
            "label": "Motor Blokajı",
            "endpoint": "/vehicles/{imei}/reports/blockage"
        },
        {
            "type": "trailer",
            "label": "Dorse",
            "endpoint": "/vehicles/{imei}/reports/trailer"
        },
        {
            "type": "stops",
            "label": "Durak / Rölanti",
            "endpoint": "/vehicles/{imei}/reports/stops"
        },
        {
            "type": "geofence",
            "label": "Bölge Giriş / Çıkış",
            "endpoint": "/vehicles/{imei}/reports/geofence"
        },
        {
            "type": "day-end",
            "label": "Gün Sonu",
            "endpoint": "/vehicles/{imei}/reports/day-end"
        },
        {
            "type": "daily-km",
            "label": "Günlük KM",
            "endpoint": "/vehicles/{imei}/reports/daily-km"
        },
        {
            "type": "speed",
            "label": "Hız",
            "endpoint": "/vehicles/{imei}/reports/speed"
        },
        {
            "type": "km-limit",
            "label": "Kilometre Aşımı",
            "endpoint": "/vehicles/{imei}/reports/km-limit"
        },
        {
            "type": "distance",
            "label": "Mesafe",
            "endpoint": "/vehicles/{imei}/reports/distance"
        },
        {
            "type": "off-hours",
            "label": "Mesai Dışı Kullanım",
            "endpoint": "/vehicles/{imei}/reports/off-hours"
        },
        {
            "type": "trip-summary",
            "label": "Seyahat Özeti",
            "endpoint": "/vehicles/{imei}/reports/trip-summary"
        },
        {
            "type": "drivers",
            "label": "Sürücü Performansı",
            "endpoint": "/vehicles/{imei}/reports/drivers"
        },
        {
            "type": "driver-list",
            "label": "Sürücü Listesi",
            "endpoint": "/vehicles/{imei}/reports/driver-list"
        },
        {
            "type": "driving-dynamics",
            "label": "Sürüş Dinamikleri",
            "endpoint": "/vehicles/{imei}/reports/driving-dynamics"
        },
        {
            "type": "gsensor-cockpit",
            "label": "G-Sensör Araç İçi Animasyon Verisi",
            "endpoint": "/vehicles/{imei}/reports/gsensor-cockpit"
        },
        {
            "type": "gsensor-motion",
            "label": "G-Sensör Hareket Animasyon Verisi",
            "endpoint": "/vehicles/{imei}/reports/gsensor-motion"
        },
        {
            "type": "total-km",
            "label": "Toplam KM",
            "endpoint": "/vehicles/{imei}/reports/total-km"
        },
        {
            "type": "fuel",
            "label": "Yakıt",
            "endpoint": "/vehicles/{imei}/reports/fuel"
        },
        {
            "type": "fuel-prices",
            "label": "Yakıt Fiyatları",
            "endpoint": "/vehicles/{imei}/reports/fuel-prices"
        },
        {
            "type": "temperature-overview",
            "label": "Soğuk Zincir Uyum Özeti",
            "endpoint": "/vehicles/{imei}/reports/temperature-overview"
        },
        {
            "type": "temperature-violations",
            "label": "Sıcaklık İhlalleri",
            "endpoint": "/vehicles/{imei}/reports/temperature-violations"
        },
        {
            "type": "temperature-proof",
            "label": "Sefer Bazlı Isı Kanıtı",
            "endpoint": "/vehicles/{imei}/reports/temperature-proof"
        },
        {
            "type": "temperature-readings",
            "label": "Ölçüm Günlüğü",
            "endpoint": "/vehicles/{imei}/reports/temperature-readings"
        },
        {
            "type": "auto-service-areas",
            "label": "Oto Sanayi Bölgeleri",
            "endpoint": "/vehicles/{imei}/reports/auto-service-areas"
        },
        {
            "type": "fleet-executive",
            "label": "Filo Yönetici Özeti",
            "endpoint": "/vehicles/{imei}/reports/fleet-executive"
        },
        {
            "type": "fleet-utilization",
            "label": "Filo Kullanım ve Atıl Araç",
            "endpoint": "/vehicles/{imei}/reports/fleet-utilization"
        },
        {
            "type": "fleet-tco",
            "label": "Filo Maliyet ve TCO",
            "endpoint": "/vehicles/{imei}/reports/fleet-tco"
        },
        {
            "type": "fleet-maintenance",
            "label": "Filo Bakım ve Arıza",
            "endpoint": "/vehicles/{imei}/reports/fleet-maintenance"
        },
        {
            "type": "fleet-availability",
            "label": "Filo Kullanılabilirlik",
            "endpoint": "/vehicles/{imei}/reports/fleet-availability"
        },
        {
            "type": "fleet-groups",
            "label": "Şube ve Filo Grubu",
            "endpoint": "/vehicles/{imei}/reports/fleet-groups"
        },
        {
            "type": "fleet-contracts",
            "label": "Kontrat ve KM Tahmini",
            "endpoint": "/vehicles/{imei}/reports/fleet-contracts"
        },
        {
            "type": "fleet-renewal",
            "label": "Filo Yenileme Kararı",
            "endpoint": "/vehicles/{imei}/reports/fleet-renewal"
        }
    ]
}

Ignition events

Returns observed ignition state changes for one permitted vehicle within licensed periods. The first sample in each licensed interval is a baseline, not an event. Use page/per_page for the complete result.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [
        {
            "recorded_at": "2026-09-25T07:13:00Z",
            "event": "opened",
            "ignition": true,
            "latitude": 41.01,
            "longitude": 28.97,
            "speed_kmh": 0
        }
    ],
    "meta": {
        "report": "ignition",
        "current_page": 1,
        "per_page": 50,
        "total": 1,
        "last_page": 1,
        "has_more": false
    }
}

Alarm events

Lists alarm records for one permitted vehicle, within its licensed periods and company ownership snapshot.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [
        {
            "recorded_at": "2026-09-25T07:13:00Z",
            "code": "T_MOVEMENT",
            "description": "Araç hareket ettirildi",
            "category": "alarm",
            "is_active": true,
            "latitude": 41.01,
            "longitude": 28.97,
            "speed_kmh": 0
        }
    ],
    "meta": {
        "report": "alarms",
        "current_page": 1,
        "per_page": 50,
        "total": 1,
        "last_page": 1,
        "has_more": false
    }
}

Detailed packet report

Paginated device packets from licensed periods, with position, speed and ignition. Missing telemetry is null.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [
        {
            "recorded_at": "2026-09-25T07:13:00Z",
            "latitude": 41.01,
            "longitude": 28.97,
            "speed_kmh": 31.2,
            "ignition": true
        }
    ],
    "meta": {
        "report": "detail",
        "current_page": 1,
        "per_page": 50,
        "total": 1,
        "has_more": false
    }
}

Trips

Completed trips wholly within licensed intervals; trips crossing a license boundary are intentionally omitted.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [
        {
            "started_at": "2026-09-25T07:13:00Z",
            "ended_at": "2026-09-25T08:00:00Z",
            "distance_km": 12.4,
            "duration_sec": 2820,
            "idle_sec": 120,
            "max_speed_kmh": 72
        }
    ],
    "meta": {
        "report": "trips",
        "current_page": 1,
        "per_page": 50,
        "total": 1,
        "has_more": false
    }
}

CAN Bus / OBD-II packets

Only packets containing observed CAN/OBD data are returned. This endpoint does not invent unreported fields.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [
        {
            "recorded_at": "2026-09-25T07:13:00Z",
            "speed_kmh": 30,
            "telemetry": {
                "io_36": 860
            }
        }
    ],
    "meta": {
        "report": "canbus",
        "current_page": 1,
        "per_page": 50,
        "total": 1,
        "has_more": false
    }
}

Current location

Latest position, speed and ignition snapshot; an active license is required.

• This is the latest known device snapshot, not a guaranteed current GPS fix. Check the packet timestamp before treating the vehicle as online. Historical snapshots are not returned.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "current-location",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Vehicle list

Vehicle, device and latest signal details; an active license is required.

• This is the latest known device snapshot, not a guaranteed current GPS fix. Check the packet timestamp before treating the vehicle as online. Historical snapshots are not returned.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "vehicles",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Vehicle score

Safety, efficiency and utilization score for this vehicle.

• Scores and comparisons are calculated from recorded activity. Missing source data can leave a score empty; do not interpret a missing score as zero.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "vehicle-score",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Vehicle performance summary

Distance, driving, idle time and alarm metrics.

• Scores and comparisons are calculated from recorded activity. Missing source data can leave a score empty; do not interpret a missing score as zero.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "vehicle-summary",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Engine immobilizer

Immobilizer feature and current vehicle state; an active license is required.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.
• Read-only report: requesting it never sends an immobilizer command.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "blockage",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Trailer

Trailer linkage and tracking records where the module is enabled.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.
• If the optional trailer module is not configured, an empty result is expected.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "trailer",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Stops and idling

Stop counts and idling duration from completed trips.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "stops",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Geofence entry and exit

Entry and exit alarm events for defined zones.

• Only recorded entry/exit alarm events are listed. This endpoint does not reconstruct a dwell interval when a device did not report an event.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "geofence",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Day-end report

Daily first/last ignition, distance and trip duration.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "day-end",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Daily mileage

Odometer readings and distance by day.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "daily-km",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Speed report

Average/maximum trip speed and overspeed counts.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "speed",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Mileage threshold

Days exceeding the requested mileage threshold.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.
• km_limit is the requested daily threshold, not the licensed total distance.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "km-limit",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Distance report

Daily distance derived from trips and odometer readings.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "distance",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Out-of-hours usage

Trips and related alarms outside working hours.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.
• Classification follows the working-hours settings configured for the web report.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "off-hours",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Trip summary

Daily trip count, travel time and distance.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "trip-summary",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Driver performance

Driver safety and efficiency scores.

• Driver performance depends on recorded driver assignments. An unassigned journey cannot be attributed to a person.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "drivers",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Driver list

Driver assignments related to the vehicle.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "driver-list",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Driving dynamics

Harsh braking, acceleration, cornering and road events.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "driving-dynamics",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

G-sensor cockpit animation data

Device axis samples used for cockpit animation; returns data rather than a rendered video.

• Returns source events or sampled axis measurements for the animation, not an image or video. Axis points may be downsampled for performance.
• data contains axis samples for the cockpit playback.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "gsensor-cockpit",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

G-sensor motion animation data

Bump, road-surface and driving events used for the 3D animation.

• Returns source events or sampled axis measurements for the animation, not an image or video. Axis points may be downsampled for performance.
• data contains timestamped movement events for the 3D playback.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "gsensor-motion",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Total mileage

Odometer readings at the beginning and end of the period.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "total-km",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Fuel report

Estimated fuel from trip distance and consumption profile; the estimation source is shown.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.
• Consumption may be estimated from distance and a configured profile; it is not necessarily measured CAN fuel flow.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fuel",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Fuel prices

Comparison of fuel prices for the selected city and date.

• Rows follow the web report table: cells contains display values, export contains export-ready values, and summary contains period totals. Empty data means there were no matching records, not an API error.
• Prices are a comparison dataset selected by fuel_city and fuel_date, not a vehicle purchase or measured consumption.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fuel-prices",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Cold-chain compliance

Temperature compliance and risk from observed sensor readings.

• Only sensor readings actually received from the device are used. No reading is fabricated for periods with missing sensor coverage.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "temperature-overview",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Temperature violations

Grouped events for sensor readings outside thresholds.

• Only sensor readings actually received from the device are used. No reading is fabricated for periods with missing sensor coverage.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "temperature-violations",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Trip temperature evidence

Measured temperature range and compliance during trips.

• Only sensor readings actually received from the device are used. No reading is fabricated for periods with missing sensor coverage.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "temperature-proof",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Sensor readings

Raw temperature and humidity measurements.

• Only sensor readings actually received from the device are used. No reading is fabricated for periods with missing sensor coverage.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "temperature-readings",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Automotive service areas

Active map catalog of automotive service areas; not vehicle telemetry.

• This is a shared map catalog, not vehicle telemetry. A currently licensed, granted IMEI is still required for the customer API request.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "auto-service-areas",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Fleet executive summary

Vehicle, mileage, cost and fleet health overview. The previous comparison period and current snapshot must also be licensed.

• The fleet report is restricted to the one granted IMEI in the URL, including comparison totals. The preceding comparison period and current snapshot must also be licensed.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fleet-executive",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Fleet utilization

Used/idle days and driving-to-idling ratio. The previous comparison period and current snapshot must also be licensed.

• The fleet report is restricted to the one granted IMEI in the URL, including comparison totals. The preceding comparison period and current snapshot must also be licensed.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fleet-utilization",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Fleet cost and TCO

Total ownership cost per vehicle and kilometre. The previous comparison period and current snapshot must also be licensed.

• The fleet report is restricted to the one granted IMEI in the URL, including comparison totals. The preceding comparison period and current snapshot must also be licensed.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fleet-tco",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Fleet maintenance and faults

Maintenance risk, service time and faults. The previous comparison period and current snapshot must also be licensed.

• The fleet report is restricted to the one granted IMEI in the URL, including comparison totals. The preceding comparison period and current snapshot must also be licensed.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fleet-maintenance",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Fleet availability

Ready, in-service, faulty and idle vehicles. The previous comparison period and current snapshot must also be licensed.

• The fleet report is restricted to the one granted IMEI in the URL, including comparison totals. The preceding comparison period and current snapshot must also be licensed.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fleet-availability",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Branches and fleet groups

Vehicle, mileage and cost comparison by group. The previous comparison period and current snapshot must also be licensed.

• The fleet report is restricted to the one granted IMEI in the URL, including comparison totals. The preceding comparison period and current snapshot must also be licensed.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fleet-groups",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Contracts and mileage forecast

Contract expiry, mileage limits and projected overrun. The previous comparison period and current snapshot must also be licensed.

• The fleet report is restricted to the one granted IMEI in the URL, including comparison totals. The preceding comparison period and current snapshot must also be licensed.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fleet-contracts",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Fleet renewal decisions

Renewal priority based on age, mileage, maintenance and health. The previous comparison period and current snapshot must also be licensed.

• The fleet report is restricted to the one granted IMEI in the URL, including comparison totals. The preceding comparison period and current snapshot must also be licensed.

Required scope: locations:read

Parameters

Response · JSON

{
    "data": [],
    "summary": [],
    "meta": {
        "report": "fleet-renewal",
        "vehicle": {
            "imei": "353742378000001",
            "plate": "34 ABC 123"
        },
        "current_page": 1,
        "per_page": 20,
        "total": 0,
        "last_page": 1,
        "has_more": false
    }
}

Create WebSocket ticket

Request a short-lived connection ticket from your backend. Do not expose the REST secret to the browser.

Required scope: realtime:read

Parameters

Response · JSON

{
    "data": {
        "url": "wss://gw.arvetrak.com/ws",
        "token": "SHORT_LIVED_TOKEN",
        "expires_in": 300,
        "vehicle_count": 1,
        "ping_interval": 30
    }
}

Data dictionary

Timestamps use ISO 8601 in UTC. Distance values are in kilometres; speed in km/h; voltage in volts. Null means the device did not provide a trusted value.

Rate limits

The client has independent standard, history and WebSocket budgets. Inspect /status for current values. HTTP 429 means back off; never loop aggressively.

Errors

All errors are JSON with a stable error code. Never infer access from the wording of an error.

Response · JSON

{
    "message": "Request parameters are invalid.",
    "error": "validation_error",
    "errors": {
        "from": [
            "The from field is required."
        ]
    }
}

Security

Use HTTPS/WSS, keep credentials only in server-side secrets, rotate leaked keys, restrict IP ranges and avoid logging location or secrets. The mobile API has separate authentication and is not governed by these customer API limits.