--- title: "unclaimd API for developers and agents · unclaimd" description: "The unclaimd API and MCP server: search reviewed Australian government support listings and check broad answers. Endpoints, a curl example, rate limits, errors and versioning." url: "https://unclaimd.org/developers/" --- For developers and agents # unclaimd API A public, read-only API and MCP server for the reviewed listings of Australian government support on unclaimd. No sign-in, no API key and no cookies. ## Start here - Base address: https://unclaimd.org/api/v1/ . Every reply is JSON. - The full description is [OpenAPI 3.1 at /openapi.json](https://unclaimd.org/openapi.json). Agents can also read [/llms.txt](https://unclaimd.org/llms.txt). - Results are possible matches and leads to check, not eligibility decisions. Only the government agency decides. Send people to the official site linked in each result to apply. ## Endpoints - GET /api/v1/programs Search and list listings. Filters: state , topic , open , q (plain words), include\_national , limit (up to 100) and offset . Cash support comes first. - GET /api/v1/programs/{id} One listing: what it is worth, its main conditions, the official page to apply on, and the date a person last checked it. - POST /api/v1/match Check broad answers for one person or household. Returns possible matches, listings worth checking and less likely ones, each with reasons. Each group returns its first 15; next gives the group and offset to send, with the same answers, for more. - GET /api/v1/ An index of the endpoints, the rate limit and the versioning policy. ## Example Search for electricity rebates in Queensland: Check broad answers. Every answer is optional; leave out anything you don't know. The answers are used for this reply only and are never stored or logged. Only send broad answers, like a state, an age range or the type of card someone holds. Never send names, card or reference numbers, incomes, health details or ID documents. ## MCP server The MCP server is at https://unclaimd.org/mcp . It uses Streamable HTTP, answers each request with JSON, is read-only and needs no sign-in. Its tools are: - search\_programs : search listings by words, state, topic and whether a round is open. - get\_program : one listing's details, conditions, review date and official link. - check\_possible\_matches : check broad answers against current listings. Its server card is at [/.well-known/mcp/server-card.json](https://unclaimd.org/.well-known/mcp/server-card.json), and its registry entry at [/server.json](https://unclaimd.org/server.json). ## Rate limits Each connection may make 40 requests a minute, across the API and the MCP server together. Every reply carries the IETF RateLimit and RateLimit-Policy headers, plus RateLimit-Limit and RateLimit-Reset . Over the limit, you get 429 Too Many Requests with Retry-After in seconds. Our network firewall may also refuse a fast burst of requests for a few seconds, with a 429. Space your requests out, and wait for Retry-After before trying again. ## Errors Every error is an RFC 9457 problem ( application/problem+json ) with a stable code , a plain message and the fix to apply before trying again. The OpenAPI description gives every 4xx and 5xx reply the same Problem schema. The codes are invalid\_parameter , unknown\_parameter , invalid\_body , invalid\_json , unknown\_answer , invalid\_answer , program\_not\_found , endpoint\_not\_found , method\_not\_allowed , unsupported\_media\_type , payload\_too\_large (bodies are limited to 16 KB), rate\_limited and server\_error . ## Versioning and deprecation The API is versioned in the path: /api/v1/ . Within v1, fields are only ever added, never removed or renamed. A breaking change would be published as /api/v2/ . v1 would then keep working for at least 6 months. During that time, every v1 reply would carry a Deprecation header (RFC 9745), a Sunset header (RFC 8594) with the shutdown date, and a Link header with rel="successor-version" . We would also say so on this page. No v1 endpoint is deprecated today. ## For agents - [/llms.txt](https://unclaimd.org/llms.txt) says when to use unclaimd and how. - The home page answers Accept: text/markdown with Markdown. Every page also has a Markdown copy at /index.md . - The API catalog is at [/.well-known/api-catalog](https://unclaimd.org/.well-known/api-catalog) (RFC 9727), and an agent skill at [/.well-known/agent-skills/index.json](https://unclaimd.org/.well-known/agent-skills/index.json). ## What the data covers Listings are support for individuals and households from federal, state, territory and some council governments. It is not a complete list of government support, and it does not cover business grants. [Our sources and coverage](https://unclaimd.org/sources/) ## Questions or problems Tell us if the API gets something wrong. Read the [terms of use](https://unclaimd.org/terms/) before you build on it. [Contact us](https://unclaimd.org/contact/) --- unclaimd lists possible matches and leads to check, not eligibility decisions. Only the government agency decides. Check the rules and apply on the official government site. More: [Site map](https://unclaimd.org/sitemap/) · [How agents can use unclaimd](https://unclaimd.org/llms.txt)