> ## 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.

# APIs overview

> Introduction to Loqate API authentication, base URLs, and key setup. All services require HTTPS connections and valid API keys.

export const BetaCalloutSubtle = () => {
  return <Info>
     <span data-as="p">
     <strong>New Beta SDKs available!</strong> Try our early-access TypeScript and .NET SDKs — built on our live APIs and part of our ongoing tooling overhaul. 
     <br />See the <a href="/sdks/overview">SDK Overview</a> for details. 
     </span>
   </Info>;
};

Loqate services can be accessed securely over HTTPS - we do not support API connections that use HTTP or a TLS protocol below version 1.2.

<BetaCalloutSubtle />

## Base URL

Each API has a base URL on which the required data endpoint can be appended, such as json3.ws or xmle.ws. For SOAP, use wsdlnew\.ws.

<Warning>Customers located in **China** should use services.postcodeanywhere.co.uk as part of the base URL, rather than api.addressy.com.</Warning>

## Authentication

APIs require authentication in the form of a key, which can be created by adding a service in your account. Each key has its own security settings (URL & IP restriction, usage limits),
and as many keys as necessary can be set up with these restrictions. See the [Creating API Keys page](/loqate-basics/create-an-api-key/) for more information.
A key must be passed to the API as a parameter in order for the request to authenticate, otherwise an error will be returned.

## Common errors

Each API has specific errors that may be returned, as well as a common set of errors relating to either account or key settings. See the [Common errors page](/api-reference/common-errors)
for details.
