TransCAPI

TransCAPI Alerts API

The Alerts API from TransCAPI — 3 operation(s) for alerts.

GitHub OpenAPI

Operations 5

GET /v1/alerts.json List your push alerts #
POST /v1/alerts.json Create a push alert (webhook) #
DELETE /v1/alerts/{alert_id}.json Delete a push alert #
GET /v1/alerts/{alert_id}.json A push alert and its last 20 deliveries #
POST /v1/alerts/{alert_id}/test.json Send a test event to the alert's URL #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/transcapi/openapi/transcapi-alerts-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/transcapi:transcapi-alerts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

transcapi-alerts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    url: https://www.transcapi.com
  description: 'Public transport data for Great Britain (England, Scotland and Wales): stops and places, bus and rail departures and arrivals with live running, routes and services, live bus positions, disruptions and journey planning. Every departure says in `source` whether its time is live or timetabled. Data is official open data; attribution requirements are at https://www.transcapi.com/docs/data-sources.'
  termsOfService: https://www.transcapi.com/terms
  title: TransC Alerts API
  version: 1.0.0
servers:
- description: Production
  url: https://api.transcapi.com
security:
- ApiKeyHeader: []
- ApiKeyQuery: []
tags:
- name: Alerts
paths:
  /v1/alerts.json:
    get:
      responses:
        '200':
          description: Every alert on this API key
      summary: List your push alerts
      tags:
      - Alerts
      operationId: getV1AlertsJson
      x-operation-id-source: derived
    post:
      description: 'TransCAPI POSTs signed JSON to your https URL when the condition is met. vehicle_approaching: a tracked bus is due at `atcocode` within `minutes` (1-30), optionally only `line`. disruption: a disruption newly matches `filters` (any of mode, severity, operator, line, atcocode, lat+lon+radius, planned). The response includes `secret`, shown once, for checking the X-TransCAPI-Signature header.'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                atcocode:
                  type: string
                description:
                  type: string
                filters:
                  type: object
                line:
                  type: string
                minutes:
                  type: integer
                type:
                  enum:
                  - vehicle_approaching
                  - disruption
                  type: string
                url:
                  type: string
              required:
              - type
              - url
              type: object
      responses:
        '201':
          description: The alert
          with its secret: null
      summary: Create a push alert (webhook)
      tags:
      - Alerts
      operationId: postV1AlertsJson
      x-operation-id-source: derived
  /v1/alerts/{alert_id}.json:
    delete:
      parameters:
      - in: path
        name: alert_id
        required: true
        schema:
          type: string
      summary: Delete a push alert
      tags:
      - Alerts
      operationId: deleteV1Alerts{alertId}Json
      x-operation-id-source: derived
    get:
      parameters:
      - in: path
        name: alert_id
        required: true
        schema:
          type: string
      summary: A push alert and its last 20 deliveries
      tags:
      - Alerts
      operationId: getV1Alerts{alertId}Json
      x-operation-id-source: derived
  /v1/alerts/{alert_id}/test.json:
    post:
      description: Delivers a `test` event straight away and reports what your server answered. Re-enables a paused alert if the test succeeds.
      parameters:
      - in: path
        name: alert_id
        required: true
        schema:
          type: string
      summary: Send a test event to the alert's URL
      tags:
      - Alerts
      operationId: postV1AlertsByAlertIdTestJson
      x-operation-id-source: derived
components:
  securitySchemes:
    ApiKeyHeader:
      in: header
      name: X-Api-Key
      type: apiKey
    ApiKeyQuery:
      in: query
      name: api_key
      type: apiKey