API Reference

Authentication

Pass your API key in the X-Api-Key request header. Alternatively, append ?api_key=YOUR_KEY as a query parameter (less secure — use only for testing).

# Header (recommended)
curl https://www.publicsofttools.com/api/v1/util/uuid \
  -H "X-Api-Key: YOUR_API_KEY"

# Query param (testing only)
curl "https://www.publicsofttools.com/api/v1/util/uuid?api_key=YOUR_API_KEY"

No key yet? Email us to get a free key (1,500 calls/month) instantly.

Rate Limits

When you exceed the rate limit, the API returns HTTP 429 with a Retry-After header indicating seconds to wait.

Error Codes

All errors return a consistent JSON body:

{
  "success": false,
  "error": "Human-readable message",
  "code": "MACHINE_READABLE_CODE",
  "docs": "https://www.publicsofttools.com/developers/docs"
}

QR Code Generator

Generate a QR code from any text or URL. Returns a base64 PNG data URL or raw SVG string.

Request Body

Example Request

{
  "text": "https://publicsofttools.com",
  "size": 256,
  "format": "png"
}

Example Response

{
  "success": true,
  "data": {
    "image": "data:image/png;base64,iVBORw0KGgo...",
    "format": "png",
    "size": 256
  }
}

Hash Generator

Compute cryptographic hashes of a string. Omit `algorithm` to receive all five hashes in one response.

Request Body

Example Request

{ "text": "hello world" }

Example Response

{
  "success": true,
  "data": {
    "hashes": {
      "md5":    "5eb63bbbe01eeed093cb22bb8f5acdc3",
      "sha1":   "2aae6c69ec0821c0d6d8e9a9b1c0e8a7...",
      "sha256": "b94d27b9934d3e08a52e52d7da7dabfa...",
      "sha384": "fdbd8e75a67f29f701a4e040385e2e23...",
      "sha512": "309ecc489c12d6eb4cc40f50c902f2b4..."
    },
    "encoding": "hex",
    "input_length": 11
  }
}

UUID Generator

Generate one or more cryptographically random UUID v4 values.

Query Parameters

Example Request

GET /api/v1/util/uuid?count=3

Example Response

{
  "success": true,
  "data": {
    "uuids": [
      "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "b5c2a9f1-2d3e-4a5b-8c9d-0e1f2a3b4c5d",
      "c7d4e8f2-3e4f-5b6c-9d0e-1f2a3b4c5d6e"
    ],
    "count": 3
  }
}

Base64 Encode / Decode

Encode a string to Base64 or decode Base64 back to plaintext. Supports standard and URL-safe variants.

Request Body

Example Request

{
  "text": "Hello, World!",
  "action": "encode"
}

Example Response

{
  "success": true,
  "data": {
    "result": "SGVsbG8sIFdvcmxkIQ==",
    "action": "encode",
    "url_safe": false,
    "input_length": 13,
    "output_length": 20
  }
}

Password Generator

Generate cryptographically secure passwords with configurable character sets and length.

Request Body

Example Request

{
  "length": 20,
  "count": 3,
  "symbols": true,
  "exclude_ambiguous": true
}

Example Response

{
  "success": true,
  "data": {
    "passwords": ["Xk#9mP@2nQw!rY5vZe&J", "..."],
    "count": 3,
    "length": 20,
    "charset_size": 88
  }
}

IP Lookup

Get geolocation, ISP, ASN and proxy/VPN detection for any IPv4 or IPv6 address. Omit `ip` to look up the caller's own IP.

Query Parameters

Example Request

GET /api/v1/ip/lookup?ip=8.8.8.8

Example Response

{
  "success": true,
  "data": {
    "ip": "8.8.8.8",
    "country": "United States",
    "country_code": "US",
    "region": "Virginia",
    "city": "Ashburn",
    "zip": "20149",
    "lat": 39.03,
    "lon": -77.5,
    "timezone": "America/New_York",
    "isp": "Google LLC",
    "org": "Google Public DNS",
    "asn": "AS15169 Google LLC",
    "is_mobile": false,
    "is_proxy": false,
    "is_hosting": true
  }
}

DNS Records

Query DNS records for any domain. Returns all record types by default or a specific type via the `type` parameter.

Query Parameters

Example Request

GET /api/v1/domain/dns?domain=github.com&type=MX

Example Response

{
  "success": true,
  "data": {
    "domain": "github.com",
    "records": {
      "MX": [
        { "exchange": "aspmx.l.google.com", "priority": 1 },
        { "exchange": "alt1.aspmx.l.google.com", "priority": 5 }
      ]
    },
    "queried_at": "2026-05-24T10:00:00.000Z"
  }
}

SSL Certificate Checker

Retrieve SSL certificate details for any HTTPS domain including issuer, expiry date, SAN list and days remaining.

Query Parameters

Example Request

GET /api/v1/domain/ssl?domain=github.com

Example Response

{
  "success": true,
  "data": {
    "domain": "github.com",
    "is_valid": true,
    "days_remaining": 287,
    "valid_from": "2025-03-10T00:00:00.000Z",
    "valid_to": "2026-03-10T23:59:59.000Z",
    "subject": {
      "common_name": "github.com",
      "org": "GitHub, Inc.",
      "country": "US"
    },
    "issuer": {
      "common_name": "DigiCert TLS RSA SHA256 2020 CA1",
      "org": "DigiCert Inc",
      "country": "US"
    },
    "san": ["github.com", "www.github.com"]
  }
}

WHOIS Lookup

Look up domain registration data via RDAP — the modern HTTPS replacement for raw WHOIS. Returns registrar, registrant, dates, nameservers and status flags.

Query Parameters

Example Request

GET /api/v1/domain/whois?domain=github.com

Example Response

{
  "success": true,
  "data": {
    "domain": "github.com",
    "status": ["client delete prohibited", "client transfer prohibited"],
    "registered_at": "2007-10-09T18:20:50Z",
    "updated_at":    "2024-09-08T09:18:27Z",
    "expires_at":    "2026-10-09T18:20:50Z",
    "registrar": { "name": "MarkMonitor Inc.", "org": null, "email": null },
    "registrant": null,
    "nameservers": ["dns1.p08.nsone.net", "dns2.p08.nsone.net"],
    "queried_at": "2026-05-24T10:00:00.000Z"
  }
}