{"id":15297569,"url":"https://github.com/snapcx/avs-client","last_synced_at":"2025-08-18T09:12:12.464Z","repository":{"id":57736228,"uuid":"82852028","full_name":"snapcx/avs-client","owner":"snapcx","description":"This is java client for address validation API, hosted by snapcx.io.","archived":false,"fork":false,"pushed_at":"2017-02-23T19:51:03.000Z","size":51,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-05T14:16:19.289Z","etag":null,"topics":["address-verification","api-client","java","java-8","rest-api"],"latest_commit_sha":null,"homepage":"https://snapcx.io/addressValidation","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snapcx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-22T21:00:13.000Z","updated_at":"2017-02-23T20:57:58.000Z","dependencies_parsed_at":"2022-08-23T22:40:51.001Z","dependency_job_id":null,"html_url":"https://github.com/snapcx/avs-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/snapcx/avs-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snapcx%2Favs-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snapcx%2Favs-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snapcx%2Favs-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snapcx%2Favs-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snapcx","download_url":"https://codeload.github.com/snapcx/avs-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snapcx%2Favs-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270968989,"owners_count":24677222,"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","status":"online","status_checked_at":"2025-08-18T02:00:08.743Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-verification","api-client","java","java-8","rest-api"],"created_at":"2024-09-30T19:18:20.033Z","updated_at":"2025-08-18T09:12:12.408Z","avatar_url":"https://github.com/snapcx.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# snapCX.io Address Validation \u0026 Correction *Java* Client\n\n## Requirements\n\nBuilding the API client library requires [Maven](https://maven.apache.org/) to be installed.\n\n## Installation\n\nTo install the API client library to your local Maven repository, simply execute:\n\n```shell\nmvn install\n```\n\nTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:\n\n```shell\nmvn deploy\n```\n\nRefer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.\n\n### Maven users\n\nAdd this dependency to your project's POM:\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.snapcx\u003c/groupId\u003e\n    \u003cartifactId\u003eavs-client\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n    \u003cscope\u003ecompile\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle users\n\nAdd this dependency to your project's build file:\n\n```groovy\ncompile \"io.snapcx:avs-client:1.0.0\"\n```\n\n### Others\n\nAt first generate the JAR by executing:\n\n    mvn package\n\nThen manually install the following JARs:\n\n* target/avs-client-1.0.0.jar\n* target/lib/*.jar\n\n## Getting Started\n\n### cURL Example\n```curl\ncurl -X GET -H \"user_key: d111120ba53b07fxxxx05bc8c754a33f\" \"https://api.snapcx.io/avs/v1/validateAddress?request_id=12345\u0026street=1%20Rosedale%20Street\u0026city=baltimore\u0026state=md\u0026zipcode=08534\"\n\ncurl -X GET -H \"user_key: 777d94a03dd15c0d5782686aae88888c\" \"https://api.snapcx.io/avs/v1/validateGlobalAddress?request_id=12345\u0026street=2%20Holt%20Street\u0026city=Surry%20Hills\u0026state=NSW\u0026zipcode=2012\u0026country=AU\"\n\n```\n\nPlease follow the [installation](#installation) instruction and execute the following Java code:\n\n```java\n\nimport io.snapcx.avs.client.*;\nimport io.snapcx.avs.client.auth.*;\nimport io.snapcx.avs.client.model.*;\nimport io.snapcx.avs.client.api.AddressValidationApi;\n\nimport java.io.File;\nimport java.util.*;\n\npublic class AddressValidationApiExample {\n\n    public static void main(String[] args) {\n        \n        AddressValidationApi apiInstance = new AddressValidationApi();\n        String userKey = \"userKey_example\"; // String | Your private key, given after opening account with snapcx.io\n        String requestId = \"requestId_example\"; // String | Any unique string identifier. Same string will be part of response header.\n        String street = \"street_example\"; // String | Address line1. It's mandatory field.\n        String secondary = \"secondary_example\"; // String | Address line2. Second line of address, as required.\n        String city = \"city_example\"; // String | City name.\n        String state = \"state_example\"; // String | 2 Char State abbrv. Example NJ, NY, CA etc.\n        String zipcode = \"zipcode_example\"; // String | 5 Digit zipcode.\n        try {\n            InlineResponse200 result = apiInstance.validateAddress(userKey, requestId, street, secondary, city, state, zipcode);\n            System.out.println(result);\n        } catch (ApiException e) {\n            System.err.println(\"Exception when calling AddressValidationApi#validateAddress\");\n            e.printStackTrace();\n        }\n    }\n}\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.snapcx.io*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AddressValidationApi* | [**validateAddress**](docs/AddressValidationApi.md#validateAddress) | **GET** /avs/v1/validateAddress | [USA] Validate Address and provide corrected addresses.\n*AddressValidationApi* | [**validateGlobalAddress**](docs/AddressValidationApi.md#validateGlobalAddress) | **GET** /avs/v1/validateGlobalAddress | Global validate Address and provide corrected addresses for all over the world.\n\n## Documentation for Models\n\n - [Address](docs/Address.md)\n - [AddressRecordObj](docs/AddressRecordObj.md)\n - [AddressSummary](docs/AddressSummary.md)\n - [Header](docs/Header.md)\n - [InlineResponse200](docs/InlineResponse200.md)\n - [InlineResponse2001](docs/InlineResponse2001.md)\n - [RequestObject](docs/RequestObject.md)\n - [RequestParams](docs/RequestParams.md)\n\n## Documentation for Authorization\n\nAll endpoints require *API KEY* in request *header*. You can get your api key from [developer portal of snapcx.io](https://developer.snapcx.io). Name of header key is *user_key*\nExample\n```\nuser_key:d111120ba53b07fxxxx05bc8c754a33f\n```\n\n## Recommendation\n\nIt's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issue.\n\n## Website\n\nhttps://snapcx.io\n\n### Pricing \u0026 Subscription plans\n\nhttps://snapcx.io/pricing\n\n### Contact us\n\nhttps://snapcx.io/contactus\n\n### API Status\n\nhttps://status.snapcx.io\n\n### Troubleshooting and API Explorer\n\n(You can use your API Key to test API end point)\nhttps://snapcx.io/addressValidationAPI\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnapcx%2Favs-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnapcx%2Favs-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnapcx%2Favs-client/lists"}