README.md

In location-iq/locationiq-r-client: R Package Client for LocationIQ

R API client for 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.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

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

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("caTools")

Build the package

git clone https://github.com/location-iq/locationiq-r-client
cd locationiq-r-client
R CMD build .
R CMD check locationiq_1.0.0.tar.gz
R CMD INSTALL locationiq_1.0.0.tar.gz

Install the package

install.packages("locationiq")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("location-iq/locationiq-r-client")

Usage

library(locationiq)

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

• Address
• Balance
• Daybalance
• DirectionsDirections
• DirectionsDirectionsRoutes
• DirectionsMatching
• DirectionsMatrix
• DirectionsMatrixSources
• DirectionsNearest
• DirectionsNearestWaypoints
• Error
• Location
• Matchquality
• Namedetails

Documentation for Authorization

key

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

Author

location-iq/locationiq-r-client documentation built on Feb. 28, 2020, 9:42 p.m.