API documentation

Responses

The JSON response structure used by the public API.

Success response

Successful V1 responses use a boolean success value with endpoint-specific data and a meta object. Do not expect the older status: "success" format.

{
  "success": true,
  "data": {
    "pincode": "751001",
    "post_offices": [
      {
        "id": 98131,
        "circle": "Odisha Circle",
        "circle_slug": "odisha-circle",
        "region": "Bhubaneswar Hq Region",
        "region_slug": "bhubaneswar-hq-region",
        "division": "Bhubaneswar Division",
        "division_slug": "bhubaneswar-division",
        "office_name": "Bhubaneswar G. P. O.",
        "office_slug": "bhubaneswar-g-p-o",
        "pincode": "751001",
        "office_type": "HO",
        "delivery_status": "Delivery",
        "district": "Khordha",
        "district_slug": "khordha",
        "state": "Odisha",
        "state_slug": "odisha",
        "latitude": 20.2723056,
        "longitude": 85.8339722,
        "digipin": "5C8263L46F"
      }
    ]
  },
  "meta": {
    "api_version": "v1",
    "dataset_version": "2026-06-27",
    "release_id": "20260627-0d584ba5d757",
    "request_id": "example-request-id",
    "count": 4
  }
}

Public field names

API clients should use the V1 JSON names such as office_name, office_type, delivery_status, state and state_slug. Source CSV column names such as officename, officetype and statename are not public response-field names.

Search results

Search uses the same success, data and meta envelope. The data object can contain a post_offices collection and the search query. Always check the HTTP status before reading the response as a success result.

Missing optional values

Coordinates and DIGIPIN can be null or absent when the source does not provide a usable value. Applications should not invent replacement coordinates or treat a missing value as zero.