Swiftly API Docs
API Reference
Introduction
Test Key
Agency Info
Real-time

Welcome to the Swiftly API docs.

Swiftly is a big data platform designed for transportation agencies, operators, and passengers. Swiftly aggregates and normalizes data about a transit system then surfaces real-time information and historical insights, allowing agencies to make their systems more efficient & reliable and empowering them to deliver highly accurate vehicle arrival predictions for riders.

This guide is designed to provide you with everything you need to familiarize yourself with Swiftly’s transit data, and if authorized, to access the data via API.

API Overview

Swiftly provides two products for transit agencies and operators, Swiftly Transitime and Swiftly Insights.

Swiftly Transitime: high-fidelity real-time information for passengers and operations that makes it easy to know where vehicles are, how they are performing relative to the schedule, and whether or not bunching or gaps are occurring.

Swiftly Insights: a powerful suite of historical reports that reveal where, when, and why issues are occurring within the network and the means to measure the impact of initiatives.

The Swiftly APIs are meant to give customers control over this data - to extend analysis outside of the Swiftly dashboard and to share it with other applications, like real-time passenger information mobile apps, that will help make their transit ecosystem more robust.

The APIs mirror the product modules available for license. Customers who purchase Transitime will have access to Swiftly’s Real-Time APIs, and those who purchase any Insights product modules will have access to the corresponding module API endpoints.

All Swiftly API use must be compliant with Swiftly’s Terms of Service.

Authorization

Before we dive into the specifics of the Swiftly API endpoints, let’s talk about authorization. All requests to the Swiftly API must be authorized. Authorization is accomplished by including an HTTP header named “Authorization.” The value of this header field must contain a valid API key.

You can obtain a valid API key by licensing Swiftly’s real-time and historical transit data modules. Your key will then authorize requests to the data from modules in your subscription.