API Reference

Complete REST API documentation for the NetLoc8 geolocation service.

Base URL

HTTP
https: //api.netloc8.com

All endpoints are prefixed with /v1. The API is deployed across 300+ edge locations for global low-latency access.

Authentication

Most endpoints require an API key via the X-API-Key header. See the Authentication guide for details.

Bash
curl -H "X-API-Key: YOUR_KEY" https://api.netloc8.com/v1/ip/me

Common Headers

HeaderDescription
X-API-KeyYour API key (secret or publishable)
Content-Typeapplication/json (for POST/PATCH requests)
OriginRequired for publishable key requests (CORS)

Rate Limits

Rate limits depend on your plan tier. When exceeded, the API returns429 Too Many Requests.

PlanMonthly CapRate Limit
Free5,00010 req/min per key
Starter25,000120 req/min per key
Pro100,000600 req/min per key

Endpoints

Geolocation

IP-to-location lookups, timezone detection, and IP validation.

GET/v1/ip/meGET/v1/ip/{ipAddress}GET/v1/ip/me/timezoneGET/v1/ip/{ipAddress}/timezoneGET/v1/ip/{ipAddress}/validation

Account

User profile, API key CRUD, site management, usage stats, and audit log.

GET/v1/account/meGET/v1/account/me/keysPOST/v1/account/me/keysDELETE/v1/account/me/keys/{keyId}GET/v1/account/me/usage

Billing

Subscription management, plan listing, and Stripe checkout/portal.

GET/v1/billing/plansGET/v1/billing/subscriptionPOST/v1/billing/subscriptionDELETE/v1/billing/subscription

Telemetry

Real User Monitoring beacon ingestion and aggregated Web Vitals.

POST/v1/telemetry/rumGET/v1/telemetry/rum/summary

Public Endpoints

These endpoints require no authentication:

EndpointDescription
GET /v1Service metadata
GET /.well-known/openapi.jsonOpenAPI 3.1 specification
GET /healthHealth check (200 or 503)
GET /v1/billing/plansList available plans