Authentication

All LiveBy API endpoints require an API clientid and token, which are provided by your LiveBy account representative. When calling the LiveBy API, the following HTTP request headers are required:

HTTP Headers

Endpoint

<https://api.liveby.com/v3/walk-scores>

Usage

Provide your LiveBy clientid and API key in the headers of your HTTP request, and search parameters. This API returns an object with the walk, bike, and transit scores for the area.

curl -H "x-api-clientid: client" -H "x-api-key: key" '<https://api.liveby.com/v3/walk-scores?lat=47.6085&lon=-122.3295>'

Parameters (1)

Example Response

Successful:

{
    "success": true,
    "message": "scores found for lat=47.6085 & lon=-122.3295",
    "data": {
        "walk": {
            "score": 99,
            "description": "Walker's Paradise"
        },
        "bike": {
            "score": 76,
            "description": "Very Bikeable"
        },
        "transit": {
            "score": 100,
            "description": "Rider's Paradise"
        }
    }
}

Error:

{
    "success": false,
    "message": "lat and lon are required",
    "data": {
        "walk": {
            "score": "N/A",
            "description": ""
        },
        "bike": {
            "score": "N/A",
            "description": ""
        },
        "transit": {
            "score": "N/A",
            "description": ""
        }
    }
}

Unauthorized:

{"message":"Unauthorized"}

<aside> 💡 You are likely missing the x-api-key and X-API-ClientId headers on the request

</aside>