Get A Bulk Geocode Job

Developing

GET

/api/v1/public/geocode/bulk/{bulkRef}

Returns one bulk job with its header status and every address row, including resolved coordinates, canonical address, Street View image URLs, address components and risk level. Rows the background worker has not reached yet come back with status pending and null geocode fields. Jobs belonging to another company return 404.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

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

Path Params

Responses

🟢200

application/json

Job header and all rows returned.

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/public/geocode/bulk/' \
--header 'X-Api-Key: <api-key>'

Response Example

200 - Example 1

{
    "status": true,
    "message": "Operation successful.",
    "data": {
        "ref": {
            "bulkRef": "f167f2c8-a214-41f6-b5ed-298b411ca68e",
            "jobStatus": "pending",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "createdBy": "string",
            "totalItems": 150,
            "doneItems": 148,
            "failedItems": 2
        },
        "items": [
            {
                "id": 0,
                "bulkRef": "f167f2c8-a214-41f6-b5ed-298b411ca68e",
                "status": "pending",
                "inputAddress": "string",
                "longitude": 0,
                "latitude": 0,
                "confidence": "string",
                "formattedAddress": "string",
                "images": [
                    "http://example.com"
                ],
                "googleMapLink": "http://example.com",
                "locationType": "ROOFTOP",
                "neighbourhood": "string",
                "lga": "string",
                "state": "string",
                "country": "string",
                "postalCode": "string",
                "streetNumber": "string",
                "route": "string",
                "streetViewAvailable": true,
                "riskLevel": "Low",
                "timestamp": "2019-08-24T14:15:22.123Z",
                "createdAt": "2019-08-24T14:15:22.123Z"
            }
        ]
    }
}

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

List Bulk Geocode Jobs

Submit A Location Ping