All URIs are relative to https://api.cloudmersive.com
Method | HTTP request | Description |
---|---|---|
addressCheckEUMembership | POST /validate/address/country/check-eu-membership | Check if a country is a member of the European Union (EU) |
addressCountry | POST /validate/address/country | Validate and normalize country information, return ISO 3166-1 country codes and country name |
addressCountryList | POST /validate/address/country/list | Get a list of ISO 3166-1 countries |
addressGeocode | POST /validate/address/geocode | Geocode a street address into latitude and longitude |
addressGetCountryCurrency | POST /validate/address/country/get-currency | Get the currency of the input country |
addressGetCountryRegion | POST /validate/address/country/get-region | Get the region, subregion and continent of the country |
addressGetTimezone | POST /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country |
addressNormalizeAddress | POST /validate/address/street-address/normalize | Normalize a street address |
addressParseString | POST /validate/address/parse | Parse an unstructured input text string into an international, formatted address |
addressReverseGeocodeAddress | POST /validate/address/geocode/reverse | Reverse geocode a lattitude and longitude into an address |
addressValidateAddress | POST /validate/address/street-address | Validate a street address |
addressValidateCity | POST /validate/address/city | Validate a City and State/Province combination, get location information about it |
addressValidatePostalCode | POST /validate/address/postal-code | Validate a postal code, get location information about it |
addressValidateState | POST /validate/address/state | Validate a state or province, name or abbreviation, get location information about it |
\Swagger\Client\Model\ValidateCountryResponse addressCheckEUMembership($input)
Check if a country is a member of the European Union (EU)
Checks if the input country is a member of the European Union or not.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateCountryRequest(); // \Swagger\Client\Model\ValidateCountryRequest | Input request
try {
$result = $apiInstance->addressCheckEUMembership($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressCheckEUMembership: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateCountryRequest | Input request |
\Swagger\Client\Model\ValidateCountryResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ValidateCountryResponse addressCountry($input)
Validate and normalize country information, return ISO 3166-1 country codes and country name
Validates and normalizes country information, and returns key information about a country, as well as whether it is a member of the European Union. Also returns distinct time zones in the country.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateCountryRequest(); // \Swagger\Client\Model\ValidateCountryRequest | Input request
try {
$result = $apiInstance->addressCountry($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressCountry: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateCountryRequest | Input request |
\Swagger\Client\Model\ValidateCountryResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CountryListResult addressCountryList()
Get a list of ISO 3166-1 countries
Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->addressCountryList();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressCountryList: ', $e->getMessage(), PHP_EOL;
}
?>
This endpoint does not need any parameter.
\Swagger\Client\Model\CountryListResult
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ValidateAddressResponse addressGeocode($input)
Geocode a street address into latitude and longitude
Geocodes a street address into latitude and longitude.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateAddressRequest(); // \Swagger\Client\Model\ValidateAddressRequest | Input parse request
try {
$result = $apiInstance->addressGeocode($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressGeocode: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateAddressRequest | Input parse request |
\Swagger\Client\Model\ValidateAddressResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ValidateCountryResponse addressGetCountryCurrency($input)
Get the currency of the input country
Gets the currency information for the input country, including the ISO three-letter country code, currency symbol, and English currency name.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateCountryRequest(); // \Swagger\Client\Model\ValidateCountryRequest | Input request
try {
$result = $apiInstance->addressGetCountryCurrency($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressGetCountryCurrency: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateCountryRequest | Input request |
\Swagger\Client\Model\ValidateCountryResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ValidateCountryResponse addressGetCountryRegion($input)
Get the region, subregion and continent of the country
Gets the continent information including region and subregion for the input country.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateCountryRequest(); // \Swagger\Client\Model\ValidateCountryRequest | Input request
try {
$result = $apiInstance->addressGetCountryRegion($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressGetCountryRegion: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateCountryRequest | Input request |
\Swagger\Client\Model\ValidateCountryResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\GetTimezonesResponse addressGetTimezone($input)
Gets IANA/Olsen time zones for a country
Gets the IANA/Olsen time zones for a country.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\GetTimezonesRequest(); // \Swagger\Client\Model\GetTimezonesRequest | Input request
try {
$result = $apiInstance->addressGetTimezone($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressGetTimezone: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\GetTimezonesRequest | Input request |
\Swagger\Client\Model\GetTimezonesResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\NormalizeAddressResponse addressNormalizeAddress($input)
Normalize a street address
Normalizes an input structured street address is valid or invalid. If the address is valid, also returns the latitude and longitude of the address. Supports all major international addresses.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateAddressRequest(); // \Swagger\Client\Model\ValidateAddressRequest | Input parse request
try {
$result = $apiInstance->addressNormalizeAddress($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressNormalizeAddress: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateAddressRequest | Input parse request |
\Swagger\Client\Model\NormalizeAddressResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ParseAddressResponse addressParseString($input)
Parse an unstructured input text string into an international, formatted address
Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ParseAddressRequest(); // \Swagger\Client\Model\ParseAddressRequest | Input parse request
try {
$result = $apiInstance->addressParseString($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressParseString: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ParseAddressRequest | Input parse request |
\Swagger\Client\Model\ParseAddressResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ReverseGeocodeAddressResponse addressReverseGeocodeAddress($input)
Reverse geocode a lattitude and longitude into an address
Converts lattitude and longitude coordinates into an address through reverse-geocoding.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ReverseGeocodeAddressRequest(); // \Swagger\Client\Model\ReverseGeocodeAddressRequest | Input reverse geocoding request
try {
$result = $apiInstance->addressReverseGeocodeAddress($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressReverseGeocodeAddress: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ReverseGeocodeAddressRequest | Input reverse geocoding request |
\Swagger\Client\Model\ReverseGeocodeAddressResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ValidateAddressResponse addressValidateAddress($input)
Validate a street address
Determines if an input structured street address is valid or invalid. If the address is valid, also returns the latitude and longitude of the address. Supports all major international addresses.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateAddressRequest(); // \Swagger\Client\Model\ValidateAddressRequest | Input parse request
try {
$result = $apiInstance->addressValidateAddress($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressValidateAddress: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateAddressRequest | Input parse request |
\Swagger\Client\Model\ValidateAddressResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ValidateCityResponse addressValidateCity($input)
Validate a City and State/Province combination, get location information about it
Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more. Supports all major international addresses.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateCityRequest(); // \Swagger\Client\Model\ValidateCityRequest | Input parse request
try {
$result = $apiInstance->addressValidateCity($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressValidateCity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateCityRequest | Input parse request |
\Swagger\Client\Model\ValidateCityResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ValidatePostalCodeResponse addressValidatePostalCode($input)
Validate a postal code, get location information about it
Checks if the input postal code is valid, and returns information about it such as City, State and more. Supports all major countries.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidatePostalCodeRequest(); // \Swagger\Client\Model\ValidatePostalCodeRequest | Input parse request
try {
$result = $apiInstance->addressValidatePostalCode($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressValidatePostalCode: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidatePostalCodeRequest | Input parse request |
\Swagger\Client\Model\ValidatePostalCodeResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ValidateStateResponse addressValidateState($input)
Validate a state or province, name or abbreviation, get location information about it
Checks if the input state name or code is valid, and returns information about it such as normalized State name and more. Supports all major countries.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');
$apiInstance = new Swagger\Client\Api\AddressApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$input = new \Swagger\Client\Model\ValidateStateRequest(); // \Swagger\Client\Model\ValidateStateRequest | Input parse request
try {
$result = $apiInstance->addressValidateState($input);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AddressApi->addressValidateState: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
input | \Swagger\Client\Model\ValidateStateRequest | Input parse request |
\Swagger\Client\Model\ValidateStateResponse
- Content-Type: application/json, text/json
- Accept: application/json, text/json, application/xml, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]