openapi: 3.0.1 info: title: NationalAddress.Lookups version: '1.0' servers: - url: http://apina.address.gov.sa/NationalAddress/v3.1/lookup - url: https://apina.address.gov.sa/NationalAddress/v3.1/lookup paths: /regions: get: summary: regions operationId: 582d988ce6dbd90d8ccc4db6 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 responses: '200': description: /cities: get: summary: cities operationId: 582d9c4ee6dbd90d8ccc4db8 parameters: - name: language in: query description: language required: true schema: enum: - A type: string default: A - name: format in: query description: format required: true schema: enum: - json type: string default: json - name: regionid in: query description: Region ID schema: enum: - '-1' type: string default: '-1' responses: '200': description: /districts: get: summary: districts operationId: 582d9e19e6dbd90d8ccc4db9 parameters: - name: language in: query description: language required: true schema: enum: - A type: string default: A - name: format in: query description: format required: true schema: enum: - json type: string default: json - name: cityid in: query description: City ID schema: type: string responses: '200': description: /service-categories: get: summary: service-categories operationId: 582d9fd7e6dbd90d8ccc4dba parameters: - name: language in: query description: language required: true schema: enum: - A type: string default: A - name: format in: query description: format required: true schema: enum: - json type: string default: json responses: '200': description: /services-sub-categories: get: summary: services-sub-categories operationId: 582da1bfe6dbd90d8ccc4dbb parameters: - name: language in: query description: language required: true schema: enum: - A type: string default: A - name: format in: query description: format required: true schema: enum: - json type: string default: json - name: servicecategoryid in: query description: ID of service category by which its recognized in system. You can obtain service category id by using Service Category API. 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: [ ]