Author
John Angeles
Updated
2022-08-23
Summary
-
A lookup is a completed verified address
-
A credit is the unit used to purchase your lookups
-
Every API Key on an account has its own credit balance
-
A lookup done via the Postcode Lookup or the Address Finder tool counts as 1 credit
-
A postcode that yields no addresses does not affect your credit balance
-
Address suggestions displayed in the drop down results via Address Finder do not affect your credit balance
-
Resolving the full address by UDPRN or UMPRN counts as 1 credit
-
Extracting Address Finder suggestions without resolving for a specific address is unfortunately a Terms of Service violation.
Credit Balance
Each account can produce one or more API Keys. These Keys are used to access addressing data.
Each Key has its own credit balance. This means usage from one key does not affect the balance of the other.
A credit balance is purchased ahead of time and generally permits one valid address lookup.
Postcode Lookup
Create an API Key from your dashboard.
Each postcode search which returns at least one premise deducts one credit from your credit balance.
A postcode search can return a maximum of 100 premises. If you are using the Multiple Residence dataset and retrieve more than 100 addresses, each additional page is 1 credit.
Invalid postcodes do not affect your balance.
Address Finder
Retrieving a list of suggestions for a given address query does not affect your credit balance. However, resolving a full address for a suggestion deducts 1 credit.
Note that the suggestion API must be used in conjunction with the address resolution APIs, i.e. you must intend to resolve a full address for at least one of your search suggestions. Consistently failing to do so violates our Terms of Service.