---
title: "Details"
method: GET
path: "/keys/{key}/details"
tags: ["Keys"]
---

# Details

`GET /keys/{key}/details`

Returns private data on the key including remaining lookups, available datasets and usage limits.

## Path parameters

- `key` string, required

## Query parameters

- `user_token` string

## Response `200`

Success

- ApiKeyDetailsResponse
  - `result` ApiKeyDetails, required
    - `name` string, required — A name for the key
    - `contexts` object[], required — A list of available contexts for a key
      - `iso_3` string, required — 3 letter ISO code
      - `iso_2` string, required — 2 letter ISO code
      - `description` string, required — Country descriptor to show in Address Finder
      - `emoji` string, required — Emoji text icon
      - `rgeo` boolean, required — Indicates availability of reverse geolocation search
    - `lookups_remaining` integer, required
    - `daily_limit` ApiKeyDailyLimit, required
      - `limit` integer, nullable, required — `number` or `null`. The daily lookup limit currently set on your key. `null` means the limit is currently disabled.
      - `consumed` integer, required — Number of lookups performed today which count towards your daily limit.
    - `monthly_limit` ApiKeyMonthlyLimit, required
      - `limit` integer, nullable, required — `number` or `null`. The monthly lookup limit currently set on your key. `null` means the limit is currently disabled.
      - `consumed` integer, required — Number of lookups performed this month which count towards your monthly limit.
    - `individual_limit` ApiKeyIndividualLimit, required
      - `limit` integer, nullable, required — `number` or `null` Limit set on the number of lookups that can be performed from a single IP address. `null` means the limit is currently disabled.
    - `allowed_urls` string[], required — A list of allowed URLs. An empty list means that allowed URLs are disabled.
    - `redact_days` integer, required — Number of days to preserve personal data stored in your key usage history. Set to 0 to prevent personal data storage
    - `notifications` ApiKeyNotifications, required
      - `emails` string[], required — A list of email addresses designated by you to receive notifications about this key.
      - `enabled` boolean, required — Indicates whether email notifications are enabled.
      - `balance_threshold` integer, nullable, required — Balance threshold that triggers a reminder email. null means disabled.
      - `no_balance` boolean, required — Send notice when balance hits zero.
      - `limit_reached` boolean, required — Send notice when rate limit is reached.
    - `datasets` ApiKeyDatasets, required — Indicates which datasets are available and added by default to the address responses
      - `paf` boolean, required — UK Main Address File (Postcode Address File)
      - `pafa` boolean, required — UK Property Alias dataset
      - `pafw` boolean, required — UK Welsh Language Dataset
      - `mr` boolean, required — UK Multiple Residence Dataset
      - `nyb` boolean, required — UK Not Yet Built Dataset
      - `ab` boolean, required — UK AddressBase dataset
      - `nip` boolean, required — Northern Ireland Pointer Dataset
      - `usps` boolean, required — US Address Dataset
      - `ecad` boolean, required — Republic of Ireland: Eircode Address Database
      - `ecaf` boolean, required — Republic of Ireland: Eircode Address File
      - `gnaf` boolean, required — Australia: Geocoded National Address File
      - `hereap` boolean, required — Asia Pacific Address File
      - `herehk` boolean, required — Hong Kong Address File
      - `herei` boolean, required — India Address File
      - `herem` boolean, required — Macau Address File
      - `heremea` boolean, required — Middle East and Africa Address File
      - `heremeas` boolean, required — Middle East and Africa Standalone Intermediate Maps Address File
      - `herena` boolean, required — North America Address File
      - `hereo` boolean, required — Oceania Address File
      - `heresa` boolean, required — South America Address File
      - `heret` boolean, required — Taiwan Address File
      - `hereee` boolean, required — Eastern Europe Address File
      - `herewe` boolean, required — Western Europe Address File
      - `phone` boolean, required — Phone validation is enabled
      - `email` boolean, required — Email validation is enabled
      - `kadaster` boolean, required — Netherlands: Kadaster BAG 2.0 Address File
      - `kartverket` boolean, required — Norway: Kartverket Address File
      - `mois` boolean, required — South Korea: MOIS Address File
      - `sdfi` boolean, required — Denmark: Danmarks Adresseregister (DAR)
      - `cannar` boolean, required — Canada: Statistics Canada National Address Register
      - `fodbosa` boolean, required — Belgium: FOD BOSA Address File
      - `upujp` boolean, required — Japan: UPU Address File
      - `bev` boolean, required — Austria: BEV Address File
      - `gbrcleanse` boolean, required — UK GBR Cleanse
      - `uspscleanse` boolean, required — US CASS Cleanse
    - `automated_topups` ApiKeyAutomatedTopup, required — Automated topup status
      - `enabled` boolean, required — Indicates whether automated top-ups are enabled
    - `current_purchases` ApiKeyCurrentPurchase[], required — Current balance purchases attached to key.
      - `expires` string, nullable, required — `string` or `null` The date when this purchase will expire in simplified extended ISO format (ISO 8601). This is typically 365 days from the time of first use. This field will be `null` if the purchase has not yet been used.
      - `purchased` integer, required — Number of procured lookups from this purchase.
      - `consumed` integer, required — Number of consumed lookups off this purchase.
    - `ip_forwarding` boolean, required — Accept IP addresses forwarded in the `IDPC-Source-IP` header
  - `code` 2000, required
  - `message` 'Success', required

## Other responses

- `401` — Unauthorised
- `404` — Resource not found

---

[API](https://skmtc.net/ideal-postcodes/apis/api-reference.md) · [All operations](https://skmtc.net/ideal-postcodes/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideal-postcodes/api-reference/versions/295dd3238f22/schema)