Keys

Details

Returns private data on a key: remaining lookups, licensed datasets, usage limits, notification settings and the search contexts the key can serve.

get/keys/{key}/details

Request

  • Base URL: https://api.addresszen.com/v1
  • URL: https://api.addresszen.com/v1/keys/{key}/details
  • Auth: HTTP bearer

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

Query parameters

user_tokenstring

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_.... Prefer the Authorization: Bearer uk_... header.

Response

Success

code2000 required
message'Success' required

Example response

{
  "result": {
    "name": "My API Key",
    "contexts": [
      {
        "iso_3": "USA",
        "iso_2": "US",
        "description": "United States",
        "emoji": "🇺🇸",
        "rgeo": true
      }
    ],
    "lookups_remaining": 19889,
    "daily_limit": {
      "limit": 1000,
      "consumed": 288
    },
    "monthly_limit": {
      "limit": 10000,
      "consumed": 2500
    },
    "individual_limit": {
      "limit": 30
    },
    "notifications": {
      "emails": [
        "person@example.com"
      ],
      "balance_threshold": 500
    },
    "datasets": {
      "paf": true,
      "mr": true,
      "usps": true,
      "gnaf": true,
      "hereap": true,
      "herehk": true,
      "herei": true,
      "herem": true,
      "heremea": true,
      "heremeas": true,
      "herena": true,
      "hereo": true,
      "heresa": true,
      "heret": true,
      "hereee": true,
      "herewe": true,
      "phone": true,
      "email": true,
      "kartverket": true,
      "mois": true,
      "sdfi": true,
      "cannar": true,
      "fodbosa": true,
      "upujp": true,
      "bev": true,
      "ban": true,
      "swt": true,
      "gbrcleanse": true,
      "uspscleanse": true
    },
    "automated_topups": {
      "enabled": true
    },
    "current_purchases": [
      {
        "expires": "2022-01-06T11:41:27.092Z",
        "purchased": 20000,
        "consumed": 121
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.