Ping API

  1. Introduction

    1. Welcome to the Documentation for the Geocode.Farm v4 Ping API. Here you can find the information on how to use and access the Ping API. The Ping API simply takes an input of any valid domain name, IPv4 address, or IPv6 address and provides you the Ping Return data in clean computer readable format. This Ping will of course be from our servers to the domain's hosting server, but may be helpful for diagnostic purposes.
    2. This API uses 1 credit on successful queries.

  2. Access

    1. The API is located at: https://api.geocode.farm/ping/
    2. Access to the API does require an active account and requires you to provide a valid v4 API Key. This can be found on the Products & Services page of the Client Area under your active service.

  3. Required Variables

      4. Variables below MUST be included as GET variables (?variable=value):
    1. key - Your v4 API Key shown in the Client Area on your active Service page.
    2. domain - Any Valid IPv4 or IPv6 Address, or Domain Name

  4. Example Request

    1. https://api.geocode.farm/ping/?key=YOUR_API_KEY&domain=1.1.1.1


Last Updated: 12-DEC-2023