Keys
Details
Returns private data on the key including remaining lookups, available datasets and usage limits.
get/keys/{key}/details
Path parameters
keystring required
API Key
The API Key to retrieve. Begins ak_.
Query parameters
user_tokenstring
Private User Token
A secret key used for sensitive operations on your account and API Keys.
Your user token can be retrieved and managed from your accounts page.
Typically beings uk_...
Response
Success
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,
"gbrcleanse": true,
"uspscleanse": true
},
"automated_topups": {
"enabled": true
},
"current_purchases": [
{
"expires": "2022-01-06T11:41:27.092Z",
"purchased": 20000,
"consumed": 121
}
]
}
}