Developers · REST API

BMW & Mini vehicle data,
on demand.

A pay-as-you-go REST API for BMW & Mini — VIN lookup, factory data, FSC navigation codes, CarPlay activation and secure coding, all over a single authenticated endpoint.

quickstart.sh
# 1 · get a token (cache it for 1 hour)
curl -X POST https://api.bimmerportal.xyz/auth/token \
  -H 'content-type: application/json' \
  -d '{"client_id":"cid_…","client_secret":"cs_…"}'

# 2 · decode a VIN
curl -X POST https://api.bimmerportal.xyz/fullvindata-plus-carplaycheck \
  -H 'authorization: bearer <token>' \
  -d '{"vin":"WBA6X520105S74081"}'
→ { "head_unit":"NBTEVO", "carplay":true, … }
// what you get

BMW & Mini data and coding, over HTTPS

The full API over HTTPS. One REST API — JSON in, codes & files out.

Lookup & data

POST /vehicle-state

VIN search

Vehicle-state lookup by VIN. Returns ECU configuration, installed equipment, current iLevel, head-unit type and factory options.

POST /vehicle-order-json

Vehicle order (FA) — JSON

Factory order data — original equipment list, build configuration and FA codes, returned as JSON.

POST /fullvindata-plus-carplaycheck

VIN + head-unit + CarPlay check

A single call returning vehicle data and identifying head-unit type, map version and CarPlay compatibility.

Navigation map activation (FSC)

POST /fsc-code

FSC code generation

Generate map-activation FSC codes for Premium, Route, Motion, Move, EVO ID4 and Next maps.

POST /repairkit

FSC repair kit

Downloadable repair-kit package from the database.

CarPlay activation

POST /carplay-coding

EVO ID5/6 CarPlay — cable

Generates a Feature Installer code to enable CarPlay on compatible EVO ID5/6 head units.

POST /carplay-coding-usb

EVO ID5/6 CarPlay — USB

Generates a UPD file to enable CarPlay on compatible EVO ID5/6 head units.

POST /fullscreen-carplay

Fullscreen CarPlay add-on — cable

Feature Installer code to enable the CarPlay Fullscreen add-on on compatible EVO ID5/6 head units.

POST /fullscreen-carplay-usb

Fullscreen CarPlay add-on — USB

UPD file to enable the CarPlay Fullscreen add-on on compatible EVO ID5/6 head units.

Video in motion

POST /vim-coding

VIM activation — cable

Feature Installer code to enable Video In Motion on compatible EVO ID5/6 head units.

POST /vim-coding-usb

VIM activation — USB

UPD file to enable Video In Motion on compatible EVO ID5/6 head units.

POST /vim-nbt-usb

VIM for NBT — USB

UPD file to enable Video In Motion on older NBT head units.

Service & coding

POST /secure-coding-async

Secure coding (NCD 2.0)

Submit the original or a modified FA/SVT to receive signed NCD coding files. Async — submit returns a job_id.

POST /sfa-repair-kit

SFA repair kit

Generate an SFA repair kit. Used when updating or replacing control units that require secure flashing.

POST /vo-coding-fix

VO coding fix

Generates a Feature Installer code to fix VO coding on EVO ID5/6 units.

POST /clear-swt

Clear SWT

Generates a Feature Installer code to clear SWT records on EVO ID5/6 units.

POST /ecu-validation

ECU validation

Generates an ECU validation JSON file. Required to verify the security status of new ECUs on models from July 2018 onward.

Vehicle history

POST /service-history

Service history

Full vehicle service history — factory specs, equipment, technical campaigns and service/repair/key-read log. Returns a ready-to-share HTML report plus the raw structured data.

// integration

Live in three calls

01

Request access

Contact us and we'll set you up with API credentials to start building.

02

Authenticate once

Exchange your credentials for a bearer token, valid for an hour. Cache and reuse it across requests.

03

Call any endpoint

Send a VIN, get data, codes or files back. Credits are only spent on success — failures auto-refund.

Build on BMW & Mini data.

Email us about API access and we'll get you set up.