TITLE

Client library for the OpenCage Geocoder


SUBTITLE

data

=begin data
{"type":"page","title":"","description":"","footer":"","file":"work_mods/all/Geo::Coder::OpenCage/lib/Geo/Coder/OpenCage.pm","sources":[],"node":{"type":"block","id":"Ir875ScttvU03lzCY2OlG","margin":"","name":"root","content":[{"type":"block","content":[{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"NAME\n","margin":"","content":[{"type":"text","value":"NAME\n"}],"location":{"start":{"offset":12,"line":3,"column":1},"end":{"offset":24,"line":4,"column":1}}}],"name":"head","location":{"start":{"offset":12,"line":3,"column":1},"end":{"offset":24,"line":4,"column":1}},"level":"1","id":"NAME"},{"type":"blankline"},{"text":"Geo::Coder::OpenCage - Geocode addresses with the OpenCage Geocoder API\n","margin":"","type":"para","content":[{"type":"text","value":"Geo::Coder::OpenCage - Geocode addresses with the OpenCage Geocoder API\n"}],"location":{"start":{"offset":25,"line":5,"column":1},"end":{"offset":97,"line":6,"column":1}}},{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"DESCRIPTION\n","margin":"","content":[{"type":"text","value":"DESCRIPTION\n"}],"location":{"start":{"offset":98,"line":7,"column":1},"end":{"offset":117,"line":8,"column":1}}}],"name":"head","location":{"start":{"offset":98,"line":7,"column":1},"end":{"offset":117,"line":8,"column":1}},"level":"1","id":"DESCRIPTION"},{"type":"blankline"},{"text":"This module provides an interface to the OpenCage geocoding service.\n","margin":"","type":"para","content":[{"type":"text","value":"This module provides an interface to the OpenCage geocoding service.\n"}],"location":{"start":{"offset":118,"line":9,"column":1},"end":{"offset":187,"line":10,"column":1}}},{"type":"blankline"},{"text":"For full details on the API visit L<http://geocoder.opencagedata.com/api.html>.\n","margin":"","type":"para","content":[{"type":"text","value":"For full details on the API visit "},{"content":[{"type":"text","value":"http://geocoder.opencagedata.com/api.html"}],"type":"fcode","name":"L","meta":null},{"type":"text","value":".\n"}],"location":{"start":{"offset":188,"line":11,"column":1},"end":{"offset":268,"line":12,"column":1}}},{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"SYNOPSIS\n","margin":"","content":[{"type":"text","value":"SYNOPSIS\n"}],"location":{"start":{"offset":269,"line":13,"column":1},"end":{"offset":285,"line":14,"column":1}}}],"name":"head","location":{"start":{"offset":269,"line":13,"column":1},"end":{"offset":285,"line":14,"column":1}},"level":"1","id":"SYNOPSIS"},{"type":"blankline"},{"text":"my $geocoder = Geo::Coder::OpenCage.new: api_key => $my_api_key;\nmy $result = $geocoder.geocode(\"Donostia\");\n","margin":"    ","type":"code","content":[{"type":"verbatim","value":"my $geocoder = Geo::Coder::OpenCage.new: api_key => $my_api_key;\n    my $result = $geocoder.geocode(\"Donostia\");\n"}],"location":{"start":{"offset":286,"line":15,"column":1},"end":{"offset":403,"line":17,"column":1}}},{"type":"blankline"}],"name":"pod","margin":"","config":[],"location":{"start":{"offset":0,"line":1,"column":1},"end":{"offset":413,"line":19,"column":1}},"id":"CnqEO1q-SsZgHmIp9Zft4"},{"text":"\n\n#| That's the object you'll use to interface with the OpenCage API.\n#|\n#| It has a required attribute C<api-key>,\n#| which you can obtain from http://geocoder.opencagedata.com.\nunit class Geo::Coder::OpenCage;\nuse Geo::Coder::OpenCage::Response;\nuse HTTP::UserAgent;\nuse JSON::Unmarshal;\nuse URI::Escape;\n\nhas $.endpoint = \"http://api.opencagedata.com/geocode/v1/json\";\nhas $.ua       = HTTP::UserAgent.new;\nhas $.api-key is required;\n\nmethod make-request(Str $place-name, %params) returns Str {\n    my $url = $.endpoint   ~ \"?q=\" ~ $place-name;\n    $url   ~= \"&key=\"      ~ $.api-key;\n    for %params.keys -> $k {\n        $url ~= \"&$k=\" ~ uri-escape(%params{$k})\n    }\n    my $res = $.ua.get($url);\n    return $res.content;\n}\n\n#| This method calls to the OpenCage API to obtain geocoding results for\n#| C<$place-name>. It returns an object with convenient access methods\n#| for all the data that the API returns.\n#|\n#| You can pass additional hints and requirements to the API through the\n#| slurpy C<%params> argument. The validity of these parameters will\n#| B<NOT> be verified/enforced to ensure compatibility with potential\n#| API changes. Some of the supported arguments include:\n#|\n#| C<language> – An IETF format language code (such as es for Spanish\n#| or pt-BR for Brazilian Portuguese); if this is omitted a code of en\n#| (English) will be assumed.\n#|\n#| C<country> – Provides the geocoder with a hint to the country that\n#| the query resides in. This value will help the geocoder but will not\n#| restrict the possible results to the supplied country.\n#|\n#| The country code is a 3 character code as defined by the ISO 3166-1\n#| Alpha 3 standard.\n#|\n#| As a full example:\n#|\n#|     my $result = $geocoder.geocode(\n#|         location => \"Псковская улица, Санкт-Петербург, Россия\",\n#|         language => \"ru\",\n#|         country  => \"rus\",\n#|     );\nmethod geocode(Str $place-name, *%params)\n       returns Geo::Coder::OpenCage::Response {\n    my $json = self.make-request(uri-escape($place-name), %params);\n    return unmarshal $json, Geo::Coder::OpenCage::Response;\n}\n\n#| This method, as the name suggests, call the API to obtain information\n#| about places existing under the specified coordinates (C<$lat> for\n#| lattitude, C<$lng> for longtitude). Additional C<%params> can be\n#| passed according to the same rules as in the C<geocode()> method.\nmethod reverse-geocode(Numeric $lat, Numeric $lng, *%params)\n       returns Geo::Coder::OpenCage::Response {\n    my $json = self.make-request(\"$lat+$lng\", %params);\n    return unmarshal $json, Geo::Coder::OpenCage::Response;\n}\n\n","type":"ambient","location":{"start":{"offset":413,"line":19,"column":1},"end":{"offset":3005,"line":88,"column":1}}},{"type":"block","content":[{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"AUTHOR\n","margin":"","content":[{"type":"text","value":"AUTHOR\n"}],"location":{"start":{"offset":3017,"line":90,"column":1},"end":{"offset":3031,"line":91,"column":1}}}],"name":"head","location":{"start":{"offset":3017,"line":90,"column":1},"end":{"offset":3031,"line":91,"column":1}},"level":"1","id":"AUTHOR"},{"type":"blankline"},{"text":"Tadeusz Sośnierz, C<tadeusz.sosnierz@onet.pl>\n","margin":"","type":"para","content":[{"type":"text","value":"Tadeusz Sośnierz, "},{"content":[{"type":"text","value":"tadeusz.sosnierz@onet.pl"}],"type":"fcode","name":"C"},{"type":"text","value":"\n"}],"location":{"start":{"offset":3032,"line":92,"column":1},"end":{"offset":3078,"line":93,"column":1}}},{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"COPYRIGHT AND LICENSE\n","margin":"","content":[{"type":"text","value":"COPYRIGHT AND LICENSE\n"}],"location":{"start":{"offset":3079,"line":94,"column":1},"end":{"offset":3108,"line":95,"column":1}}}],"name":"head","location":{"start":{"offset":3079,"line":94,"column":1},"end":{"offset":3108,"line":95,"column":1}},"level":"1","id":"COPYRIGHT-AND-LICENSE"},{"type":"blankline"},{"text":"Copyright 2016 Tadeusz „tadzik” Sośnierz\n","margin":"","type":"para","content":[{"type":"text","value":"Copyright 2016 Tadeusz „tadzik” Sośnierz\n"}],"location":{"start":{"offset":3109,"line":96,"column":1},"end":{"offset":3150,"line":97,"column":1}}},{"type":"blankline"},{"text":"This project is licensed under the MIT license – see the LICENSE file\nfor details.\n","margin":"","type":"para","content":[{"type":"text","value":"This project is licensed under the MIT license – see the LICENSE file\nfor details.\n"}],"location":{"start":{"offset":3151,"line":98,"column":1},"end":{"offset":3234,"line":100,"column":1}}},{"type":"blankline"}],"name":"pod","margin":"","config":[],"location":{"start":{"offset":3005,"line":88,"column":1},"end":{"offset":3244,"line":102,"column":1}},"id":"bVzYAhxZ6lrPBv-Rop5rf"}]},"publishUrl":"/mods/all/Geo::Coder::OpenCage/lib/Geo/Coder/OpenCage.pm","pluginsData":{"moduleInfo":{"meta":{"perl":"6.*","name":"Geo::Coder::OpenCage","version":"1.0","description":"Client library for the OpenCage Geocoder","test-depends":["Test"],"depends":["HTTP::UserAgent","JSON::Unmarshal","URI"],"provides":{"Geo::Coder::OpenCage":"lib/Geo/Coder/OpenCage.pm","Geo::Coder::OpenCage::Response":"lib/Geo/Coder/OpenCage/Response.pm"},"authors":["Tadeusz “tadzik” Sośnierz"],"support":{"bugtracker":"https://github.com/tadzik/Geo-Coder-OpenCage/issues","source":"git://github.com/tadzik/Geo-Coder-OpenCage.git"},"source-url":"git://github.com/tadzik/Geo-Coder-OpenCage.git"},"files":[{"file":"work_mods/all/Geo::Coder::OpenCage/lib/Geo/Coder/OpenCage.pm","publishUrl":"/mods/all/Geo::Coder::OpenCage/lib/Geo/Coder/OpenCage.pm"}],"src":"all","url":"/mods/all/Geo::Coder::OpenCage"}}}
=end data


React

    =begin React :component<RenderItem>
    =begin data
    {"type":"page","title":"","description":"","footer":"","file":"work_mods/all/Geo::Coder::OpenCage/lib/Geo/Coder/OpenCage.pm","sources":[],"node":{"type":"block","id":"Ir875ScttvU03lzCY2OlG","margin":"","name":"root","content":[{"type":"block","content":[{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"NAME\n","margin":"","content":[{"type":"text","value":"NAME\n"}],"location":{"start":{"offset":12,"line":3,"column":1},"end":{"offset":24,"line":4,"column":1}}}],"name":"head","location":{"start":{"offset":12,"line":3,"column":1},"end":{"offset":24,"line":4,"column":1}},"level":"1","id":"NAME"},{"type":"blankline"},{"text":"Geo::Coder::OpenCage - Geocode addresses with the OpenCage Geocoder API\n","margin":"","type":"para","content":[{"type":"text","value":"Geo::Coder::OpenCage - Geocode addresses with the OpenCage Geocoder API\n"}],"location":{"start":{"offset":25,"line":5,"column":1},"end":{"offset":97,"line":6,"column":1}}},{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"DESCRIPTION\n","margin":"","content":[{"type":"text","value":"DESCRIPTION\n"}],"location":{"start":{"offset":98,"line":7,"column":1},"end":{"offset":117,"line":8,"column":1}}}],"name":"head","location":{"start":{"offset":98,"line":7,"column":1},"end":{"offset":117,"line":8,"column":1}},"level":"1","id":"DESCRIPTION"},{"type":"blankline"},{"text":"This module provides an interface to the OpenCage geocoding service.\n","margin":"","type":"para","content":[{"type":"text","value":"This module provides an interface to the OpenCage geocoding service.\n"}],"location":{"start":{"offset":118,"line":9,"column":1},"end":{"offset":187,"line":10,"column":1}}},{"type":"blankline"},{"text":"For full details on the API visit L<http://geocoder.opencagedata.com/api.html>.\n","margin":"","type":"para","content":[{"type":"text","value":"For full details on the API visit "},{"content":[{"type":"text","value":"http://geocoder.opencagedata.com/api.html"}],"type":"fcode","name":"L","meta":null},{"type":"text","value":".\n"}],"location":{"start":{"offset":188,"line":11,"column":1},"end":{"offset":268,"line":12,"column":1}}},{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"SYNOPSIS\n","margin":"","content":[{"type":"text","value":"SYNOPSIS\n"}],"location":{"start":{"offset":269,"line":13,"column":1},"end":{"offset":285,"line":14,"column":1}}}],"name":"head","location":{"start":{"offset":269,"line":13,"column":1},"end":{"offset":285,"line":14,"column":1}},"level":"1","id":"SYNOPSIS"},{"type":"blankline"},{"text":"my $geocoder = Geo::Coder::OpenCage.new: api_key => $my_api_key;\nmy $result = $geocoder.geocode(\"Donostia\");\n","margin":"    ","type":"code","content":[{"type":"verbatim","value":"my $geocoder = Geo::Coder::OpenCage.new: api_key => $my_api_key;\n    my $result = $geocoder.geocode(\"Donostia\");\n"}],"location":{"start":{"offset":286,"line":15,"column":1},"end":{"offset":403,"line":17,"column":1}}},{"type":"blankline"}],"name":"pod","margin":"","config":[],"location":{"start":{"offset":0,"line":1,"column":1},"end":{"offset":413,"line":19,"column":1}},"id":"CnqEO1q-SsZgHmIp9Zft4"},{"text":"\n\n#| That's the object you'll use to interface with the OpenCage API.\n#|\n#| It has a required attribute C<api-key>,\n#| which you can obtain from http://geocoder.opencagedata.com.\nunit class Geo::Coder::OpenCage;\nuse Geo::Coder::OpenCage::Response;\nuse HTTP::UserAgent;\nuse JSON::Unmarshal;\nuse URI::Escape;\n\nhas $.endpoint = \"http://api.opencagedata.com/geocode/v1/json\";\nhas $.ua       = HTTP::UserAgent.new;\nhas $.api-key is required;\n\nmethod make-request(Str $place-name, %params) returns Str {\n    my $url = $.endpoint   ~ \"?q=\" ~ $place-name;\n    $url   ~= \"&key=\"      ~ $.api-key;\n    for %params.keys -> $k {\n        $url ~= \"&$k=\" ~ uri-escape(%params{$k})\n    }\n    my $res = $.ua.get($url);\n    return $res.content;\n}\n\n#| This method calls to the OpenCage API to obtain geocoding results for\n#| C<$place-name>. It returns an object with convenient access methods\n#| for all the data that the API returns.\n#|\n#| You can pass additional hints and requirements to the API through the\n#| slurpy C<%params> argument. The validity of these parameters will\n#| B<NOT> be verified/enforced to ensure compatibility with potential\n#| API changes. Some of the supported arguments include:\n#|\n#| C<language> – An IETF format language code (such as es for Spanish\n#| or pt-BR for Brazilian Portuguese); if this is omitted a code of en\n#| (English) will be assumed.\n#|\n#| C<country> – Provides the geocoder with a hint to the country that\n#| the query resides in. This value will help the geocoder but will not\n#| restrict the possible results to the supplied country.\n#|\n#| The country code is a 3 character code as defined by the ISO 3166-1\n#| Alpha 3 standard.\n#|\n#| As a full example:\n#|\n#|     my $result = $geocoder.geocode(\n#|         location => \"Псковская улица, Санкт-Петербург, Россия\",\n#|         language => \"ru\",\n#|         country  => \"rus\",\n#|     );\nmethod geocode(Str $place-name, *%params)\n       returns Geo::Coder::OpenCage::Response {\n    my $json = self.make-request(uri-escape($place-name), %params);\n    return unmarshal $json, Geo::Coder::OpenCage::Response;\n}\n\n#| This method, as the name suggests, call the API to obtain information\n#| about places existing under the specified coordinates (C<$lat> for\n#| lattitude, C<$lng> for longtitude). Additional C<%params> can be\n#| passed according to the same rules as in the C<geocode()> method.\nmethod reverse-geocode(Numeric $lat, Numeric $lng, *%params)\n       returns Geo::Coder::OpenCage::Response {\n    my $json = self.make-request(\"$lat+$lng\", %params);\n    return unmarshal $json, Geo::Coder::OpenCage::Response;\n}\n\n","type":"ambient","location":{"start":{"offset":413,"line":19,"column":1},"end":{"offset":3005,"line":88,"column":1}}},{"type":"block","content":[{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"AUTHOR\n","margin":"","content":[{"type":"text","value":"AUTHOR\n"}],"location":{"start":{"offset":3017,"line":90,"column":1},"end":{"offset":3031,"line":91,"column":1}}}],"name":"head","location":{"start":{"offset":3017,"line":90,"column":1},"end":{"offset":3031,"line":91,"column":1}},"level":"1","id":"AUTHOR"},{"type":"blankline"},{"text":"Tadeusz Sośnierz, C<tadeusz.sosnierz@onet.pl>\n","margin":"","type":"para","content":[{"type":"text","value":"Tadeusz Sośnierz, "},{"content":[{"type":"text","value":"tadeusz.sosnierz@onet.pl"}],"type":"fcode","name":"C"},{"type":"text","value":"\n"}],"location":{"start":{"offset":3032,"line":92,"column":1},"end":{"offset":3078,"line":93,"column":1}}},{"type":"blankline"},{"margin":"","type":"block","content":[{"type":"para","text":"COPYRIGHT AND LICENSE\n","margin":"","content":[{"type":"text","value":"COPYRIGHT AND LICENSE\n"}],"location":{"start":{"offset":3079,"line":94,"column":1},"end":{"offset":3108,"line":95,"column":1}}}],"name":"head","location":{"start":{"offset":3079,"line":94,"column":1},"end":{"offset":3108,"line":95,"column":1}},"level":"1","id":"COPYRIGHT-AND-LICENSE"},{"type":"blankline"},{"text":"Copyright 2016 Tadeusz „tadzik” Sośnierz\n","margin":"","type":"para","content":[{"type":"text","value":"Copyright 2016 Tadeusz „tadzik” Sośnierz\n"}],"location":{"start":{"offset":3109,"line":96,"column":1},"end":{"offset":3150,"line":97,"column":1}}},{"type":"blankline"},{"text":"This project is licensed under the MIT license – see the LICENSE file\nfor details.\n","margin":"","type":"para","content":[{"type":"text","value":"This project is licensed under the MIT license – see the LICENSE file\nfor details.\n"}],"location":{"start":{"offset":3151,"line":98,"column":1},"end":{"offset":3234,"line":100,"column":1}}},{"type":"blankline"}],"name":"pod","margin":"","config":[],"location":{"start":{"offset":3005,"line":88,"column":1},"end":{"offset":3244,"line":102,"column":1}},"id":"bVzYAhxZ6lrPBv-Rop5rf"}]},"publishUrl":"/mods/all/Geo::Coder::OpenCage/lib/Geo/Coder/OpenCage.pm","pluginsData":{"moduleInfo":{"meta":{"perl":"6.*","name":"Geo::Coder::OpenCage","version":"1.0","description":"Client library for the OpenCage Geocoder","test-depends":["Test"],"depends":["HTTP::UserAgent","JSON::Unmarshal","URI"],"provides":{"Geo::Coder::OpenCage":"lib/Geo/Coder/OpenCage.pm","Geo::Coder::OpenCage::Response":"lib/Geo/Coder/OpenCage/Response.pm"},"authors":["Tadeusz “tadzik” Sośnierz"],"support":{"bugtracker":"https://github.com/tadzik/Geo-Coder-OpenCage/issues","source":"git://github.com/tadzik/Geo-Coder-OpenCage.git"},"source-url":"git://github.com/tadzik/Geo-Coder-OpenCage.git"},"files":[{"file":"work_mods/all/Geo::Coder::OpenCage/lib/Geo/Coder/OpenCage.pm","publishUrl":"/mods/all/Geo::Coder::OpenCage/lib/Geo/Coder/OpenCage.pm"}],"src":"all","url":"/mods/all/Geo::Coder::OpenCage"}}}
    =end data
    =end React


root

Lightweight lookup of IPv4 address details using BIN files from http://www.ip2location.com


Geo::IP2Location::Lite


An adventure game.


Game::Crypt


=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
