{"id":20594472,"url":"https://github.com/byteplant/address-validator-net","last_synced_at":"2025-07-16T01:33:59.715Z","repository":{"id":2588175,"uuid":"46783155","full_name":"byteplant/address-validator-net","owner":"byteplant","description":"NodeJS wrapper for the address-validator.net API","archived":false,"fork":false,"pushed_at":"2023-01-04T00:46:34.000Z","size":302,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-14T22:19:12.296Z","etag":null,"topics":["address","address-autocomplete","address-cleaning","address-matching","address-validation","address-verification","autocomplete","byteplant","cleaning","cleaning-data","data-quality","data-validation","javascript","node-js","node-module","typescript","validation","verification","wrapper"],"latest_commit_sha":null,"homepage":"https://www.address-validator.net/api.html","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/byteplant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-24T10:06:05.000Z","updated_at":"2023-12-01T08:00:37.000Z","dependencies_parsed_at":"2023-01-13T12:30:13.582Z","dependency_job_id":null,"html_url":"https://github.com/byteplant/address-validator-net","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byteplant%2Faddress-validator-net","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byteplant%2Faddress-validator-net/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byteplant%2Faddress-validator-net/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byteplant%2Faddress-validator-net/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/byteplant","download_url":"https://codeload.github.com/byteplant/address-validator-net/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248979239,"owners_count":21192926,"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":["address","address-autocomplete","address-cleaning","address-matching","address-validation","address-verification","autocomplete","byteplant","cleaning","cleaning-data","data-quality","data-validation","javascript","node-js","node-module","typescript","validation","verification","wrapper"],"created_at":"2024-11-16T08:09:07.566Z","updated_at":"2025-04-14T23:32:52.099Z","avatar_url":"https://github.com/byteplant.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# address-validator-net\r\n\r\nA library providing a wrapper for [api.address-validator.net](https://www.address-validator.net/api.html)\r\n\r\n## Installation\r\n\r\n```shell\r\nnpm install address-validator-net\r\n```\r\n\r\n## Usage\r\n\r\nThe API supports Address Autocomplete and Address Validation.\r\n\r\n1) Address Autocomplete (https://www.address-validator.net/api.html#address-autocomplete-api)\r\n\r\n```js\r\nimport AddressValidator from 'address-validator-net'\r\n\r\n// YOUR_API_KEY is a string\r\nconst { autocomplete, retrieve, validate } = AddressValidator(YOUR_API_KEY)\r\n\r\nconst responseObject1 = await autocomplete({ Query: 'Mühlenstraße 26, Ocholt' }) // searches for autocompletions\r\n\r\n/*\r\n  responseObject1 looks like this:\r\n  {\r\n    status: UNVERIFIED or error: DELAYED, RATE_LIMIT_EXCEEDED, API_KEY_INVALID_OR_DEPLETED\r\n    results: [\r\n      {\r\n        description: 'Große Mühlenstraße 26, 26655 Westerstede, Niedersachsen',\r\n        id: 'WVR7sXOZ8BbhnDYygzULO6Efzk-ax359UQ',\r\n      },\r\n      {\r\n        description: 'Mühlenstraße 26, 26655 Westerstede, Niedersachsen',\r\n        id: 'WFR7sEMtAp2323YTbCGdecjpUk-ax35tEA',\r\n      },\r\n    ],\r\n  }\r\n\r\n  =\u003e https://www.address-validator.net/api.html#address-autocomplete-api\r\n\r\n*/\r\n\r\n// Now we can retrieve the resultId the user selected:\r\nconst responseObject2 = await retrieve({\r\n  ID: 'WFR7sEMtAp2323YTbCGdecjpUk-ax35tEA',\r\n}) // retrieves the suggested address\r\n\r\n/*\r\n  responseObject2 looks like this:\r\n  {\r\n    status: UNVERIFIED or error: DELAYED, RATE_LIMIT_EXCEEDED, API_KEY_INVALID_OR_DEPLETED\r\n    addressline1: 'Mühlenstraße 26',\r\n    addressline3: '26655 Westerstede',\r\n    city: 'Westerstede',\r\n    country: 'DE',\r\n    formattedaddress: 'Mühlenstraße 26,26655 Westerstede',\r\n    postalcode: '26655',\r\n    state: 'Niedersachsen',\r\n    street: 'Mühlenstraße',\r\n    streetnumber: '26',\r\n  }\r\n*/\r\n```\r\n2) Address Validation (https://www.address-validator.net/api.html#address-validation-api)\r\n\r\n```js\r\nconst responseObject = await validate({\r\n  City: 'Ocholt',\r\n  CountryCode: 'de',\r\n  PostalCode: '26655',\r\n  StreetAddress: 'Mühlenstraße 26',\r\n}) // validates the provided address\r\n\r\n/*\r\n  responseObject looks like this:\r\n  {\r\n    status: VALID, SUSPECT, INVALID or error: DELAYED, RATE_LIMIT_EXCEEDED, API_KEY_INVALID_OR_DEPLETED\r\n    addressline1: 'Mühlenstr. 26',\r\n    addressline3: '26655 Westerstede',\r\n    city: 'Westerstede',\r\n    country: 'DE',\r\n    formattedaddress: 'Mühlenstr. 26,26655 Westerstede',\r\n    postalcode: '26655',\r\n    state: 'Niedersachsen',\r\n    street: 'Mühlenstr.',\r\n    streetnumber: '26',\r\n  }\r\n\r\n  =\u003e https://www.address-validator.net/api.html#address-validation-api\r\n\r\n*/\r\n```\r\n\r\n## Tests\r\n\r\n```shell\r\nnpm test\r\n```\r\n\r\n## Release History\r\n\r\n- 2.0.0 Rewrite in Typescript and using Promises\r\n- 0.1.0 Initial release\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbyteplant%2Faddress-validator-net","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbyteplant%2Faddress-validator-net","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbyteplant%2Faddress-validator-net/lists"}