The Live Roads Singapore API

Get started

Create a trial key with the form below and add it to the request. Open this in a browser, with your key at the end, and you have data:

https://liveroadssingapore.com/api/v1/incidents?road=PIE&key=lrsg_…

From code, send the key in a header instead:

curl -H "X-API-Key: lrsg_…" "https://liveroadssingapore.com/api/v1/incidents?road=BKE,AYE&type=accident,congestion&format=json"

It answers with GeoJSON, ready for a map. For plain JSON, add &format=json. CORS is open, so you can call it from a browser with no server in between.

Your key

The API is paid, and every request needs a key. The key you create here is a trial key: it works for 5 days from your first request, at 120 requests per hour, so you can see whether the API fits what you are building. To keep going after that, write to [email protected] with your project's name and intended use, and we reply with a plan and an invoice.

We ask for a name, an email and what it is for so we can tell you when an official source goes down, learn what the API is missing, and switch off a runaway loop without switching off everyone.

Plans

What a plan pays for: access to the service, meaning the API itself, its limits and support. It does not buy rights to the underlying data, which belongs to the agencies that publish it; their credits travel with every record and must be kept.

How to pay: for now, by email and invoice. Write to [email protected] with what you are building and the plan you want; we reply with an invoice and switch your key over, with no new key to install.

Parameters

One endpoint, GET /api/v1/incidents. Every parameter is optional and they combine: a request with none returns every live event in Singapore, newest first, up to the limit.

An unknown road or type, or a malformed bbox, gets a 400 that says what was wrong.

Example

Accidents on the PIE, as GeoJSON (the shape of a response; values illustrative):

GET https://liveroadssingapore.com/api/v1/incidents?road=PIE&type=accident&limit=1

{
  "type": "FeatureCollection",
  "attribution": {
    "text": "Data: Live Roads Singapore",
    "url": "https://liveroadssingapore.com"
  },
  "meta": {
    "count": 1,
    "total": 1,
    "offset": 0,
    "limit": 1,
    "generatedAt": "<ISO time>",
    "licence": "Use requires a key (5-day trial, then a paid plan). Attribution is required on every plan…",
    "sources": [
      { "id": "<source id>", "name": "Land Transport Authority (LTA DataMall)", "attribution": "<the credit line the source asks for>" }
    ]
  },
  "features": [
    {
      "type": "Feature",
      "id": "<id>",
      "geometry": { "type": "Point", "coordinates": [<lon>, <lat>] },
      "properties": {
        "id": "<id>",
        "type": "incident",
        "severity": "medium",
        "status": "active",
        "title": "Vehicle breakdown on PIE (towards Changi) after BKE",
        "description": "Vehicle Breakdown on PIE (towards Changi) after BKE.",
        "road": "PIE",
        "direction": "towards Changi",
        "location": "after BKE",
        "state": "SG",
        "closure": null,
        "overnight": false,
        "source": "<source id>",
        "sourceUrl": null,
        "reportedBy": null,
        "tz": "Asia/Singapore",
        "startedAt": "<ISO time>",
        "endsAt": null,
        "updatedAt": "<ISO time>"
      }
    }
  ]
}

With &format=json the same events come as an incidents array, each with lat and lon instead of a geometry.

What each event carries

Around the events, every response has attribution (the credit to show) and meta: count, total, offset, limit, generatedAt, the licence line, and sources, each source in the response with the credit line it asks for. The same credit goes in the X-Attribution header.

Errors

• 401 no key: every request needs one.
• 402 the trial is over. The body says when it ended and how to get a paid plan.
• 403 the key was revoked. The body says why.
• 429 too many requests, with the wait in the retry-after header.
• 400 a parameter we can't read; 503 the upstream data could not be reached (try again in a minute).

A trial key's responses carry X-API-Trial-Ends with the end of its trial, so your code can see it coming.

Limits

Trial keys: 120 requests per hour. Personal: about 10,000 a day; Professional: about 100,000 a day; Enterprise: what we agree. Counted per key, not per IP, so an app with many users is not stopped by one of them. Over the limit you get a 429; every response says where you stand in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.

Responses are cached for 30 seconds and the sources update every few minutes, so asking more than twice a minute brings nothing new.

Terms

Data: <a href="https://liveroadssingapore.com">Live Roads Singapore</a>

Building a product on the API without a paid plan, or without the attribution above, is not an authorized use. A plan pays for access to the service (the API, its limits and support); we don't own or license the underlying data, and each record's source and the credit lines in meta.sources must stay with it. The data comes from the Land Transport Authority (LTA DataMall) and, marked as news reports, from published articles, through Roadscore; readers have a right to know that an event was posted by an agency and not invented by an algorithm.

The sources' licences travel with the data. LTA's records contain information from LTA DataMall, made available under the terms of the Singapore Open Data Licence version 1.0: keep that credit wherever you show them. Each record's source tells you which applies.

Honest about coverage

The API returns what official sources published, not what is happening on the road. A road with no events in the response is not a clear road: it may be one nobody published anything about. Each expressway page (for example the PIE) shows what is live there now. If you build alerts on this, tell the people who get them. Never use it for emergency decisions: in an emergency, call 999 (police) or 995 (ambulance and fire).

Publish data instead of reading it

This page is for reading the data. If you are a road operator, a town council or an event organiser and want your closures on the map and in this API, with your agency named as the source, see partners. It is free for public agencies.

Contact

Paid plans, a lost key, a question about a field, or a source that looks wrong: [email protected].