Keys

Availability

Returns public information on an API Key: whether it can be used right now (available), the search contexts the key is licensed for (contexts) and the context that best matches the caller's IP address (context).

The endpoint accepts API Keys (beginning ak_) and sub-licensed keys (beginning sl_), and needs no Management Key.

A key that exists but cannot be used, because it has no lookups left or has breached a limit, returns 200 with "available": false. An unknown or malformed key returns an error.

Supply a valid Management Key and the endpoint returns the key's private details instead, as GET /keys/{key}/details does. A Management Key that does not own the key is rejected.

get/keys/{key}

Request

Base URL: https://api.addresszen.com/v1
URL: https://api.addresszen.com/v1/keys/{key}
Auth: none declared

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

Response

Success

message'Success' required

code2000 required

Example response

{
  "result": {
    "contexts": [
      {
        "iso_3": "USA",
        "iso_2": "US",
        "description": "United States",
        "emoji": "🇺🇸",
        "rgeo": true
      }
    ],
    "available": true
  }
}

Changes

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