{"id":16067973,"url":"https://github.com/codescheme/postcodes","last_synced_at":"2025-03-17T16:32:49.408Z","repository":{"id":56955719,"uuid":"81233970","full_name":"codescheme/postcodes","owner":"codescheme","description":"UK postcode validation. A Laravel 5+ facade/service provider for the GET methods of the API at postcodes.io","archived":false,"fork":false,"pushed_at":"2023-08-14T10:00:56.000Z","size":158,"stargazers_count":11,"open_issues_count":4,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-16T06:30:51.294Z","etag":null,"topics":["laravel","laravel-5-package","php","postcode","postcodes"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codescheme.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-07T17:18:50.000Z","updated_at":"2022-10-26T17:25:58.000Z","dependencies_parsed_at":"2022-08-21T04:10:17.864Z","dependency_job_id":null,"html_url":"https://github.com/codescheme/postcodes","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codescheme%2Fpostcodes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codescheme%2Fpostcodes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codescheme%2Fpostcodes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codescheme%2Fpostcodes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codescheme","download_url":"https://codeload.github.com/codescheme/postcodes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221697217,"owners_count":16865574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["laravel","laravel-5-package","php","postcode","postcodes"],"created_at":"2024-10-09T06:07:25.950Z","updated_at":"2024-10-27T15:19:16.588Z","avatar_url":"https://github.com/codescheme.png","language":"PHP","readme":"\n# Postcodes\n\n\nA Laravel 5+ facade/service provider for the API methods at ```postcodes.io``` - useful for UK postcode validation and reverse geocoding: that is, determining postcode from lat, long coordinates.\n**No fiddling around with api keys, authentication, necessary...**\n\nWith thanks to https://postcodes.io\n\n\n## Installation\n\n```\ncomposer require codescheme/postcodes\n```\n\nFor Laravel 5.5 *Postcodes* will be automatically discovered.\n\nEdit `/config/app.php` and add the service provider to your `providers` array.\n```php\n'providers' =\u003e [\n\tCodescheme\\Postcodes\\PostcodeServiceProvider::class,\n]\n```\n\nAlso here, add the alias:\n```php\n'aliases' =\u003e [\n\t'Postcode' =\u003e Codescheme\\Postcodes\\Facades\\Postcode::class,\n]\n```\n\n## Basic Example Laravel Usage\n\nReturn data for a given postcode\n\n```php\nRoute::get('/postcode', function(){\n    $data = Postcode::postcodeLookup('SE21 8JL');\n    print_r($data);\n    return null;      \n});\t\n```\n\n## Methods\n\n```\nPostcode::validate('SE31 9AX'); //returns boolean\nPostcode::postcodeLookup('SE21 8JL');\nPostcode::nearest('SE21 8JL');\nPostcode::reverseGeocode(-0.397913, 51.44015); // long,lat\nPostcode::autocomplete('RG1 3');\nPostcode::outcodeLookup('SE21');\n\n$postcodes = ['OX49 5NU', 'M32 0JG', 'NE30 1DP'];\nPostcode::postcodeLookupBulk($postcodes);\n\t\n$coordinates = [\n    ['longitude' =\u003e  0.629834723775309, 'latitude' =\u003e 51.7923246977375],\n    ['longitude' =\u003e -2.49690382054704, \t'latitude' =\u003e 53.5351312861402]\n    ];\nPostcode::reverseGeocodeBulk($coordinates);\n```\n\n## Testing\n\n``` bash\n$ composer test\n```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodescheme%2Fpostcodes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodescheme%2Fpostcodes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodescheme%2Fpostcodes/lists"}