Skip to main content

​
Get an API key

Email support@mobs.ws to request an API key for your application.
There are no plans, trials or self-serve keys. Placeholder · A15

​
Send it

Pass your API key as a Bearer header, Authorization: Bearer YOUR_API_KEY, on the socket handshake and on HTTP. The socket also accepts it as ?token=, because browsers cannot set socket headers.
On the WebSocket handshake and on every HTTP request.
Header
Keep API keys out of public repositories and shared code.

​
API key scopes

Every scope is read-only. GET /v1/status and GET /v1/stations are public.

​
Rotation and revocation

The operator can issue a replacement with an overlap, then retire the old API key. When an API key is revoked or expires, its open sockets close with 4403. Treat an API key like a password.

Next: Rate limits

Sockets, HTTP requests and airports per API key.