NRnrfcloud
Wi-Fi Location

GetLocationFromWifiNetworks

<div class="nrf-note"> <p><b>Cloud-to-cloud — authorize with an Organization Auth Token.</b><br><code>https://api.location.nrfcloud.com/v1/organizations/{organizationSlug}/projects/{projectSlug}/location/wifi</code></p> <p><b>Device-to-cloud — authorize with a JSON Web Token.</b><br><code>https://api.location.nrfcloud.com/v1/location/wifi</code></p> </div> <div style="background-color: #fff3cd; color: #856404; text-align: center; border: 1px solid #ffeeba; border-radius: .25rem; padding: .75rem 1.25rem">This endpoint has an alternative. See the <a href="#tag/Ground-Fix">ground fix endpoint</a> for more details.</div> Get location based on nearby Wi-Fi networks. At least two access points with valid MAC addresses are required. An empty `accessPoints` array is treated the same as an omitted field.
post/location/wifi

Request

Query parameters

boolean
OR
number double
hiConfboolean

nRF Cloud automatically uses a 68% confidence interval when estimating the Horizontal Positioning Error (HPE) for a location. This means that there is a 68% probability that the device's actual location is within the HPE radius of the returned coordinates. Enabling this flag will use a 95% confidence interval instead, resulting in a larger HPE radius, and a higher probability that the device's actual location is within the circle.

Headers

x-custom-device-idstring

User-defined device ID, used to identify requests when using a cloud-to-cloud integration. Ignored if using a device token.

Example:my-device-12345

Request body

Example request

{
  "accessPoints": [
    {
      "macAddress": "FE:1E:41:2D:9E:53",
      "signalStrength": -42,
      "age": 500,
      "frequency": 2412
    }
  ]
}

Response

Returns lat/lon coordinates and uncertainty for a device using nearby Wi-Fi networks

latnumber double required

WGS 84 geodetic grid line, north to south.

lonnumber double required

WGS 84 geodetic grid line, east to west.

uncertaintynumber double required

Radius of the uncertainty circle around the location in meters. Also known as Horizontal Positioning Error (HPE).

Example response

{
  "lat": 45.524098,
  "lon": -122.688408,
  "uncertainty": 300.5
}

Changes

No recorded changes to this operation across all 7 revisions of this API.