GSX2JSON - Google Spreadsheet to JSON API service.

Self hosting

You can download the source code here

About

One useful feature of Google Spreadsheets is the ability to access the data as JSON by using a particular feed URL. However, this is a bit fiddly to do, and the resulting JSON is pretty unreadable, with usable data buried deep inside objects.

This API connects to your spreadsheet and santizes the data, providing simple, readable JSON, that accepts queries, for you to use in your app.

Usage

First, you must publish your spreadsheet to the web, using File -> Publish To Web in your Google Spreadsheet.

You can then access your readable JSON API using the /api endpoint.

http://gsx2json.com/api?id=SPREADSHEET_ID&sheet=SHEET_NUMBER&q=QUERY

This will update live with changes to the spreadsheet.

Take a look

Parameters

id (required): The ID of your document. This is the big long aplha-numeric code in the middle of your document URL.

sheet (optional): The number of the individual sheet you want to get data from. Your first sheet is 1, your second sheet is 2, etc. If no sheet is entered then 1 is the default. Example

q (optional): A simple query string. This is case insensitive and will add any row containing the string in any cell to the filtered result. Example

[field_name] (optional): In addition to a general query, you can do a query on any of your fields by referencing the field name. This does a case insensitive match, but uses a '===' operator so must match the full string.
NOTE: The field name is based on how it appears in the returned JSON, so a field in Google Sheets that is 'My Field' should be queried as 'myfield' Example

integers (optional - default: true): Setting 'integers' to false will return numbers as a string (useful for decimal points). Example

rows (optional - default: true): Setting 'rows' to false will return only column data. Example

columns (optional - default: true): Setting 'columns' to false will return only row data. Example

Example Response

There are two sections to the returned data - Columns (containing each column as a data array), and Rows (containing each row of data as an object. 

{
    columns: {
        name: [
            "Nick",
            "Chris",
            "Barry"
        ],
        age: [
            21,
            27,
            67;
        ]
    },
    rows: [
        {
            name: "Nick",
            age: 21
        },
        {
            name: "Chris",
            age: 27
        },
        {
            name: "Barry",
            age: 67
        }
    ]
}

Notes