POST /api/aboutapi

Returns information about the PostalDataPI API, including version and coverage details. Useful for health checks and verifying connectivity.

Request

POST https://postaldatapi.com/api/aboutapi
Content-Type: application/json

Body Parameters

Parameter	Type	Required	Description
apiKey	string	Yes	Your API key

Response

Success (200)

{
  "About": "Zip Data API provides US ZIP code lookup, city/state search, and metadata endpoints with Lightning Cache performance.",
  "version": "2.0.0-LC (Lightning Cache)",
  "coverage": "All US ZIP codes, city/state mappings, and metadata served from memory at <1ms response times.",
  "usage": "See docs for authentication, rate limits, and endpoint usage. Now powered by Lightning Cache for sub-10ms API responses.",
  "performance": { "totalTime": "1ms" },
  "balance": 4.99
}

Response Fields

Field	Type	Description
About	string	API description
version	string	Current API version
coverage	string	Data coverage description
usage	string	Usage guidelines summary
balance	number	Account balance (USD)

Example

curl -X POST https://postaldatapi.com/api/aboutapi \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "YOUR_API_KEY"}'

Errors

Status	Error	Cause
400	Missing or invalid 'apiKey'	No apiKey in request body
401	Invalid API key	API key does not exist or was revoked