> ## Documentation Index > Fetch the complete documentation index at: https://docs.loqate.com/llms.txt > Use this file to discover all available pages before exploring further. # GovernmentData: Postzon RetrieveByPostcode > Get comprehensive UK government data for any postcode. Returns coordinates, ONS codes, NHS areas, constituencies, wards, and council information. **This method will consume credit.** ## OpenAPI ````yaml postzon_retrievebypostcode get /GovernmentData/Postzon/RetrieveByPostcode/v1.50/json6.ws openapi: 3.0.0 info: title: GovernmentData_Postzon_RetrieveByPostcode description: Returns the Postzon record for the given postcode. version: '1.5' servers: - url: https://api.addressy.com security: - ApiKeyQuery: [] paths: /GovernmentData/Postzon/RetrieveByPostcode/v1.50/json6.ws: get: tags: - GovernmentData_Postzon_RetrieveByPostcode summary: GovernmentData_Postzon_RetrieveByPostcode description: Returns the Postzon record for the given postcode. operationId: GovernmentData_Postzon_RetrieveByPostcode parameters: - name: Key in: query required: true description: The key to use to authenticate to the service. schema: type: string example: AA11-AA11-AA11-AA11 - name: Postcode in: query required: true description: The Postcode to use to search with. schema: type: string example: AL4 0BS - name: UserName in: query description: >- The username associated with the Royal Mail license (not required for click licenses). schema: type: string example: David responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/response' examples: Success: summary: Success value: Items: - Easting: '517292' Northing: '208276' Latitude: '51.7608' Longitude: '-0.3019' OsGrid: TL 17292 08276 CountryCode: '064' NewCountryCode: E92000001 CountryName: England CountyCode: '26' NewCountyCode: E10000015 CountyName: Hertfordshire DistrictCode: 26UG NewDistrictCode: E07000240 DistrictName: St Albans WardCode: 26UGGH NewWardCode: E05004795 WardName: Marshalswick North NhsShaCode: '' NewNhsShaCode: E19000001 NhsShaName: '' NhsPctCode: 5P4 NewNhsPctCode: E18000006 NhsPctName: West Hertfordshire PCT LeaCode: '919' LeaName: Hertfordshire GovernmentOfficeCode: G GovernmentOfficeName: East of England WestminsterConstituencyCode: '382' WestminsterConstituencyName: St. Albans WestminsterMP: Anne Main WestminsterParty: Conservative WestminsterConstituencyCode2010: '382' WestminsterConstituencyName2010: St. Albans LSOACode: E01023712 LSOAName: St Albans 008D MSOACode: E02004931 MSOAName: St Albans 008 CCGCode: 06N CCGName: NHS Herts Valleys CCG CCGAreaCode: Q58 CCGAreaName: Hertfordshire and the South Midlands Area Team CCGRegionCode: Y55 CCGRegionName: Midlands and East of England Commissioning Region '400': description: BadRequest content: application/json: schema: $ref: '#/components/schemas/error' examples: Postcode Required: summary: Postcode Required value: Items: - Error: '1001' Description: Postcode Required Cause: The Postcode parameter was not supplied. Resolution: >- Please ensure that you supply the Postcode parameter and try again. Postcode Invalid: summary: Postcode Invalid value: Items: - Error: '1002' Description: Postcode Invalid Cause: The Postcode parameter was not valid. Resolution: The Postcode parameter should be valid UK postcode. Request not allowed from this IP: summary: Request not allowed from this IP value: Items: - Error: '4' Description: Request not allowed from this IP Cause: The request was disallowed from the IP address. Resolution: >- Check the security settings on the key first. If they look fine, please contact support as it may be from an IP address on our blacklist. Request not allowed from this URL: summary: Request not allowed from this URL value: Items: - Error: '5' Description: Request not allowed from this URL Cause: The request was disallowed from the URL. Resolution: >- Check the security settings on the key first. If they look fine, please contact support as it may be from a URL on our blacklist. Web service not available on this key: summary: Web service not available on this key value: Items: - Error: '6' Description: Web service not available on this key Cause: The requested web service is disallowed on this key. Resolution: >- Check the security settings on the key first. You can limit a key to certain web services. Missing or invalid parameters: summary: Missing or invalid parameters value: Items: - Error: '18' Description: Missing or invalid parameters Cause: >- A required parameter was not supplied of the value of a parameter cannnot be converted into the right type. Resolution: >- Check the parameters passed and their values against the specification for this service. Invalid JSON object: summary: Invalid JSON object value: Items: - Error: '19' Description: Invalid JSON object Cause: The JSON object sent in your request is invalid. Resolution: >- Please ensure your JSON object is syntactically correct and try again. Endpoint not available: summary: Endpoint not available value: Items: - Error: '20' Description: Endpoint not available Cause: >- The web service you are calling is not available on this endpoint Resolution: >- Refer to our documentation pages to ensure you are calling a valid endpoint for the web service you are requesting. Sandbox Mode is not available on this endpoint: summary: Sandbox Mode is not available on this endpoint value: Items: - Error: '21' Description: Sandbox Mode is not available on this endpoint Cause: >- The License key used has Sandbox Mode enabled, but the testing functionality is not available on this endpoint. Resolution: Disable the Sandbox Mode on the License key. HTTPS requests only: summary: HTTPS requests only value: Items: - Error: '22' Description: HTTPS requests only Cause: >- As of 3rd September 2018 all new accounts must use HTTPS. Resolution: >- Ensure you consume all of our APIs over HTTPS and not HTTP. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error' examples: Unknown key: summary: Unknown key value: Items: - Error: '2' Description: Unknown key Cause: >- The key you are using to access the service was not found. Resolution: >- Please check that the key is correct. It should be in the form AA11-AA11-AA11-AA11. Agreement Not Signed: summary: Agreement Not Signed value: Items: - Error: '23' Description: Agreement Not Signed Cause: >- There are agreements associated with service which are not signed. Resolution: Please go to your account and check your agreements. Not enough credit for request: summary: Not enough credit for request value: Items: - Error: '24' Description: Not enough credit for request Cause: >- There is not enough credit on the account to process the request. Resolution: Please topup your account with credit. Unexpected error, please contact the help desk for more information: summary: >- Unexpected error, please contact the help desk for more information value: Items: - Error: '25' Description: >- Unexpected error, please contact the help desk for more information Cause: '' Resolution: '' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error' examples: Account out of credit: summary: Account out of credit value: Items: - Error: '3' Description: Account out of credit Cause: >- Your account is either out of credit or has insufficient credit to service this request. Resolution: >- Please check your account balance and top it up if necessary. Web service not available on your plan: summary: Web service not available on your plan value: Items: - Error: '7' Description: Web service not available on your plan Cause: >- The requested web service is not currently available on your payment plan. Resolution: >- Some services are only available in specific regions due to licensing restrictions. Please contact us for more information. Key daily limit exceeded: summary: Key daily limit exceeded value: Items: - Error: '8' Description: Key daily limit exceeded Cause: The daily limit on the key has been exceeded. Resolution: >- Alter the daily limit on the key. Check the usage details first to see if usage is normal. Your account has been suspended: summary: Your account has been suspended value: Items: - Error: '9' Description: Your account has been suspended Cause: >- Your account has been suspended. This can be for a number of reasons including non-payment of an invoice. Resolution: Please contact us in order to resolve this issue. Surge protector triggered: summary: Surge protector triggered value: Items: - Error: '10' Description: Surge protector triggered Cause: >- An unusually large number of requests have been processed for your account so the surge protector has been enabled. Resolution: >- You can disable the surge protector at any time but this is only recommended if you are running through a batch of requests. No valid license available: summary: No valid license available value: Items: - Error: '11' Description: No valid license available Cause: >- The request requires a valid license but none were found. Resolution: >- Please check your purchase history. You may be using a license that is no longer valid or of an incorrect type. Management key required: summary: Management key required value: Items: - Error: '12' Description: Management key required Cause: >- To use this web service you require a management key. Management can be enabled on any key, but we advise you to use management keys with care. Resolution: >- Sign in to the website and create a new management key or change an existing key. Demo limit exceeded: summary: Demo limit exceeded value: Items: - Error: '13' Description: Demo limit exceeded Cause: >- The daily demonstration limit for this service or account has been exceeded. Resolution: >- The limit will be reset at midnight tonight. If you would like the limit increased, please contact us. Free service limit exceeded: summary: Free service limit exceeded value: Items: - Error: '14' Description: Free service limit exceeded Cause: You have used too many free web services. Resolution: >- Our web services are designed to operate in stages. The first is usually a Find service followed by a Retrieve. If you use too many Finds without the corresponding number of Retrieves you will receive this error. For more information, please contact us. Wrong type of key: summary: Wrong type of key value: Items: - Error: '15' Description: Wrong type of key Cause: >- The type of key you're using isn't supported by this web service. Resolution: >- This usually happens if you're using a user or server license with a web service that only supports transactional keys. Please use another key and try again. Key expired: summary: Key expired value: Items: - Error: '16' Description: Key expired Cause: The key you are trying to use has expired. Resolution: >- Please check that you are using the right key. A new one may have been issued if you recently renewed your key. Contact us if you have any questions. Individual User exceeded Lookup Limit: summary: Individual User exceeded Lookup Limit value: Items: - Error: '17' Description: Individual User exceeded Lookup Limit Cause: >- An Individual User has exceeded their daily lookup limit on the key and that user will be prevented from using your service until tomorrow (GMT) Resolution: >- Check the usage details. If required, increase the Lookup Limit per Individual User or add the specific Individual User's IP to the Limiter Exclusions '500': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/error' examples: Unknown error: summary: Unknown error value: Items: - Error: '-1' Description: Unknown error Cause: >- The cause of the error is unknown but details have been passed to our support staff who will investigate. Resolution: >- These problems are typically short lived and are often resolved by trying again in a few minutes. components: schemas: response: properties: Items: type: array items: properties: Easting: type: integer description: >- The easting coordinate of the location. Represents a distance in meters east from the most south westerly position of the GB mapping grid. Northing: type: integer description: >- The northing coordinate of the location. Represents a distance in meters north from the most south westerly position of the GB mapping grid. Latitude: type: number description: The WGS84 latitude coordinate of the location. Longitude: type: number description: The WGS84 longitude coordinate of the location. OsGrid: type: string description: The OS grid reference for the location. CountryCode: type: string description: The ONS country code for the location. NewCountryCode: type: string description: The new ONS country code for the location. CountryName: type: string description: The name corresponding to CountryCode. CountyCode: type: string description: >- The ONS county code for the location. For locations without 2 tier local administration, this will be 00. NewCountyCode: type: string description: >- The ONS new county code for the location. For locations without 2 tier local administration, this will be 00. CountyName: type: string description: The name corresponding to CountyCode. DistrictCode: type: string description: The ONS district code for the location. NewDistrictCode: type: string description: The new ONS district code for the location. DistrictName: type: string description: The name corresponding to DistrictCode. WardCode: type: string description: The ONS ward code for the location. NewWardCode: type: string description: The new ONS ward code for the location. WardName: type: string description: The name corresponding to WardCode. NhsShaCode: type: string description: >- The ONS code for the NHS Strategic Health Authority for the location. NewNhsShaCode: type: string description: >- The new ONS code for the NHS Strategic Health Authority for the location. NhsShaName: type: string description: The name corresponding to NhsShaCode. NhsPctCode: type: string description: The ONS code for the NHS Primary Care Trust for the location. NewNhsPctCode: type: string description: >- The new ONS code for the NHS Primary Care Trust for the location. NhsPctName: type: string description: The name corresponding to NhsPctCode. LeaCode: type: string description: >- The ONS code for the Local Education Authority for the location. LeaName: type: string description: The name corresponding to LeaCode. GovernmentOfficeCode: type: string description: The ONS code for the Government Office for the location. GovernmentOfficeName: type: string description: The name corresponding to GovernmentOfficeCode. WestminsterConstituencyCode: type: string description: >- The ONS code for the Westminster parliamentary constituency for the location. WestminsterConstituencyName: type: string description: The name corresponding to WestminsterConstituencyCode. WestminsterMP: type: string description: >- The name of the Westminster Member of Parliament for the location. WestminsterParty: type: string description: The party for WestminsterMP. WestminsterConstituencyCode2010: type: string description: >- The ONS code (or temporary if > 900) for the Westminster parliamentary constituency for the location in 2010. WestminsterConstituencyName2010: type: string description: The name corresponding to WestminsterConstituencyCode2010. LSOACode: type: string description: The LSOA code for this area. LSOAName: type: string description: The LSOA name for this area. MSOACode: type: string description: The MSOA code for this area. MSOAName: type: string description: The MSOA name for this area. CCGCode: type: string description: The Clinical Commissioning Group code for this area. CCGName: type: string description: The Clinical Commissioning Group name for this area. CCGAreaCode: type: string description: The Clinical Commissioning Group area code for this area. CCGAreaName: type: string description: The Clinical Commissioning Group area name for this area. CCGRegionCode: type: string description: The Clinical Commissioning Group region code for this area. CCGRegionName: type: string description: The Clinical Commissioning Group region name for this area. error: properties: Items: type: array items: properties: Error: type: string description: The id of the error returned Description: type: string description: A description of the error Cause: type: string description: The cause of the error Resolution: type: string description: Actions to resolve the error securitySchemes: ApiKeyQuery: type: apiKey name: Key in: query ````