Skip to main content

Availability

GET 
/keys/:key

Returns public information on key. Currently only returns whether the key is currently useable via the available property. Use this to discover if the key is useable before making further requests.

You may pass both API Keys (beginning ak_) and Sub-licensed Keys (beginning sl_).

Testing​

To test your implementation of our API, you may use the following test keys.

  • iddqd Availability will return as true
  • idkfa Availability will return as false

Request​

Path Parameters

    key API Keyrequired

Responses​

Success

Schema
    result objectrequired
    contexts object[]required

    A list of available contexts for a key

  • Array [
    • iso_3 string

    3 letter ISO code

    iso_2 string

    2 letter ISO code

    description string

    Country descriptor to show in Address Finder

    emoji string

    Emoji text icon

    rgeo boolean

    Indicates availability of reverse geolocation search

  • ]
    • context objectrequired

    Returns current context if it is in the list of available contexts for this key.

    oneOf
  • string

    Limits search results within a geographical boundary or country.

    • available booleanrequired

    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 stringrequired

    Possible values: [Success]

    code int32required

    Possible values: [2000]

Loading...