Geocode An Address

Developing

POST

/api/v1/public/geocode

Resolves a free-text address to coordinates and returns the canonical address, Street View stills, and risk signals such as geocode precision, Street View availability and nearby landmarks. The wallet is debited on every call, including cache hits, and the fee varies with the returned riskSignals.riskLevel per the company's configured address pricing. Nothing is stored against a customer — use the customer geocode endpoint for that.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Address resolved and the wallet debited.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/public/geocode' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "fullAddress": "12 Adeola Odeku Street, Victoria Island, Lagos"
}'

Response Example

200 - Example 1

{
    "status": true,
    "message": "Operation successful.",
    "data": {
        "latitude": 6.4281,
        "longitude": 3.4219,
        "formattedAddress": "12 Adeola Odeku St, Victoria Island, Lagos, Nigeria",
        "addressImages": [
            {
                "heading": 90,
                "imageUrl": "http://example.com"
            }
        ],
        "billingInfo": {
            "wasCharged": true,
            "amount": "50.00",
            "currency": "NGN",
            "note": "Address geocode charge"
        },
        "riskSignals": {
            "riskLevel": "Low",
            "locationType": "ROOFTOP",
            "streetViewAvailable": true,
            "streetViewDate": "2023-03",
            "reverseGeocodeMatch": true,
            "streetNumber": "string",
            "route": "string",
            "neighbourhood": "string",
            "lga": "Ikeja",
            "state": "Lagos",
            "country": "Nigeria",
            "postalCode": "string",
            "nearbyPlaces": [
                {
                    "name": "Ikeja City Mall",
                    "category": "shopping_mall",
                    "vicinity": "Obafemi Awolowo Way, Ikeja",
                    "distanceMetres": 180
                }
            ]
        }
    }
}

Modified at 2026-08-06 11:58:31

Create And Geocode A Customer

Submit A Bulk Geocode Job