Developer Portal
WorldClass Estimates API
A public, read-only REST API that exposes WorldClass Estimates business information — company profile, services, certifications, coverage, and blog content — as JSON, plus a lead-submission endpoint. No API key required.
Quickstart
Every endpoint is a plain HTTPS GET (except lead submission). No authentication or key is required.
# Company profile
curl -s https://www.worldclassestimates.com/v1/company
# List blog posts (Spanish)
curl -s "https://www.worldclassestimates.com/v1/blog?locale=es"
# Submit a lead
curl -s -X POST https://www.worldclassestimates.com/v1/leads \
-H "Content-Type: application/json" \
-d '{"name":"Jane Doe","email":"jane@example.com","message":"Need a supplement estimate."}'Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /v1 | API index / discovery document |
| GET | /v1/health | Service health check |
| GET | /v1/company | Company profile, contact, address |
| GET | /v1/services | Services offered and audiences served |
| GET | /v1/certifications | Team certifications |
| GET | /v1/coverage | Geographic coverage (on-site / remote) |
| GET | /v1/blog?locale=en | List blog posts (query: locale, category) |
| GET | /v1/blog/{slug}?locale=en | Single blog post (Markdown body) |
| POST | /v1/leads | Submit a lead / contact request |
The full machine-readable contract — request/response schemas and examples — is in the OpenAPI 3.1 specification.
Error model
All /v1 errors use RFC 9457 application/problem+json with a stable machine-readable code.
{
"type": "https://www.worldclassestimates.com/developers#error-invalid_locale",
"title": "Invalid locale",
"status": 400,
"code": "invalid_locale",
"detail": "Unsupported locale \"fr\".",
"hint": "Supported locales: en, es."
}Rate limits
Every response carries standard rate-limit headers so agents can self-throttle. When the limit is exceeded the API returns 429 Too Many Requests with a Retry-After header.
RateLimit-Limit: 120
RateLimit-Remaining: 119
RateLimit-Reset: 60
RateLimit-Policy: default;q=120;w=60
Retry-After: 60 # only on 429Versioning & deprecation
- The API is versioned in the URL path (
/v1/…). Breaking changes ship under a new prefix (/v2/…). - Additive, backward-compatible changes are made in place within a version.
- A deprecated endpoint or version returns a
Deprecation: trueheader and aSunset: <http-date>header (RFC 8594) ahead of removal.
CLI
An official command-line tool wraps the API for scripting and agents:
npx @worldclassestimates/cli company
npx @worldclassestimates/cli blog --locale es
npx @worldclassestimates/cli servicesSource: /cli in the project repository.
Resources
- /openapi.json — OpenAPI 3.1 specification
- /v1 — API index
- /llms.txt — site overview for AI agents (with when-to-use guidance)
- /llms-full.txt — full reference
- /sitemap.xml — indexable URLs
- Contact — questions about the API