Developer Centre > API References > Address Validation
Address Validation
Validate the address and return address suggestions if the address is invalid
Try itRequest URL
Request parameters
(optional)
integer
Format - int32.
(optional)
string
(optional)
string
(optional)
string
(optional)
string
(optional)
string
(optional)
string
Request headers
string
Api key in your Starshipit account under Settings > API Key
Request body
Response 200
OK
{
"valid": false,
"suggestions": [
{
"street": "20 George Street",
"suburb": "Sydney",
"state": "NSW",
"post_code": "2000",
"country": "Australia",
"country_code": "AU"
}
],
"success": true
}
{
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"suggestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"street": {
"type": "string"
},
"suburb": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"post_code": {
"type": "string"
},
"country": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
},
"success": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"details": {
"type": "string"
}
}
}
}
}
}
{
"valid": true,
"suggestions": [
{
"street": "string",
"suburb": "string",
"city": "string",
"state": "string",
"post_code": "string",
"country": "string",
"country_code": "string"
}
],
"success": true,
"errors": [
{
"message": "string",
"details": "string"
}
]
}
{
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"suggestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"street": {
"type": "string"
},
"suburb": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"post_code": {
"type": "string"
},
"country": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
},
"success": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"details": {
"type": "string"
}
}
}
}
}
}
<ValidateAddressResponse>
<valid>true</valid>
<suggestions>
<street>string</street>
<suburb>string</suburb>
<city>string</city>
<state>string</state>
<post_code>string</post_code>
<country>string</country>
<country_code>string</country_code>
</suggestions>
<success>true</success>
<errors>
<message>string</message>
<details>string</details>
</errors>
</ValidateAddressResponse>
{
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"suggestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"street": {
"type": "string"
},
"suburb": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"post_code": {
"type": "string"
},
"country": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
},
"success": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"details": {
"type": "string"
}
}
}
}
}
}
<ValidateAddressResponse>
<valid>true</valid>
<suggestions>
<street>string</street>
<suburb>string</suburb>
<city>string</city>
<state>string</state>
<post_code>string</post_code>
<country>string</country>
<country_code>string</country_code>
</suggestions>
<success>true</success>
<errors>
<message>string</message>
<details>string</details>
</errors>
</ValidateAddressResponse>
{
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"suggestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"street": {
"type": "string"
},
"suburb": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"post_code": {
"type": "string"
},
"country": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
},
"success": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"details": {
"type": "string"
}
}
}
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.starshipit.com/api/address/validate?order_id={integer}&street={string}&suburb={string}&city={string}&state={string}&post_code={string}&country={string}"
-H "StarShipIT-Api-Key: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("StarShipIT-Api-Key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["order_id"] = "{integer}";
queryString["street"] = "{string}";
queryString["suburb"] = "{string}";
queryString["city"] = "{string}";
queryString["state"] = "{string}";
queryString["post_code"] = "{string}";
queryString["country"] = "{string}";
var uri = "https://api.starshipit.com/api/address/validate?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.starshipit.com/api/address/validate");
builder.setParameter("order_id", "{integer}");
builder.setParameter("street", "{string}");
builder.setParameter("suburb", "{string}");
builder.setParameter("city", "{string}");
builder.setParameter("state", "{string}");
builder.setParameter("post_code", "{string}");
builder.setParameter("country", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("StarShipIT-Api-Key", "");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"order_id": "{integer}",
"street": "{string}",
"suburb": "{string}",
"city": "{string}",
"state": "{string}",
"post_code": "{string}",
"country": "{string}",
};
$.ajax({
url: "https://api.starshipit.com/api/address/validate?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("StarShipIT-Api-Key","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.starshipit.com/api/address/validate";
NSArray* array = @[
// Request parameters
@"entities=true",
@"order_id={integer}",
@"street={string}",
@"suburb={string}",
@"city={string}",
@"state={string}",
@"post_code={string}",
@"country={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"StarShipIT-Api-Key"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.starshipit.com/api/address/validate');
$url = $request->getUrl();
$headers = array(
// Request headers
'StarShipIT-Api-Key' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'order_id' => '{integer}',
'street' => '{string}',
'suburb' => '{string}',
'city' => '{string}',
'state' => '{string}',
'post_code' => '{string}',
'country' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'StarShipIT-Api-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'order_id': '{integer}',
'street': '{string}',
'suburb': '{string}',
'city': '{string}',
'state': '{string}',
'post_code': '{string}',
'country': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.starshipit.com')
conn.request("GET", "/api/address/validate?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'StarShipIT-Api-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'order_id': '{integer}',
'street': '{string}',
'suburb': '{string}',
'city': '{string}',
'state': '{string}',
'post_code': '{string}',
'country': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.starshipit.com')
conn.request("GET", "/api/address/validate?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://api.starshipit.com/api/address/validate')
query = URI.encode_www_form({
# Request parameters
'order_id' => '{integer}',
'street' => '{string}',
'suburb' => '{string}',
'city' => '{string}',
'state' => '{string}',
'post_code' => '{string}',
'country' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['StarShipIT-Api-Key'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body