You have been supplied with at least one dataset. Each dataset that you have purchased comprises at least three files. The main dataset file has the .dts extension and is accompanied by index files.

The files type you receive for each dataset are:

  • .dts
  • .tpx
  • .zlx
  • .kfx (datasets compatible with the Keyfinder engine only)
  • .zlb (certain datasets only)

The filenames are derived from the dataset identifier. These are three characters long and for most datasets are derived from the country's ISO code. For example, the UK dataset identifier is 'GBR', and the Australia dataset identifier is 'AUS'. For datasets that do not represent a particular country's address data, and therefore are not associated with an ISO code, the dataset identifier is a unique three-character identifier. For example, the Gazetteer dataset identifier is 'LPG'.

Dataset identifiers are used throughout the API and its documentation as unique three-character identifiers for datasets.

Additional datasets are available for some datasets. The additional datasets have the .ads extension and are supplied with index files. The filenames are derived from the dataset identifier with which they are associated. For example, the following files comprise GBR Business data:

  • gbrbus.ads
  • gbrbus.tpx
  • gbrbus.zlx

DataPlus sets are also available for some datasets and additional datasets. They have the .dap extension, and their filenames are derived from the dataset identifier. For example, the filename for the GBR Government DataPlus set is gbrgov.dap, and the filename for the AUS Mosaic Code DataPlus set is ausmos.dap.

USA and CAN datasets

The USA and CAN datasets require supplementary data and libraries for use in Batch API. For Windows users, these files are configured automatically by the Windows installer. UNIX users must copy the data files manually from the 'Data' directory of the USA/CAN Batch data disks (along with the UNIX libraries that are supplied separately), and update their configuration files.

Activating Metered Datasets

A click is the unit of measurement for a metered license. Depending on how such a license is set up, a click may be decremented from a meter when an address is matched in the dataset, or when data is appended to your matched records. For Suppression meters, a click may be decremented when an address record is suppressed or when a Suppression DataPlus flag is returned.

If you purchased a metered dataset (such as a Suppression additional dataset), you will need to activate these clicks before you can output any cleaning results from Batch API.

Batch API

Using our data