openapi: 3.0.1 info: title: NationalAddress.Address version: '1.0' servers: - url: http://apina.address.gov.sa/NationalAddress/v3.1/Address - url: https://apina.address.gov.sa/NationalAddress/v3.1/Address paths: /address-free-text: get: summary: Free Text Search 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. operationId: 583d3262e6dbd9053ce5db06 parameters: - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: enum: - A type: string default: A - name: format in: query 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.' schema: enum: - json type: string default: json - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: page in: query 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.' schema: enum: - 1 type: number default: 1 - name: addressstring in: query description: Free text details in a string format for a address. required: true schema: type: string responses: '200': description: /address-fixed-params: get: summary: Fixed Search 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. operationId: 583d41cbe6dbd9053ce5db07 parameters: - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: enum: - A type: string default: A - name: format in: query 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.' schema: enum: - json type: string default: json - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: page in: query 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.' schema: enum: - 1 type: number default: 1 - name: cityId in: query description: "City id is a numeric value from Cities Lookup.\n" schema: type: number - name: districtId in: query description: "District id is a numeric value form Districts Lookup.\n" schema: type: number - name: buildingnumber in: query description: "Four digit number which is unique to a building.\n" schema: type: number - name: zipcode in: query description: "Four digits numerical Post code / Zip Code.\n" schema: type: number - name: additionalnumber in: query description: "Four digit numeric value.\n" schema: type: number - name: cityname in: query description: "Name of the city in which address falls. Example Riyadh.\n" schema: type: string - name: districtname in: query description: "Name of the district in which address falls. Example al amal.\n" schema: type: string - name: streetname in: query description: "Name of the street on which building is. Example king abdul aziz road.\n" schema: type: string responses: '200': description: /address-bulk: get: summary: Bulk Search 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.' operationId: 583d4bfae6dbd9053ce5db08 parameters: - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: enum: - A type: string default: A - name: format in: query 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.' schema: enum: - json type: string default: json - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: page in: query 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.' schema: enum: - 1 type: number default: 1 - name: addressstring in: query 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.' required: true schema: type: string responses: '200': description: /address-verify: get: summary: Verify An Address 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. operationId: 583d6634e6dbd9053ce5db09 parameters: - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: enum: - A type: string default: A - name: format in: query 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.' schema: enum: - json type: string default: json - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: page in: query 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.' schema: enum: - 1 type: number default: 1 - name: buildingnumber in: query description: "Four digit numeric number which uniquely identifies the building.\n" required: true schema: type: number - name: zipcode in: query description: "Four digit numeric number.\n" required: true schema: type: number - name: additionalnumber in: query description: "Four digit numeric number.\n" required: true schema: type: number responses: '200': description: /address-geocode: get: summary: Address Geocode description: "Address Reverse Geocode API returns different outputs based on conditions as mentioned below:\n\nIf an address is found then service returns\nParcel Address\nIf the point is outside KSA and address or postal code is not found it returns\nNo results\nYou can decide to use Json or XML as an output format in addition to language of your choice from Arabic or English." operationId: 583d68bfe6dbd9053ce5db0a parameters: - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: enum: - A type: string default: A - name: format in: query 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.' schema: enum: - json type: string default: json - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: lat in: query description: "Latitude in decimal units.\n" required: true schema: type: number - name: long in: query description: "Longitude in decimal units.\n" required: true schema: type: number responses: '200': description: /poi-free-text: get: summary: POI's Free Text Search 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. operationId: 583d6c31e6dbd9053ce5db0b parameters: - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: enum: - A type: string default: A - name: format in: query 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.' schema: enum: - json type: string default: json - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: page in: query 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.' schema: enum: - 1 type: number default: 1 - name: servicestring in: query description: "Service as string.\n" required: true schema: type: string responses: '200': description: /poi-nearest: get: summary: Nearest POI's 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. operationId: 583d77aae6dbd9053ce5db10 parameters: - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: enum: - A type: string default: A - name: format in: query 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.' schema: enum: - json type: string default: json - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: page in: query 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.' schema: enum: - 1 type: number default: 1 - name: long in: query description: "Longitude in decimals.\n" required: true schema: type: number - name: lat in: query description: "Latitude in decimals.\n" required: true schema: type: number - name: radius in: query description: "It’s an optional input. In Kilometers. Default = 0.5 kms\n" schema: enum: - 0.5 type: number default: 0.5 responses: '200': description: /poi-fixed-params: get: summary: POI's Fixed Search 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. operationId: 583d7bc8e6dbd9053ce5db11 parameters: - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: enum: - A type: string default: A - name: format in: query 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.' schema: enum: - json type: string default: json - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: page in: query 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.' schema: enum: - 1 type: number default: 1 - name: cityId in: query description: "City id is a numeric value from Cities Lookup.\n" schema: type: number - name: districtId in: query description: "District id is a numeric value form Districts Lookup.\n" schema: type: number - name: buildingnumber in: query description: "Four digit number which is unique to a building.\n" schema: type: number - name: zipcode in: query description: "Four digits numerical Post code / Zip Code.\n" schema: type: number - name: additionalnumber in: query description: "Four digit numeric value.\n" schema: type: number - name: cityname in: query description: "Name of the city in which address falls. Example Riyadh.\n" schema: type: string - name: districtname in: query description: "Name of the district in which address falls. Example al amal.\n" schema: type: string - name: streetname in: query description: "Name of the street on which building is. Example king abdul aziz road.\n" schema: type: string - name: servicestring in: query description: "Service as string.\n" required: true schema: type: string - name: servicecategoryId in: query description: "Service Category Id is numeric value from POI's Category Lookup.\n" schema: type: number - name: servicesubcategoryId in: query description: "Service Sub Category Id is a value from POI's Sub Category Lookup.\n" schema: type: number - name: regionid in: query description: "Region Id is a value from Regions Lookup.\n" schema: type: number responses: '200': description: /get-feature-extents: get: summary: Get Extents Of A Feature 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.' operationId: 583e6a19e6dbd90a70d05332 parameters: - name: format in: query 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.' schema: enum: - json type: string default: json - name: layername in: query 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. \n" required: true schema: type: string - name: featureid in: query description: "Id of the selected feature.\n" required: true schema: type: string - name: encode in: query description: "By default response is in windows-1256.\n\nSupport for utf-8 is added as of now. Pass \"utf8\" as input parameter." schema: type: string responses: '200': description: components: securitySchemes: apiKeyHeader: type: apiKey name: api_key in: header apiKeyQuery: type: apiKey name: api_key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]