Mappers API
Introduction
The Mappers API is a set of HTTP requests used for submitting data to the Mappers project. Data submitted is viewable on mappers.helium.com and updated in real time.
Authentication
There is currently no authentication required.
Ingest Uplink
POST https://mappers.helium.com/api/v1/ingest/uplink
Submit geo tagged device uplink.
Content-Type: application/json
Requests are intended to be sent from an HTTP integration within Console. Metadata from the standard JSON message is used in addition to the required fields detailed below.
All required fields are case sensitive and must be in the top level of the decoded payload section as shown below:
"decoded": {
"payload" : {
"accuracy": 2,
"altitude": 2,
"latitude": 38.811706,
"longitude": -121.607035
}
}
All of the following fields are required latitude
, longitude
, altitude
, accuracy
.
- Request
- Response
Body Parameters
Parameter Name | Type | Description | Expected Unit | Example |
---|---|---|---|---|
latitude | float | Device Latitude Value | Decimal Degrees | 37.79518664339426 |
longitude | float | Device Longitude Value | Decimal Degrees | -122.39384483747301 |
altitude | int | Device Altitude Value | Meters | 10 |
accuracy | float | Device GPS Accuracy Value | Meters | 2.3 |
200: OK Request submission successful
Success
400: Bad Request Required request parameters not found.
Invalid Fields