Beta APIs

[beta] Forward geocode an address

Forward-geocodes a free-form address string. Does not create or update a Place. Returns geocode candidates with cursor pagination.

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Places under the Places category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/places/geocode

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

addressstring required

Address string to forward-geocode (URL-encoded). Required; must be non-empty.

afterstring

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limitinteger

The limit for how many objects will be in the response. Default 5, max 20.

Response

OK response.

Example response

{
  "data": [
    {
      "latitude": 37.8044,
      "longitude": -122.2712
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.