A collection of skills for AI coding agents (Claude Code, Cursor, Codex) providing guidance for integrating Ideal Postcodes APIs, widgets, and CLI.
npx skills add ideal-postcodes/skillsOr configure a plugin manually in your Claude Code settings.
| Skill | Description |
|---|---|
ideal-postcodes-address-finder |
Address autocomplete widget — suggestions as the user types, populates form fields on selection (@ideal-postcodes/address-finder) |
ideal-postcodes-postcode-lookup |
Postcode search widget — postcode in, address dropdown out, fills the form (@ideal-postcodes/postcode-lookup) |
ideal-postcodes-react |
React address autocomplete component — <AddressFinder> for React/Next.js, auto-populates fields on selection (@ideal-postcodes/react) |
ideal-postcodes-api-integration |
Direct API integration - auth, /postcodes, /autocomplete find and resolve, /cleanse, /places, key admin, the Address model and its native dataset records, error handling |
ideal-postcodes-js-sdk |
Fetch-based TypeScript SDK - typed API calls, autocomplete, error handling and React or Preact Query adapters (@ideal-postcodes/sdk) |
ideal-postcodes-python-sdk |
Python SDK - typed methods and Pydantic models for every API operation: postcode and UPRN lookup, cleanse, email and phone validation, keys and licensees (ideal-postcodes on PyPI) |
ideal-postcodes-cli |
Drive the API from the terminal — manage keys, cleanse addresses, resolve from partial queries via the idpc CLI |
Each skill includes quickstarts, critical gotchas, and reference documentation tailored for agents. For comprehensive API reference, see docs.ideal-postcodes.co.uk.
These skills are authored in the private ideal-postcodes/atlas monorepo under packages/skills-ideal/ and mirrored to this public repo. To contribute:
- Report issues here on GitHub
- Submit PRs here; maintainers will cherry-pick into atlas
- Reach out at support@ideal-postcodes.co.uk if you have questions
SEE LICENSE IN LICENSE