Quick reference
A one-page reference for GEM commands, endpoints, and common operations.
API endpoints
Private Data Gateway API
| Method | Endpoint | Description |
|---|
GET | /maps/orbis/platform/private-gateway/storages | List all storages |
GET | /maps/orbis/platform/private-gateway/storages/{id} | Get storage details |
GET | /maps/orbis/platform/private-gateway/storages/{id}/credentials | Get storage credentials |
Base URL: https://api.tomtom.com
GEM API
| Method | Endpoint | Description |
|---|
POST | /maps/orbis/platform/gem/jobs | Create matching job |
GET | /maps/orbis/platform/gem/jobs | List all jobs |
GET | /maps/orbis/platform/gem/jobs/{job_id} | Get job details |
Base URL: https://api.tomtom.com
Every API request must include:
-H "tomtom-api-key: YOUR_API_KEY"
-H "Authorization: Bearer YOUR_AUTH_TOKEN"
-H "Content-Type: application/json"
Azure CLI commands
Authentication
Get authorization token
az account get-access-token --scope https://gem.core.orbis.tomtom.com/user_impersonation
Authorize to access storage with obtained credentials
az login --service-principal \
--password <CLIENT_SECRET> \
Data upload
--account-name <STORAGE_ACCOUNT> \
--container-name <CONTAINER> \
--name <FILENAME>.parquet \
--file /path/to/local/file.parquet \
Results download
az storage blob download \
--account-name <STORAGE_ACCOUNT> \
--container-name <CONTAINER> \
--name predictions.parquet \
--file /path/to/destination/predictions.parquet \
Input data schema
| Field | Type | Required | Description |
|---|
id | integer or string | ✅ | Unique road segment identifier |
is_navigable | boolean | ✅ | Whether road is navigable |
geometry | string (WKT) | ✅ | LineString geometry |
Example:
{"id": 5707295, "is_navigable": true, "geometry": "LINESTRING (4.89 52.37, 4.90 52.38)"}
Output data schema
| Field | Type | Description |
|---|
id | string | Your original road segment ID |
gers | string | Matched GERS ID (UUID format) |
confidence | integer | Match confidence score (0-100) |
lr_id | string | Linear reference: coordinates and GERS ID |
lr_gers | string | Linear reference: distance range and original ID |
Example:
{"id":"abc","gers":"550e8400-e29b-41d4-a716-446655440000","confidence":99,"lr_id":"52.0197-76.36744#550e8400-e29b-41d4-a716-446655440000","lr_gers":"0.0-100.0#abc"}
Job statuses
| Status | Description |
|---|
REQUESTED | Job was requested and is waiting to be processed |
IN_PROGRESS | Job has started and is currently being executed |
FAILED | Job encountered an error during the execution |
SUCCESS | Job finished successfully |
Common curl examples
List storages
curl -X GET "https://api.tomtom.com/maps/orbis/platform/private-gateway/storages" \
-H "tomtom-api-key: $TOMTOM_API_KEY" \
-H "Authorization: Bearer $AUTH_TOKEN"
Get storage credentials
curl -X GET "https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/$STORAGE_ID/credentials" \
-H "tomtom-api-key: $TOMTOM_API_KEY" \
-H "Authorization: Bearer $AUTH_TOKEN"
Create matching job
curl -X POST "https://api.tomtom.com/maps/orbis/platform/gem/jobs" \
-H "tomtom-api-key: $TOMTOM_API_KEY" \
-H "Authorization: Bearer $AUTH_TOKEN" \
-H "Content-Type: application/json" \
"storage_id": "storage-001",
"filename": "my_data.parquet",
"job_type": "ROAD_MATCHING",
"overture_release": "2026-01-21.0"
Check job status
curl -X GET "https://api.tomtom.com/maps/orbis/platform/gem/jobs/$JOB_ID" \
-H "tomtom-api-key: $TOMTOM_API_KEY" \
-H "Authorization: Bearer $TOKEN"
Processing time estimates
| Dataset size | Estimated time |
|---|
| < 10,000 roads | Minutes |
| 10,000 - 100,000 | 1-2 hours |
| 100,000 - 1M | 10-15 hours |
| > 1M roads | Contact support |
Rate limits
- Default: 10 requests per second
- Exceeded: Returns
429 Too Many Requests
Quality thresholds
| Match rate | Quality |
|---|
| > 85% | Excellent |
| 70-85% | Good |
| < 70% | Review data quality |
Error codes
| Code | Meaning | Solution |
|---|
401 | Unauthorized | Check API key and token |
403 | Forbidden | Verify permissions |
404 | Not Found | Check resource ID |
422 | Invalid request | Validate input parameters |
429 | Rate limited | Wait and retry |
Resources