Domain and IP PingerDomain and IP Pinger API

OnlineCredit Usage:1 per callLive Data
avg: 246ms|p50: 233ms|p75: 255ms|p90: 281ms|p99: 335ms

Pinger is a simple tool for checking if a URL is up. It returns a boolean value indicating whether the URL is up or not.

The Domain and IP Pinger API provides reliable and fast access to domain and ip pinger data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

To use Domain and IP Pinger, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

URL
https://api.apiverve.com/v1/pinger

Code Examples

Here are examples of how to call the Domain and IP Pinger API in different programming languages:

cURL Request
curl -X POST \
  "https://api.apiverve.com/v1/pinger" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "host": "google.com",
  "retries": 1
}'
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/pinger', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "host": "google.com",
    "retries": 1
})
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

payload = {
    "host": "google.com",
    "retries": 1
}

response = requests.post('https://api.apiverve.com/v1/pinger', headers=headers, json=payload)

data = response.json()
print(data)
Node.js (Native HTTPS)
const https = require('https');
const url = require('url');

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const postData = JSON.stringify({
  "host": "google.com",
  "retries": 1
});

const req = https.request('https://api.apiverve.com/v1/pinger', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.write(postData);
req.end();
PHP (cURL)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/pinger');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode({
    'host': 'google.com',
    'retries': 1
}));

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
Go (net/http)
package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "host": "google.com",
        "retries": "1"
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/pinger", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Ruby (Net::HTTP)
require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/pinger')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

payload = {
  "host": "google.com",
  "retries": 1
}

request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

request.body = payload.to_json

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))
C# (HttpClient)
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        var jsonContent = @"{
        ""host"": ""google.com"",
        ""retries"": 1
}";
        var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");

        var response = await client.PostAsync("https://api.apiverve.com/v1/pinger", content);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

The Domain and IP Pinger API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Domain and IP Pinger API directly in your browser with live requests and responses.

Parameters

The Domain and IP Pinger API supports multiple query options. Use one of the following:

Some Domain and IP Pinger parameters marked with Premium are available exclusively on paid plans.View pricing

Option 1: Ping Host Domain

ParameterTypeRequiredDescriptionDefaultExample
hoststringrequired
The host name or public IP that you want to ping
-google.com
timeoutPremiumintegeroptional
The timeout for the ping request in milliseconds
Range: 100 - 3000
15001000
retriesintegeroptional
The number of ping retries to attempt
Range: 1 - 5
11

Option 2: Ping Public IP Address

ParameterTypeRequiredDescriptionDefaultExample
hoststringrequired
The public IP address that you want to ping
-98.137.27.103
timeoutPremiumintegeroptional
The timeout for the ping request in milliseconds
Range: 100 - 3000
15001000
retriesintegeroptional
The number of ping retries to attempt
Range: 1 - 5
11

Response

The Domain and IP Pinger API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

JSON Response
200 OK
{
  "status": "ok",
  "error": null,
  "data": {
    "host": "google.com",
    "numericHost": "2607:f8b0:4001:c6e::8a",
    "alive": true,
    "roundTrips": 3,
    "packetLoss": 0,
    "minMS": 0.652,
    "avgMS": 0.6846666666666666,
    "maxMS": 0.712,
    "stdDev": 0.02478350706058811,
    "times": [
      0.712,
      0.652,
      0.69
    ]
  }
}
XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <host>google.com</host>
    <numericHost>2607:f8b0:4001:c6e::8a</numericHost>
    <alive>true</alive>
    <roundTrips>3</roundTrips>
    <packetLoss>0</packetLoss>
    <minMS>0.652</minMS>
    <avgMS>0.6846666666666666</avgMS>
    <maxMS>0.712</maxMS>
    <stdDev>0.02478350706058811</stdDev>
    <times>
      <time>0.712</time>
      <time>0.652</time>
      <time>0.69</time>
    </times>
  </data>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  host: google.com
  numericHost: 2607:f8b0:4001:c6e::8a
  alive: true
  roundTrips: 3
  packetLoss: 0
  minMS: 0.652
  avgMS: 0.6846666666666666
  maxMS: 0.712
  stdDev: 0.02478350706058811
  times:
    - 0.712
    - 0.652
    - 0.69
CSV Response
200 OK
keyvalue
hostgoogle.com
numericHost2607:f8b0:4001:c6e::8a
alivetrue
roundTrips3
packetLoss0
minMS0.652
avgMS0.6846666666666666
maxMS0.712
stdDev0.02478350706058811
times[0.712,0.652,0.69]

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Response fields marked with Premium are available exclusively on paid plans.View pricing
FieldTypeSample ValueDescription
hoststring"google.com"The hostname or IP address that was pinged
numericHostPremiumstring"2607:f8b0:4001:c6e::8a"The numeric IP address of the host that was pinged
alivebooleantrueWhether the host is reachable and responding to ping requests
roundTripsnumber3Number of successful ping round trips completed
packetLossPremiumnumber0Percentage of packets lost during the ping operation
minMSPremiumnumber0.652Minimum round trip time in milliseconds
avgMSPremiumnumber0.6846666666666666Average round trip time in milliseconds
maxMSPremiumnumber0.712Maximum round trip time in milliseconds
stdDevPremiumnumber0.02478350706058811Standard deviation of round trip times
timesPremiumarray[0.712, ...]Array of individual round trip times in milliseconds

Headers

Required and optional headers for Domain and IP Pinger API requests:

Header NameRequiredExample ValueDescription
X-API-Keyrequiredyour_api_key_hereYour APIVerve API key. Found in your dashboard under API Keys.
Acceptoptionalapplication/jsonSpecify response format: application/json (default), application/xml, or application/yaml
User-AgentoptionalMyApp/1.0Identifies your application for analytics and debugging purposes
X-Request-IDoptionalreq_123456789Custom request identifier for tracking and debugging requests
Cache-Controloptionalno-cacheControl caching behavior for the request and response

Learn more about request headers →

GraphQL AccessALPHA

Access Domain and IP Pinger through GraphQL to combine it with other API calls in a single request. Query only the domain and ip pinger data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Domain and IP Pinger in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  pinger(
    input: {
      host: "google.com"
      retries: 1
    }
  ) {
    host
    numericHost
    alive
    roundTrips
    packetLoss
    minMS
    avgMS
    maxMS
    stdDev
    times
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Domain and IP Pinger API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Domain and IP Pinger directly from browser-based applications without proxy servers.

CORS HeaderValueDescription
Access-Control-Allow-Origin*Accepts requests from any origin
Access-Control-Allow-Methods*Accepts any HTTP method
Access-Control-Allow-Headers*Accepts any request headers

Browser Usage: You can call Domain and IP Pinger directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.

Learn more about CORS support →

Rate Limiting

Domain and IP Pinger API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Domain and IP Pinger users.

PlanRate LimitDescription
Free5 requests/minHard rate limit enforced - exceeding will return 429 errors
StarterNo LimitProduction ready - standard traffic priority
ProNo LimitProduction ready - preferred traffic priority
MegaNo LimitProduction ready - highest traffic priority

Learn more about rate limiting →

Rate Limit Headers

When rate limits apply, each Domain and IP Pinger response includes headers to help you track your usage:

HeaderDescription
X-RateLimit-LimitMaximum number of requests allowed per time window
X-RateLimit-RemainingNumber of requests remaining in the current window
X-RateLimit-ResetUnix timestamp when the rate limit window resets

Handling Rate Limits

Free Plan: When you exceed your rate limit, Domain and IP Pinger returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices for Domain and IP Pinger:

  • Monitor the rate limit headers to track your Domain and IP Pinger usage (Free plan only)
  • Cache domain and ip pinger responses where appropriate to reduce API calls
  • Upgrade to Pro or Mega for guaranteed no-throttle Domain and IP Pinger performance

Note: Domain and IP Pinger rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Domain and IP Pinger on Free tier.

Error Codes

The Domain and IP Pinger API uses standard HTTP status codes to indicate success or failure:

CodeMessageDescriptionSolution
200OKRequest successful, data returnedNo action needed - request was successful
400Bad RequestInvalid request parameters or malformed requestCheck required parameters and ensure values match expected formats
401UnauthorizedMissing or invalid API keyInclude x-api-key header with valid API key from dashboard
403ForbiddenAPI key lacks permission or insufficient creditsCheck credit balance in dashboard or upgrade plan
429Too Many RequestsRate limit exceeded (Free: 5 req/min)Implement request throttling or upgrade to paid plan
500Internal Server ErrorServer error occurredRetry request after a few seconds, contact support if persists
503Service UnavailableAPI temporarily unavailableWait and retry, check status page for maintenance updates

Learn more about error handling →

Need help? Contact support with your X-Request-ID for assistance.

Integrate Domain and IP Pinger with SDKs

Get started quickly with official Domain and IP Pinger SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.

Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.

Integrate Domain and IP Pinger with No-Code API Tools

Connect the Domain and IP Pinger API to your favorite automation platform without writing code. Build workflows that leverage domain and ip pinger data across thousands of apps.

All platforms use your same API key to access Domain and IP Pinger. Visit our integrations hub for step-by-step setup guides.

Frequently Asked Questions

How do I get an API key for Domain and IP Pinger?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Domain and IP Pinger and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Domain and IP Pinger cost?

Each successful Domain and IP Pinger API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful domain and ip pinger lookups.

Can I use Domain and IP Pinger in production?

The free plan is for testing and development only. For production use of Domain and IP Pinger, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Domain and IP Pinger from a browser?
Yes! The Domain and IP Pinger API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my Domain and IP Pinger credit limit?

When you reach your monthly credit limit, Domain and IP Pinger API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?