Hivemapper Data APIs (1.2.0)
Download OpenAPI specification:Download
Routes requiring Basic authorization use username:apikey, where username is account username and password is the account's active API Key to use
Access imagery for a specific week
Query imagery contained by a GeoJSON (Multi)Polygon for a given week
Authorizations:
BasicAuth
query Parameters
| week | string Example: week=2023-10-31 YYYY-mm-dd of a day in the week to query |
Request Body schema: application/jsonrequired
GeoJSON (Multi)Polygon
| type | string Polygon or MultiPolygon |
| coordinates | Array of numbers[ items[ items <float64 >[ items <float64 > ] ] ] |
Responses
Request samples
- Payload
- JavaScript
- Python
Content type
application/json
{- "type": "Polygon",
- "coordinates": [
- [
- [
- -122.48185591741223,
- 37.76910370072376
]
]
]
}Response samples
- 200
Content type
application/json
{- "frames": [
- {
- "timestamp": "2023-11-09T02:30:48.974Z",
- "sequence": "60cb39e7cce2931a8cd2fa2d",
- "idx": 0,
- "device": "hdc",
- "position": {
- "lat": 37.76910370072376,
- "lat_ref": "n",
- "lon": -122.48185591741223,
- "lon_ref": "e",
- "gdop": 0.123,
- "hdop": 0.123,
- "pdop": 0.123,
- "eph": 0.123
}, - "width": 2028,
- "height": 1024,
- "imu": {
- "acc_x": 0.123,
- "acc_y": 0.123,
- "acc_z": 0.123,
- "gyro_x": 0.123,
- "gyro_y": 0.123,
- "gyro_z": 0.123
}
}
], - "creditsUsed": 42,
- "creditsRemaining": 1000000
}Access latest imagery
Query latest contained by a GeoJSON (Multi)Polygon
Authorizations:
BasicAuth
query Parameters
| min_week | string Example: min_week=2023-10-31 YYYY-mm-dd of a day in the week to use as cutoff |
Request Body schema: application/jsonrequired
GeoJSON (Multi)Polygon
Array of objects (ImageryResults) | |
| creditsUsed | integer Number of credits consumed by query |
| creditsRemaining | integer Number of credits remaining |
Responses
Request samples
- Payload
- JavaScript
- Python
Content type
application/json
{- "frames": [
- {
- "timestamp": "2023-11-09T02:30:48.974Z",
- "sequence": "60cb39e7cce2931a8cd2fa2d",
- "idx": 0,
- "device": "hdc",
- "position": {
- "lat": 37.76910370072376,
- "lat_ref": "n",
- "lon": -122.48185591741223,
- "lon_ref": "e",
- "gdop": 0.123,
- "hdop": 0.123,
- "pdop": 0.123,
- "eph": 0.123
}, - "width": 2028,
- "height": 1024,
- "imu": {
- "acc_x": 0.123,
- "acc_y": 0.123,
- "acc_z": 0.123,
- "gyro_x": 0.123,
- "gyro_y": 0.123,
- "gyro_z": 0.123
}
}
], - "creditsUsed": 42,
- "creditsRemaining": 1000000
}Response samples
- 200
Content type
application/json
{- "frames": [
- {
- "timestamp": "2023-11-09T02:30:48.974Z",
- "sequence": "60cb39e7cce2931a8cd2fa2d",
- "idx": 0,
- "device": "hdc",
- "position": {
- "lat": 37.76910370072376,
- "lat_ref": "n",
- "lon": -122.48185591741223,
- "lon_ref": "e",
- "gdop": 0.123,
- "hdop": 0.123,
- "pdop": 0.123,
- "eph": 0.123
}, - "width": 2028,
- "height": 1024,
- "imu": {
- "acc_x": 0.123,
- "acc_y": 0.123,
- "acc_z": 0.123,
- "gyro_x": 0.123,
- "gyro_y": 0.123,
- "gyro_z": 0.123
}
}
], - "creditsUsed": 42,
- "creditsRemaining": 1000000
}Access query history
Fetch history of API queries
Authorizations:
BasicAuth
query Parameters
| limit | integer Example: limit=100 Max results to return |
| skip | integer Results to skip |
Responses
Response samples
- 200
Content type
application/json
{- "history": [
- {
- "area": 101.123,
- "credits": 4,
- "payload": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- -122.48185591741223,
- 37.76910370072376
]
]
]
}, - "timestamp": "2023-11-09T03:09:40.131Z",
- "weeks": [
- "2023-10-31"
]
}
]
}