APi & Developer

If you are a developer, data analyst or you simply want to integrate our service in your programs, then you can avail of our API service. We provide RESTful and JSON-RPC end-points, both supporting GET and POST verbs. Our APIs are based on the CRUD (Create, Read, Update, Delete) approach, but ony the "read" methods are publically available and documented here.

Rate-limits may apply when calling our public APIs to balance traffic across users.

Have you found an error or having issues? Please contact us.

End-Points

We support only encrypted connections using the HTTPS protocol with TLS 1.1 or TLS 1.2.

Both GET and POST verbs share the same RESTful end-point. The URL requires the parameters [sourceCode] and [search] string.

The GET end-point requires the parameter data containing the [payload].

The POST end-point is static and the raw [payload] is passed in the request body.

Params & Payload
[sourceCode]
  • Type: string
  • Constraints: see list of supported catalogues
  • Example: data.gov.ie
[search]
  • Type: string
  • Length: between 4 and 256 chars before encoding
  • Constraints: URL encoded
  • Example: bus%20timetable%20in%20Dublin
[payload]
  • Type: JSON
  • Constraints: URL encoded for GET request only
  • Example: bus%20timetable%20in%20Dublin
{
    "jsonrpc": "2.0",
    "method": "DataSalsa.Data.Data_API.ReadQuery",
    "params": {
        "sourceCode": [sourceCode],
        "search": [search]
    }
}
[sourceCode]
  • Type: string
  • Constraints: see list of supported catalogues
  • Example: data.gov.ie
[search]
  • Type: string
  • Length: between 4 and 256 chars
  • Constraints: none
  • Example: bus timetable in Dublin
Examples

This example filters Open Data from Ireland, searching about "bus timetable in Dublin", where [sourceCode] = data.gov.ie and [search] = bus%20timetable%20in%20Dublin

The same URL applies to both GET and POST requests.

This example filters Open Data from Ireland, searching about "bus timetable in Dublin", where [sourceCode] = data.gov.ie and [search] = bus timetable in Dublin

URL for GET request with [payload] URL encoded.

URL for POST request:

POST request body with [payload].

{
    "jsonrpc": "2.0",
    "method": "DataSalsa.Data.Data_API.ReadQuery",
    "params": {
        "sourceCode": "data.gov.ie",
        "search": "bus timetable in Dublin"
    }
}