Pincode API docs

Authentication

API key (header: X-API-Key)

Send your key on every request. Do not put keys in client-side code or public repos. Rotate keys from the dashboard if a secret is exposed.

X-API-Key: YOUR_API_KEY

Rate limits

Default catalog limit: From 30 req/min. Plan-specific limits apply after you subscribe. When throttled, expect 429 with a retryable response — back off and retry with jitter.

• Lookup pincode: Plan-based
• Nearby pincodes: Plan-based

Errors

Errors return JSON with a machine-readable code and message. Common platform codes:

• 401 — missing or invalid API key
• 403 — key valid but not entitled for this API or plan
• 404 — resource or path not found
• 429 — rate limit exceeded; retry later
• 5xx — upstream or platform failure; retry with backoff

Endpoint-specific errors are listed under each endpoint below.

Versioning

Current documented version: v1. Prefer pinning the version path shown in examples. Breaking changes ship under a new version; check the changelog for platform updates.

Lookup pincode

Resolve a pincode to locality metadata.

Parameters

Example code

curl -s "https://pinlok.apiseeker.com/v1/pincode/560001" \
  -H "X-API-Key: YOUR_API_KEY"

Response example

{
  "pincode": "560001",
  "locality": "Bangalore GPO",
  "district": "Bengaluru",
  "state": "Karnataka"
}

Errors

• 400 — Invalid pincode
• 404 — Pincode not found

Nearby pincodes

Return nearby pincodes for logistics routing.

Parameters

Example code

curl -s "https://pinlok.apiseeker.com/v1/pincode/560001/nearby" \
  -H "X-API-Key: YOUR_API_KEY"

Response example

{
  "pincode": "560001",
  "nearby": [
    "560002",
    "560003",
    "560025"
  ]
}

Errors

• 400 — Invalid pincode
• 404 — Pincode not found