head

Geo::Coder::OpenCage - Geocode addresses with the OpenCage Geocoder API


This module provides an interface to the OpenCage geocoding service.


For full details on the API visit L<http://geocoder.opencagedata.com/api.html>.


my $geocoder = Geo::Coder::OpenCage.new: api_key => $my_api_key;
my $result = $geocoder.geocode("Donostia");




#| That's the object you'll use to interface with the OpenCage API.
#|
#| It has a required attribute C<api-key>,
#| which you can obtain from http://geocoder.opencagedata.com.
unit class Geo::Coder::OpenCage;
use Geo::Coder::OpenCage::Response;
use HTTP::UserAgent;
use JSON::Unmarshal;
use URI::Escape;

has $.endpoint = "http://api.opencagedata.com/geocode/v1/json";
has $.ua       = HTTP::UserAgent.new;
has $.api-key is required;

method make-request(Str $place-name, %params) returns Str {
    my $url = $.endpoint   ~ "?q=" ~ $place-name;
    $url   ~= "&key="      ~ $.api-key;
    for %params.keys -> $k {
        $url ~= "&$k=" ~ uri-escape(%params{$k})
    }
    my $res = $.ua.get($url);
    return $res.content;
}

#| This method calls to the OpenCage API to obtain geocoding results for
#| C<$place-name>. It returns an object with convenient access methods
#| for all the data that the API returns.
#|
#| You can pass additional hints and requirements to the API through the
#| slurpy C<%params> argument. The validity of these parameters will
#| B<NOT> be verified/enforced to ensure compatibility with potential
#| API changes. Some of the supported arguments include:
#|
#| C<language> – An IETF format language code (such as es for Spanish
#| or pt-BR for Brazilian Portuguese); if this is omitted a code of en
#| (English) will be assumed.
#|
#| C<country> – Provides the geocoder with a hint to the country that
#| the query resides in. This value will help the geocoder but will not
#| restrict the possible results to the supplied country.
#|
#| The country code is a 3 character code as defined by the ISO 3166-1
#| Alpha 3 standard.
#|
#| As a full example:
#|
#|     my $result = $geocoder.geocode(
#|         location => "Псковская улица, Санкт-Петербург, Россия",
#|         language => "ru",
#|         country  => "rus",
#|     );
method geocode(Str $place-name, *%params)
       returns Geo::Coder::OpenCage::Response {
    my $json = self.make-request(uri-escape($place-name), %params);
    return unmarshal $json, Geo::Coder::OpenCage::Response;
}

#| This method, as the name suggests, call the API to obtain information
#| about places existing under the specified coordinates (C<$lat> for
#| lattitude, C<$lng> for longtitude). Additional C<%params> can be
#| passed according to the same rules as in the C<geocode()> method.
method reverse-geocode(Numeric $lat, Numeric $lng, *%params)
       returns Geo::Coder::OpenCage::Response {
    my $json = self.make-request("$lat+$lng", %params);
    return unmarshal $json, Geo::Coder::OpenCage::Response;
}



Tadeusz Sośnierz, C<tadeusz.sosnierz@onet.pl>


This project is licensed under the MIT license – see the LICENSE file
for details.


root

README

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


OpenCage

NAME

DESCRIPTION

SYNOPSIS

AUTHOR

COPYRIGHT AND LICENSE