Open Vehicles
latest

User Guides:

  • Overview
  • User Guide
  • Plugins

Vehicle Specific Guides:

  • BMW i3 / i3s
  • DBC Based Vehicles
  • DEMO Vehicle
  • Fiat 500e
  • Hyundai Ioniq 5
  • Hyundai Ioniq vFL
  • Jaguar IPace
  • Kia e-Niro / Hyundai Kona / Hyundai Ioniq FL
  • Kia Soul EV
  • Maxus eDeliver3
  • Mercedes-Benz B250E W242
  • MG EV
  • Mini Cooper SE
  • Mitsubishi Trio
  • Nissan Leaf/e-NV200
  • OBDII Vehicles
  • Renault Twizy
  • Renault Zoe
  • Renault Zoe Phase 2 (OBD port)
  • Smart ED Gen.3
  • Smart ED/EQ Gen.4 (453)
  • Tesla Model 3
  • Tesla Model S
  • Tesla Roadster
  • Toyota RAV4 EV
  • Tracking Vehicles
  • VW e-Up
  • VW e-Up via OBD2
  • VW e-Up via Comfort CAN (T26A)

Developer Guides:

  • Command Line Interpreter
  • CAN Bus Data Logging
  • CRTD CAN Log Format
  • Web Framework & Plugins
  • Scripting
  • CANopen
  • OVMS Server
  • OVMS Protocol v2
  • OVMS HTTP API
    • Welcome
    • Format
    • Authentication
    • Requests

Research / Work in progress:

  • PID SCAN
  • Tester Present
Open Vehicles
  • Docs »
  • OVMS HTTP API
  • Edit on GitHub

OVMS HTTP APIΒΆ

Contents:

  • Welcome
  • Format
    • Example
  • Authentication
    • Alternatives
    • Cookie Based Authentication
    • API Token Maintenance
  • Requests
    • GET /api/cookie
    • DELETE /api/cookie
    • GET /api/token
    • POST /api/token
    • DELETE /api/token/<TOKEN>
    • GET /api/vehicles
    • GET /api/vehicle/<VEHICLEID>
    • DELETE /api/vehicle/<VEHICLEID>
    • GET /api/protocol/<VEHICLEID>
    • GET /api/status/<VEHICLEID>
    • GET /api/tpms/<VEHICLEID>
    • GET /api/location/<VEHICLEID>
    • GET /api/charge/<VEHICLEID>
    • GET /api/historical/<VEHICLEID>
    • GET /api/historical/<VEHICLEID>/<RECORDTYPE>
    • Not Yet Implemented
Next Previous

© Copyright 2019-2020, Open Vehicles Developers Revision 874e4c1f.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.