NationalAddress.Address
API change historyPOI's Fixed Search
POI's fixed search allows a user to find availability of a service he is looking for by providing details of service by fixed parameters. This API can help developers in guiding their customers to nearest location of service they are looking for example banking or pharmacy. You can decide to use JSON or XML as an output format in addition to a language of your choice from Arabic or English.
Try itRequest
Request URL
Request parameters
-
string
Service as string.
-
(optional)string
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.
-
(optional)string
It’s an optional input. We currently support output for API’s in two formats Json and XML. You will be required to specify in which format you need response, default is Json.
-
(optional)string
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.
-
(optional)number
By default each request returns a maximum number of 10 results. If there are a large number of results, in such a case, this page number must be passed along to get the next set of results. Default value is 1.
-
(optional)number
City id is a numeric value from Cities Lookup.
-
(optional)number
District id is a numeric value form Districts Lookup.
-
(optional)number
Four digit number which is unique to a building.
-
(optional)number
Four digits numerical Post code / Zip Code.
-
(optional)number
Four digit numeric value.
-
(optional)string
Name of the city in which address falls. Example Riyadh.
-
(optional)string
Name of the district in which address falls. Example al amal.
-
(optional)string
Name of the street on which building is. Example king abdul aziz road.
-
(optional)number
Service Category Id is numeric value from POI's Category Lookup.
-
(optional)number
Service Sub Category Id is a value from POI's Sub Category Lookup.
-
(optional)number
Region Id is a value from Regions Lookup.
Request headers
Request body
Code samples
@ECHO OFF
curl -v -X GET "https://apina.address.gov.sa/NationalAddress/v3.1/Address/poi-fixed-params?servicestring={string}&language=A&format=json&encode={string}&page=1&cityId={number}&districtId={number}&buildingnumber={number}&zipcode={number}&additionalnumber={number}&cityname={string}&districtname={string}&streetname={string}&servicecategoryId={number}&servicesubcategoryId={number}®ionid={number}"
-H "api_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("api_key", "{subscription key}");
// Request parameters
queryString["servicestring"] = "{string}";
queryString["language"] = "A";
queryString["format"] = "json";
queryString["encode"] = "{string}";
queryString["page"] = "1";
queryString["cityId"] = "{number}";
queryString["districtId"] = "{number}";
queryString["buildingnumber"] = "{number}";
queryString["zipcode"] = "{number}";
queryString["additionalnumber"] = "{number}";
queryString["cityname"] = "{string}";
queryString["districtname"] = "{string}";
queryString["streetname"] = "{string}";
queryString["servicecategoryId"] = "{number}";
queryString["servicesubcategoryId"] = "{number}";
queryString["regionid"] = "{number}";
var uri = "https://apina.address.gov.sa/NationalAddress/v3.1/Address/poi-fixed-params?" + 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://apina.address.gov.sa/NationalAddress/v3.1/Address/poi-fixed-params");
builder.setParameter("servicestring", "{string}");
builder.setParameter("language", "A");
builder.setParameter("format", "json");
builder.setParameter("encode", "{string}");
builder.setParameter("page", "1");
builder.setParameter("cityId", "{number}");
builder.setParameter("districtId", "{number}");
builder.setParameter("buildingnumber", "{number}");
builder.setParameter("zipcode", "{number}");
builder.setParameter("additionalnumber", "{number}");
builder.setParameter("cityname", "{string}");
builder.setParameter("districtname", "{string}");
builder.setParameter("streetname", "{string}");
builder.setParameter("servicecategoryId", "{number}");
builder.setParameter("servicesubcategoryId", "{number}");
builder.setParameter("regionid", "{number}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("api_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
"servicestring": "{string}",
"language": "A",
"format": "json",
"encode": "{string}",
"page": "1",
"cityId": "{number}",
"districtId": "{number}",
"buildingnumber": "{number}",
"zipcode": "{number}",
"additionalnumber": "{number}",
"cityname": "{string}",
"districtname": "{string}",
"streetname": "{string}",
"servicecategoryId": "{number}",
"servicesubcategoryId": "{number}",
"regionid": "{number}",
};
$.ajax({
url: "https://apina.address.gov.sa/NationalAddress/v3.1/Address/poi-fixed-params?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("api_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://apina.address.gov.sa/NationalAddress/v3.1/Address/poi-fixed-params";
NSArray* array = @[
// Request parameters
@"entities=true",
@"servicestring={string}",
@"language=A",
@"format=json",
@"encode={string}",
@"page=1",
@"cityId={number}",
@"districtId={number}",
@"buildingnumber={number}",
@"zipcode={number}",
@"additionalnumber={number}",
@"cityname={string}",
@"districtname={string}",
@"streetname={string}",
@"servicecategoryId={number}",
@"servicesubcategoryId={number}",
@"regionid={number}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"api_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://apina.address.gov.sa/NationalAddress/v3.1/Address/poi-fixed-params');
$url = $request->getUrl();
$headers = array(
// Request headers
'api_key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'servicestring' => '{string}',
'language' => 'A',
'format' => 'json',
'encode' => '{string}',
'page' => '1',
'cityId' => '{number}',
'districtId' => '{number}',
'buildingnumber' => '{number}',
'zipcode' => '{number}',
'additionalnumber' => '{number}',
'cityname' => '{string}',
'districtname' => '{string}',
'streetname' => '{string}',
'servicecategoryId' => '{number}',
'servicesubcategoryId' => '{number}',
'regionid' => '{number}',
);
$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
'api_key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'servicestring': '{string}',
'language': 'A',
'format': 'json',
'encode': '{string}',
'page': '1',
'cityId': '{number}',
'districtId': '{number}',
'buildingnumber': '{number}',
'zipcode': '{number}',
'additionalnumber': '{number}',
'cityname': '{string}',
'districtname': '{string}',
'streetname': '{string}',
'servicecategoryId': '{number}',
'servicesubcategoryId': '{number}',
'regionid': '{number}',
})
try:
conn = httplib.HTTPSConnection('apina.address.gov.sa')
conn.request("GET", "/NationalAddress/v3.1/Address/poi-fixed-params?%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
'api_key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'servicestring': '{string}',
'language': 'A',
'format': 'json',
'encode': '{string}',
'page': '1',
'cityId': '{number}',
'districtId': '{number}',
'buildingnumber': '{number}',
'zipcode': '{number}',
'additionalnumber': '{number}',
'cityname': '{string}',
'districtname': '{string}',
'streetname': '{string}',
'servicecategoryId': '{number}',
'servicesubcategoryId': '{number}',
'regionid': '{number}',
})
try:
conn = http.client.HTTPSConnection('apina.address.gov.sa')
conn.request("GET", "/NationalAddress/v3.1/Address/poi-fixed-params?%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://apina.address.gov.sa/NationalAddress/v3.1/Address/poi-fixed-params')
query = URI.encode_www_form({
# Request parameters
'servicestring' => '{string}',
'language' => 'A',
'format' => 'json',
'encode' => '{string}',
'page' => '1',
'cityId' => '{number}',
'districtId' => '{number}',
'buildingnumber' => '{number}',
'zipcode' => '{number}',
'additionalnumber' => '{number}',
'cityname' => '{string}',
'districtname' => '{string}',
'streetname' => '{string}',
'servicecategoryId' => '{number}',
'servicesubcategoryId' => '{number}',
'regionid' => '{number}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['api_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