API Reference

Geocode

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Batch geocode multiple addresses

$client->geocode->batch(list<string> addresses): GeocodeBatchResponse

POST/api/v1/geocode/batch

Batch geocode multiple addresses

ParametersExpand Collapse

addresses: list<string>

ReturnsExpand Collapse

GeocodeBatchResponse

int count

Number of addresses processed (always equals length of results)

list<GeocodeResult> results

Array of FeatureCollections, one per input address. Empty FeatureCollections indicate no match.

Batch geocode multiple addresses

PHP

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'local');

$response = $client->geocode->batch(addresses: ['string']);

var_dump($response);

200 example

{
  "count": 0,
  "results": [
    {
      "features": [
        {
          "geometry": {
            "coordinates": [
              2.3522,
              48.8566
            ],
            "type": "Point"
          },
          "properties": {
            "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom",
            "category": "restaurant",
            "city": "London",
            "confidence": 0,
            "country": "United Kingdom",
            "country_code": "GB",
            "distance_m": 0,
            "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom",
            "house_number": "221B",
            "interpolated": true,
            "name": "Eiffel Tower",
            "osm_id": 21154906,
            "osm_type": "node",
            "postcode": "NW1 6XE",
            "score": 0,
            "source": "structured",
            "state": "England",
            "street": "Baker Street",
            "subcategory": "italian",
            "tags": {
              "foo": "string"
            },
            "wikipedia": "en:Eiffel Tower"
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    }
  ]
}

Returns Examples

200 example

{
  "count": 0,
  "results": [
    {
      "features": [
        {
          "geometry": {
            "coordinates": [
              2.3522,
              48.8566
            ],
            "type": "Point"
          },
          "properties": {
            "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom",
            "category": "restaurant",
            "city": "London",
            "confidence": 0,
            "country": "United Kingdom",
            "country_code": "GB",
            "distance_m": 0,
            "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom",
            "house_number": "221B",
            "interpolated": true,
            "name": "Eiffel Tower",
            "osm_id": 21154906,
            "osm_type": "node",
            "postcode": "NW1 6XE",
            "score": 0,
            "source": "structured",
            "state": "England",
            "street": "Baker Street",
            "subcategory": "italian",
            "tags": {
              "foo": "string"
            },
            "wikipedia": "en:Eiffel Tower"
          },
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    }
  ]
}