Skip to content

AmigoGeocoder API

Geocoding proxy service for AmigoCloud customers. Provides secure, rate-limited access to geocoding services with a normalized response format.

Quick Start

Base URL:

https://geocoder.amigocloud.com/api/v1/{customer_uuid}/

Example request:

curl -X POST https://geocoder.amigocloud.com/api/v1/{customer_uuid}/geocode/ \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"address": "1600 Amphitheatre Parkway, Mountain View, CA", "country": "USA"}'

Example response:

{
  "results": [
    {
      "label": "1600 Amphitheatre Pkwy, Mountain View, CA 94043, United States",
      "position": { "lat": 37.42249, "lng": -122.08473 },
      "address": {
        "house_number": "1600",
        "street": "Amphitheatre Pkwy",
        "city": "Mountain View",
        "state": "California",
        "state_code": "CA",
        "postal_code": "94043",
        "country": "United States",
        "country_code": "USA"
      },
      "result_type": "house_number",
      "relevance": 1.0
    }
  ],
  "provider": "locationiq",
  "cached": false
}

Available Endpoints

Endpoint Method Description
/{uuid}/geocode/ POST Convert addresses to coordinates
/{uuid}/reverse/ POST Convert coordinates to addresses
/{uuid}/autocomplete/ POST Complete partial addresses
/{uuid}/usage/ GET View usage statistics and quotas
/{uuid}/dashboard/ GET Visual usage dashboard (browser-friendly)

Key Conventions

  • Country codes: ISO 3166-1 alpha-3 (e.g., USA, CHL, MEX)
  • Language codes: BCP47 (e.g., en-US, es-CL)
  • Authentication: X-API-Key header on every request
  • Response format: Normalized JSON envelope with results, provider, and cached fields