Details

GET 
/keys/:key/details

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

Request

Path Parameters

key API Keyrequired

Query Parameters

user_token User Token

Responses

200

Success

application/json

Schema

Schema

result objectrequired
lookups_remaining int32required
daily_limit objectrequired
limit int32required
number or null. The daily lookup limit currently set on your key. null means the limit is currently disabled.
consumed int32required
Number of lookups performed today which count towards your daily limit.
individual_limit objectrequired
limit int32required
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.
notifications object
emails string[]required
A list of email addresses designated by you to receive notifications about this key.
enabled booleanrequired
Indicates whether email notifications are enabled.
datasets object
Indicates which datasets are available and added by default to the address responses
paf booleanrequired
UK Postcode Address File enabled
mr booleanrequired
UK Multiple Residence Dataset enabled
nyb booleanrequired
UK Not Yet Built Dataset enabled
automated_topups objectrequired
Automated topup status
enabled booleanrequired
Indicates whether automated top-ups are enabled
current_purchases object[]required
Current balance purchases attached to key.
Array [
expires stringrequired
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 int32required
Number of procured lookups from this purchase.
consumed int32required
Number of consumed lookups off this purchase.
]
code int32required

Possible values: [2000]

message stringrequired

Possible values: [Success]

Example (from schema)

{
  "result": {
    "lookups_remaining": 19889,
    "daily_limit": {
      "limit": 1000,
      "consumed": 288
    },
    "individual_limit": {
      "limit": 30
    },
    "allowed_urls": [
      "string"
    ],
    "notifications": {
      "emails": [
        "person@example.com"
      ],
      "enabled": true
    },
    "datasets": {
      "paf": true,
      "mr": true,
      "nyb": false
    },
    "automated_topups": {
      "enabled": true
    },
    "current_purchases": [
      {
        "expires": "2022-01-06T11:41:27.092Z",
        "purchased": 20000,
        "consumed": 121
      }
    ]
  },
  "code": 2000,
  "message": "Success"
}

404

Resource not found

application/json

Schema

Schema

code int32required

API Response Code. Non 2xxx code indicates a failure. This code will provide a more specific reason when a failure occurs and facilitates debugging.

message stringrequired

Human readable error message supplied with every error response.

Example (from schema)

{
  "code": 0,
  "message": "string"
}

Loading...