/ 
Address-PostCode-UK-0.18
River stage zero No dependents
/ Address::PostCode::UK

NAME

Address::PostCode::UK - Interface to the UK PostCode.

VERSION

Version 0.18

DESCRIPTION

Interface to the API provided by UK Postcodes.

NOTE

Data may be used under the terms of the OS OpenData licence. Northern Ireland postcode data may be used under the terms of the ONSPD licence. Currently, there are no limitations on usage, but they may introduce rate limiting in future.

METHODS

details()

It returns an object of type Address::PostCode::UK::Place on success. The only parameter requires is the post code.

use strict; use warnings;
use Address::PostCode::UK;

my $address   = Address::PostCode::UK->new;
my $post_code = 'Post Code';
my $place     = $address->details($post_code);

print "Latitude : ", $place->geo->lat, "\n";
print "Longitude: ", $place->geo->lng, "\n";

nearest()

It returns ref to a list of objects of type Address::PostCode::UK::Location on success. The required parameters are the post code and distance in miles.

use strict; use warnings;
use Address::PostCode::UK;

my $address   = Address::PostCode::UK->new;
my $post_code = 'Post Code';
my $distance  = 1;
my $locations = $address->nearest($post_code, $distance);

print "Location Latitude : ", $locations->[0]->lat, "\n";
print "Location Longitude: ", $locations->[0]->lng, "\n";

AUTHOR

Mohammad S Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/manwar/Address-PostCode-UK

BUGS

Please report any bugs or feature requests to bug-address-postcode-uk at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Address-PostCode-UK. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Address::PostCode::UK

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2014 - 2015 Mohammad S Anwar.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.