API reference

Accepts hex (spaces, colons, 0x allowed), base64, XER (XML) or codec JSON. Bytes are unwrapped automatically: Ethernet II (0x88DC) → IEEE 1609.3 WSMP → IEEE 1609.2 SPDU → MessageFrame. Counts against the quota.

curl -s https://cv2x.itsroads.com/api/decode -H 'Content-Type: application/json' \
  -d '{"data":"00142544A1B2C3D4…","include_xer":false}'

Response:

{
  "ok": true, "input": "bytes", "type": "MessageFrame", "encoding": "uper",
  "hex": "0014…", "bytes": 85, "consumed": 85,
  "messageId": 20, "message": "BasicSafetyMessage", "name": "BSM — Basic Safety Message",
  "json": {"messageId": 20, "value": {"BasicSafetyMessage": {"coreData": {…}}}},
  "summary": {"type": "BasicSafetyMessage", "headline": "BSM from vehicle A1B2C3D4 at 15.00 m/s …",
              "rows": [{"label": "Position", "value": "38.8823410, -77.1757920"}, …],
              "geojson": {"type": "FeatureCollection", "features": […]} },
  "layers": [{"layer": "IEEE 1609.3 WSMP", "detail": "…PSID 0x20…", "bytes": 6}, …],   // when wrappers were peeled
  "ieee1609dot2": {…},            // decoded SPDU when a 1609.2 wrapper was present
  "trailing_bytes": 2,            // only when bytes remain after the message
  "xer": "<MessageFrame>…",      // when include_xer
  "schema": "2020", "schema_label": "SAE J2735_202007",      // revision that produced the decode
  "schema_note": "Decoded with SAE J2735_202007 (older revision) because …",   // only when an older revision was used
  "schema_attempts": ["SAE J2735_202409: decoded 80 of 85 bytes", …],          // only in auto mode when the newest did not decode cleanly
  "standards": {…}, "ms": 12,
  "quota": {"authenticated": false, "limit": 5, "used": 1, "remaining": 4}
}

Encodes codec JSON to UPER with constraint checking, then decodes it back so the response json is the canonical form. Counts against the quota.

curl -s https://cv2x.itsroads.com/api/encode -H 'Content-Type: application/json' \
  -d '{"json":{"messageId":20,"value":{"BasicSafetyMessage":{"coreData":{…}}}},"type":"MessageFrame","check":true}'

{"ok": true, "type": "MessageFrame", "hex": "0014…", "base64": "ABQl…", "bytes": 85, "json": {…},
 "messageId": 20, "message": "BasicSafetyMessage", "name": "BSM — Basic Safety Message", "summary": {…},
 "warning": "messageId 19 does not match the BasicSafetyMessage payload…",   // only when inconsistent
 "ms": 9, "quota": {…}}

A constraint violation returns HTTP 422 with the offending field, e.g. Constraint violation in coreData.lat: the value is outside the range….

Lists the validated example messages (id, name, messageId, type, bytes, description, standard) and packets — wrapped frame samples for the decoder. No quota.

One template with its full json, on-air hex and notes. Ids: bsm, spat, map, tim-workzone, tim-speed-limit, rsm-workzone, psm, srm, ssm, sdsm, eva, rtcm.

curl -s https://cv2x.itsroads.com/api/templates/spat | jq .template.json

All type names in the selected revision (?schema=2024|2020|2016, default 2024: 1,218 types; 2020 and 2016: 702) plus messageIds (DSRCmsgID → MessageFrame alternative) and schemas: [{id, label, types}] for every revision installed. No quota.

curl -s https://cv2x.itsroads.com/api/types?schema=2020 | jq '.schemas, .count'

A randomly generated, constraint-valid instance of any type — useful to see the exact JSON shape of a rarely used structure. Values are not meaningful. Counts against the quota.

curl -s https://cv2x.itsroads.com/api/example/RoadSafetyMessage | jq .json
curl -s "https://cv2x.itsroads.com/api/example/BasicSafetyMessage?schema=2016" | jq .json     # older revision

{"email","password","name","org"} — password ≥ 10 characters. Sets the cv2x_session HttpOnly cookie (14 days).

{"email","password"} → {"ok":true,"user":{id,email,name,org,role}} and the cookie.

Clears the cookie.

Current user (or null) and quota.

curl -s -c cookies.txt https://cv2x.itsroads.com/api/auth/login -H 'Content-Type: application/json' \
  -d '{"email":"you@agency.gov","password":"…"}'
curl -s -b cookies.txt https://cv2x.itsroads.com/api/rsus

Register/login and all RSU writes check the Origin header when present; scripts without an Origin header are fine.

Your devices (credentials never returned; has_auth_key etc. flags instead) and the vendor list.

Create / update. Fields: name (required), agency, vendor, model, firmware, lat, lon, elev, ip (IPv4/IPv6 literal, publicly routable on the free tier), port (161), snmp_version (3 | 2c), snmp_user, auth_proto (SHA, SHA-256, SHA-512, MD5), auth_key, priv_proto (AES, AES-256, DES), priv_key, community (v2c), mib (ntcip1218, NTCIP 1218 v01A), public (bool: coarse pin on the public map), notes. Secrets are encrypted at rest; omit them on update to keep the stored values. Up to 25 devices per account.

Removes the device and its push log.

SNMP GET of sysDescr and the RSU ID object → {"ok", "result"}.

Last 50 pushes and probes: {id, kind, msg_type, psid, params, result, ok, created}.

Validates the payload as a J2735 MessageFrame, then writes one row of rsuMsgRepeatTable (store-and-repeat) or rsuIFMTable (immediate forward) over SNMPv3 authPriv.

curl -s -b cookies.txt https://cv2x.itsroads.com/api/rsus/12/push -H 'Content-Type: application/json' \
  -d '{"hex":"001380A0…","channel":183,"interval_ms":1000,"mode":"repeat"}'
# → {"ok": true, "result": "…snmpset output…", "psid": 32770, "message": "SPAT"}

RSUs whose owners opted in, with coarse (3-decimal) coordinates and no network details. No quota.