Quickstart - PocketUtils

This guide takes you from a fresh account to a successful API response.

Want to try an endpoint before writing any code? Every tool page has a live playground that calls the exact same production endpoint documented here — no signup required.

Prerequisites

A PocketUtils account — sign up free
A Starter plan or above. API keys aren’t available on the Free plan — Free is the browser-playground allowance. See Rate Limits & Credits for what each plan includes.

Get started

Create an API key

From your dashboard, click New key, give it a name (e.g. “Production”), and copy the generated secret immediately.

pu_live_9f2a1c7e4b3d8f0a6e5c1b2d3a4f5e6c

The full key is shown exactly once, at creation. PocketUtils stores only its hash — if you lose the key, revoke it from the dashboard and create a new one.

Make your first request

Call any endpoint with your key in the Authorization header. GET /v1/down-check is the simplest place to start — it just takes a URL to check.

curl "https://api.pocketutils.com/v1/down-check?url=https://example.com" \
  -H "Authorization: Bearer pu_live_9f2a1c7e4b3d8f0a6e5c1b2d3a4f5e6c"

const res = await fetch(
  "https://api.pocketutils.com/v1/down-check?url=https://example.com",
  {
    headers: {
      Authorization: "Bearer pu_live_9f2a1c7e4b3d8f0a6e5c1b2d3a4f5e6c",
    },
  },
);
const data = await res.json();
console.log(data);

import requests

res = requests.get(
    "https://api.pocketutils.com/v1/down-check",
    params={"url": "https://example.com"},
    headers={"Authorization": "Bearer pu_live_9f2a1c7e4b3d8f0a6e5c1b2d3a4f5e6c"},
)
print(res.json())

Read the response

A successful call always returns success: true with the result under data:

{
  "success": true,
  "data": {
    "url": "https://example.com",
    "testedFrom": "India (Mumbai)",
    "httpsStatus": 200,
    "responseTimeMs": 214,
    "ipAddress": "93.184.216.34"
  }
}

Every response also carries an X-Credits-Remaining header, or you can check your balance explicitly with GET /v1/quota.

Handle errors

A failed call always returns success: false — and never spends a credit:

{
  "success": false,
  "error": {
    "code": "insufficient_credits",
    "message": "Not enough credits for this request. Buy a top-up pack or wait for your cycle to renew.",
    "creditsRequired": 1
  }
}

See the full error code reference.

Next steps

Authentication

All three ways to call the API, and how each is billed.

API Reference

Every endpoint, with parameters, responses, and examples.

Need help? Reach out at support@pocketutils.com.

​Prerequisites

​Get started

​Next steps

Authentication

API Reference

Prerequisites

Get started

Next steps