Added
- Postcode Endpoints group: exact postcode lookup (
GET /v1/countries/{cc}/postcodes/{code}, free on every plan) and paginated listing/search (GET /v1/countries/{cc}/postcodes, requires Supporter+ even for a bare list with no filters) — documents duplicate-match handling, cursor pagination (including expiry and tamper detection),q/state_code/city_id/typefilters, conditional-request (ETag/If-None-Match) support, and tier-based field availability - Non-deliverability disclaimer on postcode documentation: this is informational data, not an address verification or mail-deliverability service
Fixed
- Corrected the postcodes table’s field name from
postcodeto the authoritativecodethroughoutdatabase/postcodes.mdxanddatabase/schema.mdx(query examples, ER diagram, field reference, sample data) - Corrected
database/postcodes.mdx’s export-format claim: the postcodes table is included in the CSV and YAML exports; only the GeoJSON export excludes it - Replaced the postcode type reference’s fictional
full/outward/sector/district/arealist with the 5 values actually present in the current 844,248-row dataset (full,area,fsa,po_box,street), verified directly against the source data - Completed the postcodes table field reference in
database/schema.mdxwith the previously undocumentedcountry_id,state_id,state_code,city_id,latitude, andlongitudefields and their API access-level requirements
Added
- Search Endpoints group: fuzzy / typo-tolerant search (
GET /v1/search/fuzzy) for cities, states, and countries using trigram similarity — documentsq,type,country,limit,thresholdparameters, thematch_score/matched_aliasresponse fields, native-script matching, and Professional+ tier gating
Changed
- Updated
llms.txtto surface the fuzzy search capability for AI assistants
Added
- Field Filtering & Sorting cross-cutting guide — documents
?fields=and?sort=syntax, tier gating (Supporter+), per-entity sortable fields, behaviour rules, and error responses - ISO Code Endpoints group: lookup country by alpha-2/alpha-3/numeric, lookup state by ISO 3166-2 subdivision code, convert between ISO formats
- Phone Endpoints group: list dial codes with reverse lookup, get dial code by country, parse E.164 phone number into country + national parts
- Timezone Endpoints group: timezone by country, state, and city — with DST-aware response (IANA name, abbreviation, std/DST offsets, current-DST flag)
- Per-endpoint
?fields=/?sort=callout on every geographic list and detail page (12 endpoints) linking back to the cross-cutting guide
Changed
- Updated
llms.txtto surface the new endpoint groups for AI assistants - Standardised the “Related Endpoints” footer pattern across the new endpoint pages
Added
- API documentation covering endpoints, authentication, and usage
- Changelog, donation, and database documentation pages
- API FAQs section with key request instructions
- Home link to the documentation navbar
- Analytics integration for documentation site
- Custom icons and metadata configuration
- Mintlify-powered documentation site with dev and build scripts
Changed
- Updated free tier limits from 150 to 100 requests/day and 4,500 to 3,000 requests/month
- Updated API request limits and trial credits across documentation
- Updated export pricing documentation
- Removed rate limit details from public documentation for clarity
- Updated portal links to the new API key management site
- Updated API key request instructions in FAQ
- Improved overall documentation structure and content clarity
- Removed welcome section from index page for cleaner layout
Fixed
- Corrected documentation URLs and broken links
- Resolved miscellaneous documentation issues and formatting errors