CATA API v1.0.0

Interactive Documentation

Live Demo

API Reference

Complete API documentation for the CATA Alerts platform.

Service Alerts

GET /api/v1/alerts

List all service alerts.

status string

Filter by status (active, scheduled, expired).

severity string

Filter by severity level (info, minor, major, critical).

GET /api/v1/alerts/{id}

Get a specific alert by ID.

No parameters required

POST /api/v1/alerts

Create a new service alert.

No parameters required

PUT /api/v1/alerts/{id}

Update an existing alert.

No parameters required

DELETE /api/v1/alerts/{id}

Delete an alert.

No parameters required

GTFS Data

GET /api/v1/routes

List all routes.

agency_id string

Filter by agency ID.

GET /api/v1/stops

List all stops.

route_id string

Filter by route ID.

lat number

Filter by latitude (requires lon and radius).

lon number

Filter by longitude.

radius number

Search radius in meters.

GET /api/v1/agency

Get agency details.

No parameters required

Alert Types

GET /api/v1/alert-types

List all alert types.

No parameters required

Response Codes

200 Success Request completed successfully.
400 Bad Request Invalid parameters or request body.
401 Unauthorized Invalid or missing API key.
404 Not Found Resource does not exist.
429 Rate Limit Exceeded Too many requests.
500 Server Error Internal server error.

Rate Limiting

The API enforces rate limits to ensure fair usage and system stability.

Free tier: 100 requests/minute
Standard tier: 500 requests/minute
Premium tier: 2,000 requests/minute

Interactive API Documentation

Explore and test all API endpoints using Swagger UI below. Use the Authorize button and enter your API key.

Sign in to access the interactive Live Demo. Sign in