Keys
Availability
Returns public information on your API Key.
This endpoint can be used for the following:
- Determine if the key is currently usable via the available property
- Determine available contexts for an API Key
- Identify the currently likely context of a user given their location
You may pass both API Keys (beginning ak_) and Sub-licensed Keys (beginning sl_).
get/keys/{key}
Path parameters
keystring required
API Key
The API Key to retrieve. Begins ak_.
Response
Success
Example response
{
"result": {
"contexts": [
{
"iso_3": "USA",
"iso_2": "US",
"description": "United States",
"emoji": "🇺🇸",
"rgeo": true
}
],
"available": true
}
}