May Mobility Fleet Realtime API

aid: may-mobility:fleet-realtime-api
name: May Mobility Fleet Realtime API
description: A WebSocket streaming API that delivers live May Mobility vehicle data in two modes. Telemetry
  mode streams JSON messages for a comma-separated list of per-vehicle topics (GPS, POSE, DRIVE_STATUS,
  RUNLEVEL, COLLISION_NOTIFICATION, TRAFFIC_LIGHT and others) using the topic form /.vehicle.{vehicleID}.{topicName},
  with a documented ceiling of 20 topics per connection. Video mode streams exterior camera feeds for
  up to four vehicles per connection as serialized protobuf (quic_wrapper wrapping May.image_t, mostly
  VP9). Authentication is an AWS Cognito client-credentials access token passed as a token query parameter.
  Access is provisioned by the May Mobility Fleet API team; the connection domain is issued per account
  and is not published.
humanURL: https://docs.maymobility.com/docs/intro
baseURL: https://docs.maymobility.com/docs/fleet-api/connecting-to-fleet-api
tags:
- Telemetry
- Streaming
- WebSockets
- Autonomous Vehicles
- Fleet Management
properties:
- type: Documentation
  url: https://docs.maymobility.com/docs/intro
- type: GettingStarted
  url: https://docs.maymobility.com/docs/fleet-api/connecting-to-fleet-api
- type: APIReference
  url: https://docs.maymobility.com/docs/fleet-api/types-of-data
- type: Authentication
  url: authentication/may-mobility-fleet-authentication.yml
- type: ChangeLog
  url: https://docs.maymobility.com/docs/release-notes/realttime-api
- type: Webhooks
  url: asyncapi/may-mobility-fleet-events.yml
- type: Protobuf
  url: grpc/may-mobility-quic-wrapper.proto