# paths./address-free-text.get.description
Free text search allows a user to find complete details of an address by providing limited details about an address as a free text. Using the service user can complete an address to enable its user to reach there comfortably even if they know only some details about it. You can decide to use JSON or XML as an output format in addition to a language of your choice from Arabic or English.

# paths./address-free-text.get.parameters[].description
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.

# paths./address-free-text.get.parameters[].description
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.

# paths./address-free-text.get.parameters[].description
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.

# paths./address-free-text.get.parameters[].description
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.

# paths./address-free-text.get.parameters[].description
Free text details in a string format for a address.

# paths./address-fixed-params.get.description
Fixed search allows a user to find complete details of an address by providing some details about that address by fixed parameters. Using the service user can complete an address to enable its user to reach there comfortably even if they know only some details about it. You can decide to use Json or XML as an output format in addition to language of your choice from Arabic or English.

# paths./address-fixed-params.get.parameters[].description
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.

# paths./address-fixed-params.get.parameters[].description
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.

# paths./address-fixed-params.get.parameters[].description
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.

# paths./address-fixed-params.get.parameters[].description
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.

# paths./address-fixed-params.get.parameters[].description
City id is a numeric value from Cities Lookup.

# paths./address-fixed-params.get.parameters[].description
District id is a numeric value form Districts Lookup.

# paths./address-fixed-params.get.parameters[].description
Four digit number which is unique to a building.

# paths./address-fixed-params.get.parameters[].description
Four digits numerical Post code / Zip Code.

# paths./address-fixed-params.get.parameters[].description
Name of the city in which address falls. Example Riyadh.

# paths./address-fixed-params.get.parameters[].description
Name of the district in which address falls. Example al amal.

# paths./address-fixed-params.get.parameters[].description
Name of the street on which building is. Example king abdul aziz road.

# paths./address-bulk.get.description
Search bulk address API allows user to find complete details of multiple address by providing building number, zip code for the addresses. You can decide to use Json or XML as an output format in addition to language of your choice from Arabic or English.

# paths./address-bulk.get.parameters[].description
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.

# paths./address-bulk.get.parameters[].description
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.

# paths./address-bulk.get.parameters[].description
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.

# paths./address-bulk.get.parameters[].description
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.

# paths./address-bulk.get.parameters[].description
Address attributes would be separated with a pipe. Whereas, each address would be separated from others with a semicolon. BuildingNumber|ZipCode|AdditionalNumber; For example, 8228|12643|2121;3908|12991|8966;….. upto 10. NOTE: Even if the string contains more than 10 addresses, the 1st 10 addresses will be considered & the rest would be discarded.

# paths./address-verify.get.description
Verify address API allows user to verify a given address. If an address is verified then true is returned else false. This API can help developers in ensuring that their customers can verify addresses to ensure data shared with them is genuine and not false. You can decide to use Json or XML as an output format in addition to language of your choice from Arabic or English.

# paths./address-verify.get.parameters[].description
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.

# paths./address-verify.get.parameters[].description
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.

# paths./address-verify.get.parameters[].description
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.

# paths./address-verify.get.parameters[].description
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.

# paths./address-verify.get.parameters[].description
Four digit numeric number which uniquely identifies the building.

# paths./address-geocode.get.description
Address Reverse Geocode API returns different outputs based on conditions as mentioned below:

If an address is found then service returns
Parcel Address
If the point is outside KSA and address or postal code is not found it returns
No results
You can decide to use Json or XML as an output format in addition to language of your choice from Arabic or English.

# paths./address-geocode.get.parameters[].description
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.

# paths./address-geocode.get.parameters[].description
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.

# paths./address-geocode.get.parameters[].description
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.

# paths./poi-free-text.get.description
POI's free text search allows a user to find availability of a service he is looking for by providing details of service as a free text string input. 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.

# paths./poi-free-text.get.parameters[].description
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.

# paths./poi-free-text.get.parameters[].description
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.

# paths./poi-free-text.get.parameters[].description
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.

# paths./poi-free-text.get.parameters[].description
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.

# paths./poi-nearest.get.description
Search nearest service API allows a user to find availability of service he is looking for within a defined radius of an area provided by a user as an input. This service 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.

# paths./poi-nearest.get.parameters[].description
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.

# paths./poi-nearest.get.parameters[].description
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.

# paths./poi-nearest.get.parameters[].description
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.

# paths./poi-nearest.get.parameters[].description
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.

# paths./poi-nearest.get.parameters[].description
It’s an optional input. In Kilometers. Default = 0.5 kms

# paths./poi-fixed-params.get.description
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.

# paths./poi-fixed-params.get.parameters[].description
It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language.

# paths./poi-fixed-params.get.parameters[].description
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.

# paths./poi-fixed-params.get.parameters[].description
By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset.

# paths./poi-fixed-params.get.parameters[].description
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.

# paths./poi-fixed-params.get.parameters[].description
City id is a numeric value from Cities Lookup.

# paths./poi-fixed-params.get.parameters[].description
District id is a numeric value form Districts Lookup.

# paths./poi-fixed-params.get.parameters[].description
Four digit number which is unique to a building.

# paths./poi-fixed-params.get.parameters[].description
Four digits numerical Post code / Zip Code.

# paths./poi-fixed-params.get.parameters[].description
Name of the city in which address falls. Example Riyadh.

# paths./poi-fixed-params.get.parameters[].description
Name of the district in which address falls. Example al amal.

# paths./poi-fixed-params.get.parameters[].description
Name of the street on which building is. Example king abdul aziz road.

# paths./poi-fixed-params.get.parameters[].description
Service Category Id is numeric value from POI's Category Lookup.

# paths./poi-fixed-params.get.parameters[].description
Service Sub Category Id is a value from POI's Sub Category Lookup.

# paths./poi-fixed-params.get.parameters[].description
Region Id is a value from Regions Lookup.

# paths./get-feature-extents.get.description
Get extents of a feature, allows a user to get boundary extents of a single feature.  Here a feature can be a Region, City, District, Street or a Zipcode.  This will allow users to zoom to a particular feature by its extents.  You can decide to use JSON or XML as an output format.

# paths./get-feature-extents.get.parameters[].description
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.

# paths./get-feature-extents.get.parameters[].description
This is a mandatory input. Layer names that can be passed to this method are, "regions", "cities", "districts", "streets", and "zipcodes". Kindly make sure that the layer names are passed as it is. 

# paths./get-feature-extents.get.parameters[].description
By default response is in windows-1256.

Support for utf-8 is added as of now. Pass "utf8" as input parameter.