RoadScope API Reference
139 documented endpoints across 13 route families — surveys, POIs, routes, webhooks, connectors, AI import, MeasurePRO, ProfilingPRO and MCP credentials.
Base URL https://roadscope.app · API version 1.0.0 · generated from the OpenAPI specification.
ProfilingPRO legacy API /api/profilingpro is deprecated — sunset 2027-01-01
Deprecated since 2026-09-01. Legacy ppro_ keys keep working until 2027-01-01; after that date every /api/profilingpro call is rejected. New integrations must use /api/ppro/v1 (Firebase ID token). Every legacy response includes a deprecation object and GET /api/profilingpro/deprecation returns the schedule.
Getting Started
Authentication
Each route family declares which credential it accepts. All credentials are created from your RoadScope account and sent on every request:
ApiKeyAuthX-API-Key headerAPI key for programmatic access. Contact support to obtain an API key.
IntegrationKeyAuthHTTP bearerIntegration API key (`sk_…`) created at POST /api/soltecnav/api-keys, sent as `Authorization: Bearer <key>`. Scopes are attached to the key.
MeasureProKeyAuthHTTP bearerMeasurePRO device key (`mpro_…`) created at POST /api/measurepro/api-keys, sent as `Authorization: Bearer <key>`.
LegacyProfilingProKeyAuthHTTP bearerDeprecated ProfilingPRO legacy key (`ppro_…`). Rejected after the 2027-01-01 sunset; migrate to /api/ppro/v1 (Firebase ID token).
McpKeyAuthHTTP bearerMCP credential: personal key (`rsk_live_…`), shared-map token (`rsk_share_…`) or an OAuth access token issued by the MCP authorization server.
FirebaseAuthHTTP bearerFirebase ID token for user authentication
First request
Create an API key at POST /api/v1/api-management/keys (signed in), then list your surveys:
curl "https://roadscope.app/api/v1/data/surveys" \
-H "X-API-Key: YOUR_API_KEY"Errors and rate limits
Errors return JSON with error, message and optional details fields. Rate-limited requests answer 429 with a Retry-After header. Limits depend on the credential and key configuration.
Endpoint Reference
Path parameters are shown in braces. Expand an endpoint for parameters, authentication and code samples.
Public Data API v1
Read-only survey and route data for TMS and external systems. Authenticate with an X-API-Key issued from API Management (scope surveys:read or api:read) or a Firebase ID token.
Base paths: /api/v1/data· Auth: X-API-Key header or Firebase ID token (Bearer)
Integration API v1 (surveys, POIs, navigation, QR export)
Scoped integration endpoints used by field and navigation partners: survey summary, route geometry, POI listing and updates, navigation session upload and QR-code export. Authenticate with an integration key created at /api/soltecnav/api-keys, sent as Authorization: Bearer <key>.
Base paths: /api/v1/surveys/api/v1/navigation-sessions/api/v1/export· Auth: Integration key sk_… (Bearer)
Integration API keys
Create, list and revoke the scoped bearer keys accepted by the Integration API v1. Requires a signed-in RoadScope user (Firebase ID token).
Base paths: /api/soltecnav/api-keys· Auth: Firebase ID token (Bearer)
API Management (X-API-Key keys)
Manage the X-API-Key credentials accepted by the Public Data API v1: create, list, inspect usage, regenerate and revoke keys.
Base paths: /api/v1/api-management· Auth: Firebase ID token (Bearer)
Webhooks
Register webhook endpoints, browse event types and sample payloads, inspect deliveries, send test events and trigger events on demand.
Base paths: /api/v1/webhooks· Auth: Firebase ID token (Bearer)
Connectors
Configure and run external-system connectors (registry, configurations, test, execute, usage, cancel).
Base paths: /api/v1/connectors· Auth: Firebase ID token (Bearer)
AI Import
Import profiles, POI-type mappings and reusable import templates that drive the AI Import Wizard.
Base paths: /api/v1/ai/api/v1/ai-import· Auth: Firebase ID token (Bearer)
MeasurePRO API
Device-facing API used by MeasurePRO field units: key validation, survey preparation and pairing, POI/route/file sync, collaborators and company map policies. Device calls authenticate with a MeasurePRO key (Authorization: Bearer mpro_…); key management uses a Firebase ID token.
Base paths: /api/measurepro· Auth: MeasurePRO key mpro_… (Bearer) or Firebase ID token (Bearer)
MeasurePRO coverage network
Public coverage map of MeasurePRO-equipped survey companies, coverage requests and the office-side company profile.
Base paths: /api/measurepro-coverage· Auth: Firebase ID token (Bearer)
ProfilingPRO API v1
Current ProfilingPRO transfer API: device registration, profile lifecycle, paged points/POIs, events, sections, PPP jobs and journal uploads. Authenticate with a Firebase ID token (Authorization: Bearer <idToken>); legacy ppro_ keys are rejected. Errors use {error, code, correlationId}.
Base paths: /api/ppro/v1· Auth: Firebase ID token (Bearer)
ProfilingPRO legacy API (deprecated)Deprecated
Legacy ProfilingPRO transfer API. Deprecated since 2026-09-01, sunset 2027-01-01. Responses carry Deprecation, Sunset and Link (successor-version) headers plus a JSON "deprecation" object. Migrate to /api/ppro/v1.
Base paths: /api/profilingpro· Auth: Legacy ProfilingPRO key ppro_… (Bearer)
MCP (Model Context Protocol)
Connect AI assistants to RoadScope over MCP: the JSON-RPC endpoint plus personal MCP keys and per-shared-map MCP tokens.
Base paths: /mcp/api/mcp/api/shared-maps/:shareId/mcp-tokens· Auth: MCP key / token (Bearer) or Firebase ID token (Bearer)
API documentation
Machine-readable OpenAPI specification, Postman collection and documentation health.
Base paths: /api/docs
Ready to integrate?
Sign in to create API keys, webhooks and connector configurations, or contact us for integration support.