Embed Retirement Numbers
Read-only, source-labelled retirement numbers for community pages and reference tools.
Read-only endpoints
GET /api/v1/cola/2027 returns the current rate, projection status, observation count, source and retrieval date. GET /api/v1/payments/2027/3 returns all five payment groups, their scheduled date and the schedule month. Covered years: 2024-2028.
Rate limit and attribution
The API allows 60 requests per minute per connection IP. A 429 response carries Retry-After. Link back to the corresponding COLA or calendar page and preserve official/projected labels. Cache responses reasonably; do not imply that the website is a government service.
Two lightweight widgets
Use /embed/?type=cola&year=2027 for a COLA badge, or /embed/?type=payments&year=2027&month=3 for scheduled dates. Widgets have no analytics and accept display configuration only. They link to the detailed source page.
Copy a widget.
<iframe src="https://whatsmycola.com/embed/?type=cola&year=2027" title="2027 COLA estimate" width="400" height="400" loading="lazy"></iframe>