Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Latest commit

 

History

History
145 lines (100 loc) · 5.56 KB

README.md

File metadata and controls

145 lines (100 loc) · 5.56 KB
Raw

locationiq

LocationIQ provides flexible enterprise-grade location based solutions. We work with developers, startups and enterprises worldwide serving billions of requests everyday. This page provides an overview of the technical aspects of our API and will help you get started.

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.0
  • Package version: 1.1.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/location-iq/locationiq-php-client.git"
    }
  ],
  "require": {
    "location-iq/locationiq-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/locationiq/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: key
$config = LocationIq\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LocationIq\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');


$apiInstance = new LocationIq\Api\AutocompleteApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$q = "Empire state"; // string | Address to geocode
$normalizecity = 1; // int | For responses with no city value in the address section, the next available element in this order - city_district, locality, town, borough, municipality, village, hamlet, quarter, neighbourhood - from the address section will be normalized to city. Defaults to 1 for SDKs.
$limit = 10; // int | Limit the number of returned results. Default is 10.
$viewbox = "-132.84908,47.69382,-70.44674,30.82531"; // string | The preferred area to find search results.  To restrict results to those within the viewbox, use along with the bounded option. Tuple of 4 floats. Any two corner points of the box - `max_lon,max_lat,min_lon,min_lat` or `min_lon,min_lat,max_lon,max_lat` - are accepted in any order as long as they span a real box.
$bounded = 1; // int | Restrict the results to only items contained with the viewbox
$countrycodes = "us"; // string | Limit search to a list of countries.
$accept_language = "en"; // string | Preferred language order for showing search results, overrides the value specified in the Accept-Language HTTP header. Defaults to en. To use native language for the response when available, use accept-language=native
$tag = "place"; // string | Restricts the autocomplete search results to elements of specific OSM class and type.  Example - To restrict results to only class place and type city: tag=place:city, To restrict the results to all of OSM class place: tag=place

try {
    $result = $apiInstance->autocomplete($q, $normalizecity, $limit, $viewbox, $bounded, $countrycodes, $accept_language, $tag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutocompleteApi->autocomplete: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://eu1.locationiq.com/v1

Class Method HTTP request Description
AutocompleteApi autocomplete GET /autocomplete.php
BalanceApi balance GET /balance.php
DirectionsApi directions GET /directions/driving/{coordinates} Directions Service
MatchingApi matching GET /matching/driving/{coordinates} Matching Service
MatrixApi matrix GET /matrix/driving/{coordinates} Matrix Service
NearestApi nearest GET /nearest/driving/{coordinates} Nearest Service
ReverseApi reverse GET /reverse.php Reverse Geocoding
SearchApi search GET /search.php Forward Geocoding

Documentation For Models

Documentation For Authorization

key

  • Type: API key
  • API key parameter name: key
  • Location: URL query string

Author