Domain and IP PingerDomain and IP Pinger API

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

Overview

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

Example

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)
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))
}
Example Response
{
  "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
    ]
  }
}

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. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

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
alivebooleantrue
Whether the host is reachable and responding to ping requests
roundTripsnumber3
Number of successful ping round trips completed
packetLossPremiumnumber0
Percentage of packets lost during the ping operation
minMSPremiumnumber0.652
Minimum round trip time in milliseconds
avgMSPremiumnumber0.6846666666666666
Average round trip time in milliseconds
maxMSPremiumnumber0.712
Maximum round trip time in milliseconds
stdDevPremiumnumber0.02478350706058811
Standard deviation of round trip times
timesPremiumarray[0.712, ...]
Array of individual round trip times in milliseconds

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all 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 accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Domain and IP Pinger requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Domain and IP Pinger API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Domain and IP Pinger

Official Domain and IP Pinger packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

No-Code Integrations

Domain and IP Pinger works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See 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?