Skip to main content

SIRI 2.2

This section describes the SIRI (Service Interface for Real-time Information) XML API, explained in full on the SIRI GitHub v2.2.

Authentication

$ curl -X POST -H "X-Access-Token: $API_KEY" \
-H "Content-Type: application/xml" \
https://api.voiapp.io/huginn/siriv2/1

All endpoints are protected with API key authentication. Include your API key in the X-Access-Token request header on every request.

Contact our engineering support to receive your API key.

Header Parameters

KeyValue
X-Access-Tokenyour-api-key
Content-Typeapplication/xml

Versioning

Voi's SIRI API implements the official SIRI XML schema version 2.2 only. Consult the official SIRI documentation for schema details, request options and response structure.

See the SIRI GitHub description of version 2.2 here.

warning

Current SIRI implementation only supports the official schema of version 2.2.

Supported services

Of the official SIRI 2.2 services, Voi supports the following:

ServiceDescription
VehicleMonitoring (SIRI-VM)Current location and status of a set of vehicles.
SituationExchange (SIRI-SX)Situations caused by planned and unplanned incidents and events that perturb normal operation.
FacilityMonitoring (SIRI-FM)Alterations to the availability of facilities for passengers, including equipment monitoring.

For the full definition of each service, see the official SIRI v2.2 documentation.

Service request

A SIRI service request.

# v2.2 - Stockholm
$ curl -L \
-X POST \
-H "X-Access-Token: $API_KEY" \
-H "Content-Type: application/xml" \
-d @request.xml \
"https://api.voiapp.io/huginn/siriv2/1"

Do not copy ^ as the zone-ID might not match yours

The /siriv2 endpoint accepts a SIRI ServiceRequest over HTTP POST and returns an XML ServiceDelivery for the requested service. zoneID is mandatory and the consumer must have access to that zone.

The example above posts to Stockholm (zoneID 1). Use -L so curl follows any redirects. Set Content-Type to application/xml on every request. Place the XML body in request.xml, using one of the service request samples below.

See the SIRI GitHub description of the XML schema v2.2.

HTTPS request

POST https://api.voiapp.io/huginn/siriv2/{zoneID}

Path parameters

parameterdescriptionpresence
zoneIDThe zone id for the requested SIRI feedrequired

Header parameters

KeyValuepresence
X-Access-Tokenyour-api-keyrequired
Content-Typeapplication/xmlrequired

Vehicle Monitoring

A Vehicle Monitoring request body.

<?xml version="1.0" encoding="UTF-8"?>
<Siri xmlns="http://www.siri.org.uk/siri" version="2.0">
<ServiceRequest>
<RequestTimestamp>2026-08-25T11:00:00Z</RequestTimestamp>
<RequestorRef>NADER</RequestorRef>
<MessageIdentifier>vm-req-1</MessageIdentifier>
<VehicleMonitoringRequest version="2.0">
<RequestTimestamp>2026-08-25T11:00:00Z</RequestTimestamp>
</VehicleMonitoringRequest>
</ServiceRequest>
</Siri>

Vehicle Monitoring (SIRI-VM) returns the current location and status of vehicles in the zone.

See the SIRI GitHub description of Vehicle Monitoring v2.2.

Situation Exchange

A Situation Exchange request body.

<?xml version="1.0" encoding="UTF-8"?>
<Siri xmlns="http://www.siri.org.uk/siri" version="2.0">
<ServiceRequest>
<RequestTimestamp>2026-08-25T11:00:00Z</RequestTimestamp>
<RequestorRef>NADER</RequestorRef>
<MessageIdentifier>sx-req-1</MessageIdentifier>
<SituationExchangeRequest version="2.0">
<RequestTimestamp>2026-08-25T11:00:00Z</RequestTimestamp>
</SituationExchangeRequest>
</ServiceRequest>
</Siri>

Situation Exchange (SIRI-SX) returns data about situations caused by planned and unplanned incidents and events.

See the SIRI GitHub description of Situation Exchange v2.2.

Facility Monitoring

A Facility Monitoring request body.

<?xml version="1.0" encoding="UTF-8"?>
<Siri xmlns="http://www.siri.org.uk/siri" version="2.0">
<ServiceRequest>
<RequestTimestamp>2026-08-25T11:00:00Z</RequestTimestamp>
<RequestorRef>NADER</RequestorRef>
<MessageIdentifier>fm-req-1</MessageIdentifier>
<FacilityMonitoringRequest version="2.0">
<RequestTimestamp>2026-08-25T11:00:00Z</RequestTimestamp>
</FacilityMonitoringRequest>
</ServiceRequest>
</Siri>

Facility Monitoring (SIRI-FM) returns information about alterations to the availability of facilities for passengers.

See the SIRI GitHub description of Facility Monitoring v2.2.