---
title: "Availability"
method: GET
path: "/keys/{key}"
tags: ["Keys"]
---

# Availability

`GET /keys/{key}`

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_`).

## Path parameters

- `key` string, required

## Response `200`

Success

- ApiKeyResponse
  - `result` ApiKey, required
    - `contexts` object[], required — A list of available contexts for a key
      - `iso_3` string, required — 3 letter ISO code
      - `iso_2` string, required — 2 letter ISO code
      - `description` string, required — Country descriptor to show in Address Finder
      - `emoji` string, required — Emoji text icon
      - `rgeo` boolean, required — Indicates availability of reverse geolocation search
    - `context` union, required — Returns current context if it is in the list of available contexts for this key.
      - string — Limits search results within a geographical boundary or country.
      - '' — Empty string if no context is provided or key check has failed
    - `available` boolean, required — Determines whether the key can be used by the requesting agent. Returns false if one of the following conditions are met: - Key has no lookups remaining - Daily limit has been reached on the key - Daily individual limit has been reached - Key is not being used via an authorised URL - (Sublicensed key only) Key has a valid licensee attached - (Sublicensed key only) Key is not being used via an authorised URL specified by licensee
  - `message` 'Success', required
  - `code` 2000, required

## Other responses

- `404` — Invalid Key

---

[API](https://skmtc.net/ideal-postcodes/apis/api-reference.md) · [All operations](https://skmtc.net/ideal-postcodes/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideal-postcodes/api-reference/versions/295dd3238f22/schema)