Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vangrid.io/llms.txt

Use this file to discover all available pages before exploring further.

The Vangrid Enterprise Spatial API is a REST API that exposes the full power of the Vangrid edge network to your applications. Use it to query real-time spatial observations for any area of interest, ingest data from your own sensors, and subscribe to live ground truth streams.

Base URL

All API requests are made to:
https://api.vangrid.io/v1

Authentication

Every request requires a Bearer token in the Authorization header:
Authorization: Bearer your-api-key
See API Authentication for details on obtaining and managing your API key.

Request and response format

All request bodies and responses use JSON. Set Content-Type: application/json on requests with a body. Successful responses return HTTP 200 with a JSON body. Errors return the appropriate HTTP status code and a JSON error object:
{
  "error": "error_code",
  "message": "Human-readable description of the error."
}

Rate limits

Rate limits depend on your plan tier. The current limit is included in every response via headers:
HeaderDescription
X-RateLimit-LimitMaximum requests per minute
X-RateLimit-RemainingRequests remaining in the current window
X-RateLimit-ResetUnix timestamp when the window resets
When you exceed your rate limit, the API returns 429 Too Many Requests.

Endpoints

Spatial Queries

Query ground truth observations for a geographic area of interest.

Data Ingestion

Submit observations from your own sensors into the Vangrid network.

Streaming

Subscribe to real-time ground truth updates for a defined zone.

Authentication

Manage API keys and understand authentication requirements.

Common error codes

CodeHTTP statusMeaning
unauthorized401Missing or invalid API key
region_not_authorized403AOI outside your authorized regions
invalid_geometry400Malformed GeoJSON in request
aoi_too_large400Area of interest exceeds maximum size
rate_limit_exceeded429Too many requests
internal_error500Unexpected server error — contact support
To request access or upgrade your plan, contact hello@vangrid.io.