# API Compatibility Layer

Drop-in replacement for GetAddress. Change your base URL and API key - everything else stays the same.

<https://ga.ideal-postcodes.co.uk> provides an API that is compatible with both GetAddress.io and Ideal-Postcodes.co.uk clients. This means you can migrate quickly and gradually transition your API usage over time.

Report Incompatibilities

If you encounter any incompatibility, please let us know and we can fix it immediately.

Temporary Solution

This layer is intended to help you transition quickly following the unexpected closure of GetAddress. We recommend migrating to the native Ideal Postcodes API as soon as you can for full functionality and better performance. The Compatibility Layer will be sunsetted when all users have fully migrated to the Ideal Postcodes API.

## Quick Start[​](#quick-start "Direct link to Quick Start")

1. Create an account and API key at [account.ideal-postcodes.co.uk](https://account.ideal-postcodes.co.uk)
2. Update your base URL from `api.getaddress.io` to `ga.ideal-postcodes.co.uk`
3. Replace your `api-key` parameter value with an Ideal Postcodes API Key

```
- https://api.getaddress.io/autocomplete/...?api-key=zdGq1x9OSUmq4ffKKYbP2...



+ https://ga.ideal-postcodes.co.uk/autocomplete/...?api-key=ak_jd9d9nNd930Dkssi23...
```

## Next Steps[​](#next-steps "Direct link to Next Steps")

Once you've stabilised your integration, we recommend migrating to the native Ideal Postcodes API for:

* **Additional data**: UPRN, UDPRN, coordinates, census data
* **Better performance**: Direct API access without proxy overhead
* **Full feature set**: Filters, pagination, and advanced options

See our migration guides:

* [Autocomplete Migration](/docs/migrate/getaddressio/autocomplete.md)
* [Postcode Lookup Migration](/docs/migrate/getaddressio/postcode-lookup.md)

## Need Help?[​](#need-help "Direct link to Need Help?")

Developers and account support are available on chat or email <support@ideal-postcodes.co.uk> for migration assistance.
