{"openapi":"3.1.0","info":{"title":"International Address Formats","version":"1.0.0","description":"Postal address formats, postal-code validation and subdivisions for about 240 countries from a bundled Google i18n snapshot. One call, one computed answer, no accounts or API keys. Machine-payable over x402.","x-guidance":"International Address Formats: Postal address formats, postal-code validation and subdivisions for about 240 countries from a bundled Google i18n snapshot. Use /address-format for a country's field order, /postal-code-check to validate a code, /format-address to render an address, /country-address-fields for field labels, /postal-code-examples, /subdivisions for states and provinces, /address-parse-hints to guess the country from a postal code shape and /po-box-check for PO box wording. Each paid GET returns a computed verdict with the reasons, the source and what was NOT checked. A verdict of UNVERIFIED means a lookup failed: treat it as unknown. No account or key: pay per call in USDC over x402."},"servers":[{"url":"https://address-formats.x402tookit.com"}],"paths":{"/address-format":{"get":{"operationId":"address_format","summary":"A country's postal address layout: line order template, required fields, uppercase rules and field labels.","description":"A country's postal address layout: line order template, required fields, uppercase rules and field labels.","tags":["address","format","i18n","postal"],"parameters":[{"name":"country","in":"query","required":true,"description":"ISO 3166-1 alpha-2 code, e.g. US, GB, JP","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer.","content":{"application/json":{"schema":{"type":"object","properties":{"verdict":{"type":["null","string"]},"summary":{"type":["null","string"]},"reasons":{"type":["array","null"],"items":{"type":"string"}},"country":{"type":["null","string"]},"countryName":{"type":["null","string"]},"template":{"type":["null","string"]},"templateLines":{"type":["array","null"],"items":{"type":"string"}},"latinTemplate":{},"requiredLetters":{"type":["null","string"]},"uppercaseLetters":{"type":["null","string"]},"fields":{"type":["array","null"],"items":{"type":"object","properties":{"field":{"type":["null","string"]},"token":{"type":["null","string"]},"label":{"type":["null","string"]},"required":{"type":["boolean","null"]},"uppercase":{"type":["boolean","null"]}}}},"postalCodeLabel":{"type":["null","string"]},"hasPostalCodePattern":{"type":["boolean","null"]},"postalCodeExample":{"type":["null","string"]},"languages":{"type":["null","string"]},"postalAuthorityUrl":{"type":["null","string"]},"snapshotDate":{"type":["null","string"]},"dataSource":{"type":["null","string"]},"attribution":{"type":["null","string"]},"degraded":{"type":["boolean","null"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"asOf":{"type":["null","string"]},"disclaimer":{"type":["null","string"]}}},"example":{"verdict":"FOUND","summary":"UNITED STATES: address lines run 4 deep; required fields A,C,S,Z; postal code pattern known.","reasons":["Tokens: N recipient, O organization, A street lines, D dependent locality, C city, S state/province, Z postal code, X sorting code."],"country":"US","countryName":"UNITED STATES","template":"%N%n%O%n%A%n%C, %S %Z","templateLines":["{N}","{O}","…2 more"],"latinTemplate":null,"requiredLetters":"ACSZ","uppercaseLetters":"CS","fields":[{"field":"recipient","token":"%N","label":"recipient name","required":false,"uppercase":false},{"field":"organization","token":"%O","label":"organization","required":false,"uppercase":false}],"postalCodeLabel":"zip","hasPostalCodePattern":true,"postalCodeExample":"95014","languages":"en","postalAuthorityUrl":"https://tools.usps.com/go/ZipLookupAction!input.action","snapshotDate":"2026-10-21","dataSource":"https://github.com/google/libaddressinput","attribution":"Google libaddressinput / i18n address data","degraded":false,"notChecked":["that the address, street or postal code actually exists or is deliverable","the postal authority's current rules (the snapshot is dated and can be out of date)","…1 more"],"source":"Google libaddressinput i18n address data (chromium-i18n.appspot.com), bundled snapshot","asOf":"2026-10-21T05:49:02.901Z","disclaimer":"Screening signal computed from the named public source. Not financial, legal or investment advice; provided as is. Verify at the source before acting."}}}},"400":{"description":"A parameter was missing or out of range."},"402":{"description":"Payment Required"},"502":{"description":"The upstream source failed or timed out."}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.0200"},"protocols":[{"x402":{"network":"eip155:8453","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/address-format"}},{"x402":{"network":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/address-format"}},{"x402":{"network":"eip155:137","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/address-format"}},{"x402":{"network":"eip155:42161","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/address-format"}}]}}},"/address-parse-hints":{"get":{"operationId":"address_parse_hints","summary":"Guess which country a postal code belongs to from its shape among candidates, flagging ambiguity honestly.","description":"Guess which country a postal code belongs to from its shape among candidates, flagging ambiguity honestly.","tags":["address","postal-code","parsing","country-guess"],"parameters":[{"name":"postal_code","in":"query","required":true,"description":"The postal code to classify","schema":{"type":"string"}},{"name":"candidates","in":"query","required":false,"description":"Comma-separated ISO country codes to test (default: all)","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer.","content":{"application/json":{"schema":{"type":"object","properties":{"verdict":{"type":["null","string"]},"summary":{"type":["null","string"]},"reasons":{"type":["array","null"],"items":{"type":"string"}},"postalCode":{"type":["null","string"]},"shape":{"type":["null","string"]},"testedCountries":{"type":["null","number"]},"matchCount":{"type":["null","number"]},"ambiguous":{"type":["boolean","null"]},"matches":{"type":["array","null"],"items":{"type":"object","properties":{"country":{"type":["null","string"]},"name":{"type":["null","string"]}}}},"matchesTruncated":{"type":["boolean","null"]},"testedWithoutPattern":{"type":["null","number"]},"snapshotDate":{"type":["null","string"]},"dataSource":{"type":["null","string"]},"attribution":{"type":["null","string"]},"degraded":{"type":["boolean","null"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"asOf":{"type":["null","string"]},"disclaimer":{"type":["null","string"]}}},"example":{"verdict":"AMBIGUOUS","summary":"\"94043\" fits 4 countries' patterns (US, DE, FR, MX): ambiguous.","reasons":["Many countries use 4, 5 or 6 digit codes; a shape match is a hint, not an identification."],"postalCode":"94043","shape":"99999","testedCountries":4,"matchCount":4,"ambiguous":true,"matches":[{"country":"US","name":"UNITED STATES"},{"country":"DE","name":"GERMANY"}],"matchesTruncated":false,"testedWithoutPattern":0,"snapshotDate":"2026-10-21","dataSource":"https://github.com/google/libaddressinput","attribution":"Google libaddressinput / i18n address data","degraded":false,"notChecked":["that the address, street or postal code actually exists or is deliverable","the postal authority's current rules (the snapshot is dated and can be out of date)","…2 more"],"source":"Google libaddressinput i18n address data (chromium-i18n.appspot.com), bundled snapshot","asOf":"2026-10-21T05:49:03.154Z","disclaimer":"Screening signal computed from the named public source. Not financial, legal or investment advice; provided as is. Verify at the source before acting."}}}},"400":{"description":"A parameter was missing or out of range."},"402":{"description":"Payment Required"},"502":{"description":"The upstream source failed or timed out."}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.0200"},"protocols":[{"x402":{"network":"eip155:8453","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/address-parse-hints"}},{"x402":{"network":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/address-parse-hints"}},{"x402":{"network":"eip155:137","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/address-parse-hints"}},{"x402":{"network":"eip155:42161","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/address-parse-hints"}}]}}},"/country-address-fields":{"get":{"operationId":"country_address_fields","summary":"Which address fields a country uses and their local labels: state/province/county, city, district, postal code.","description":"Which address fields a country uses and their local labels: state/province/county, city, district, postal code.","tags":["address","fields","labels","i18n"],"parameters":[{"name":"country","in":"query","required":true,"description":"ISO 3166-1 alpha-2 code, e.g. IE","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer.","content":{"application/json":{"schema":{"type":"object","properties":{"verdict":{"type":["null","string"]},"summary":{"type":["null","string"]},"reasons":{"type":["array","null"],"items":{"type":"string"}},"country":{"type":["null","string"]},"countryName":{"type":["null","string"]},"fields":{"type":["array","null"],"items":{"type":"object","properties":{"field":{"type":["null","string"]},"token":{"type":["null","string"]},"label":{"type":["null","string"]},"required":{"type":["boolean","null"]},"uppercase":{"type":["boolean","null"]}}}},"hasStateField":{"type":["boolean","null"]},"stateFieldLabel":{"type":["null","string"]},"hasCityField":{"type":["boolean","null"]},"cityFieldLabel":{"type":["null","string"]},"hasDistrictField":{"type":["boolean","null"]},"districtFieldLabel":{"type":["null","string"]},"hasPostalCodeField":{"type":["boolean","null"]},"postalCodeFieldLabel":{"type":["null","string"]},"hasSortingCode":{"type":["boolean","null"]},"subdivisionsListed":{"type":["null","number"]},"snapshotDate":{"type":["null","string"]},"dataSource":{"type":["null","string"]},"attribution":{"type":["null","string"]},"degraded":{"type":["boolean","null"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"asOf":{"type":["null","string"]},"disclaimer":{"type":["null","string"]}}},"example":{"verdict":"FOUND","summary":"IRELAND uses: recipient name, organization, street address, townland, city, county, Eircode.","reasons":["Labels come from the data's name-type hints (for example IE calls the state field a county, GB has no state field)."],"country":"IE","countryName":"IRELAND","fields":[{"field":"recipient","token":"%N","label":"recipient name","required":false,"uppercase":false},{"field":"organization","token":"%O","label":"organization","required":false,"uppercase":false}],"hasStateField":true,"stateFieldLabel":"county","hasCityField":true,"cityFieldLabel":"city","hasDistrictField":true,"districtFieldLabel":"townland","hasPostalCodeField":true,"postalCodeFieldLabel":"Eircode","hasSortingCode":false,"subdivisionsListed":26,"snapshotDate":"2026-10-21","dataSource":"https://github.com/google/libaddressinput","attribution":"Google libaddressinput / i18n address data","degraded":false,"notChecked":["that the address, street or postal code actually exists or is deliverable","the postal authority's current rules (the snapshot is dated and can be out of date)","…1 more"],"source":"Google libaddressinput i18n address data (chromium-i18n.appspot.com), bundled snapshot","asOf":"2026-10-21T05:49:03.419Z","disclaimer":"Screening signal computed from the named public source. Not financial, legal or investment advice; provided as is. Verify at the source before acting."}}}},"400":{"description":"A parameter was missing or out of range."},"402":{"description":"Payment Required"},"502":{"description":"The upstream source failed or timed out."}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.0200"},"protocols":[{"x402":{"network":"eip155:8453","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/country-address-fields"}},{"x402":{"network":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/country-address-fields"}},{"x402":{"network":"eip155:137","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/country-address-fields"}},{"x402":{"network":"eip155:42161","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/country-address-fields"}}]}}},"/format-address":{"get":{"operationId":"format_address","summary":"Render address parts into a country's standard multi-line mailing format with its uppercase rules; reports missing fields.","description":"Render address parts into a country's standard multi-line mailing format with its uppercase rules; reports missing fields.","tags":["address","format","mailing","i18n"],"parameters":[{"name":"country","in":"query","required":true,"description":"ISO 3166-1 alpha-2 code, e.g. GB","schema":{"type":"string"}},{"name":"street","in":"query","required":true,"description":"Street line(s); separate several lines with |","schema":{"type":"string"}},{"name":"city","in":"query","required":false,"description":"City or locality","schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"State/province code or name","schema":{"type":"string"}},{"name":"postal_code","in":"query","required":false,"description":"Postal code","schema":{"type":"string"}},{"name":"recipient","in":"query","required":false,"description":"Recipient name","schema":{"type":"string"}},{"name":"organization","in":"query","required":false,"description":"Company or organization","schema":{"type":"string"}},{"name":"dependent_locality","in":"query","required":false,"description":"District/suburb where used","schema":{"type":"string"}},{"name":"sorting_code","in":"query","required":false,"description":"CEDEX or similar sorting code","schema":{"type":"string"}},{"name":"latin","in":"query","required":false,"description":"Use the Latin-script layout where the country has one","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The answer.","content":{"application/json":{"schema":{"type":"object","properties":{"verdict":{"type":["null","string"]},"summary":{"type":["null","string"]},"reasons":{"type":["array","null"]},"country":{"type":["null","string"]},"lines":{"type":["array","null"],"items":{"type":"string"}},"formatted":{"type":["null","string"]},"formattedWithCountry":{"type":["null","string"]},"missingRequired":{"type":["array","null"]},"postalCodeFormatValid":{"type":["boolean","null"]},"usedLatinLayout":{"type":["boolean","null"]},"snapshotDate":{"type":["null","string"]},"dataSource":{"type":["null","string"]},"attribution":{"type":["null","string"]},"degraded":{"type":["boolean","null"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"asOf":{"type":["null","string"]},"disclaimer":{"type":["null","string"]}}},"example":{"verdict":"FORMATTED","summary":"Formatted for UNITED KINGDOM (4 lines).","reasons":[],"country":"GB","lines":["Jane Doe","10 Downing Street","…2 more"],"formatted":"Jane Doe\n10 Downing Street\nLONDON\nSW1A 2AA","formattedWithCountry":"Jane Doe\n10 Downing Street\nLONDON\nSW1A 2AA\nUNITED KINGDOM","missingRequired":[],"postalCodeFormatValid":true,"usedLatinLayout":false,"snapshotDate":"2026-10-21","dataSource":"https://github.com/google/libaddressinput","attribution":"Google libaddressinput / i18n address data","degraded":false,"notChecked":["that the address, street or postal code actually exists or is deliverable","the postal authority's current rules (the snapshot is dated and can be out of date)","…2 more"],"source":"Google libaddressinput i18n address data (chromium-i18n.appspot.com), bundled snapshot","asOf":"2026-10-21T05:49:03.684Z","disclaimer":"Screening signal computed from the named public source. Not financial, legal or investment advice; provided as is. Verify at the source before acting."}}}},"400":{"description":"A parameter was missing or out of range."},"402":{"description":"Payment Required"},"502":{"description":"The upstream source failed or timed out."}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.0200"},"protocols":[{"x402":{"network":"eip155:8453","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/format-address"}},{"x402":{"network":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/format-address"}},{"x402":{"network":"eip155:137","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/format-address"}},{"x402":{"network":"eip155:42161","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/format-address"}}]}}},"/po-box-check":{"get":{"operationId":"po_box_check","summary":"Heuristic check whether an address line uses PO box wording in English, German, French, Spanish and more; not proof.","description":"Heuristic check whether an address line uses PO box wording in English, German, French, Spanish and more; not proof.","tags":["address","po-box","heuristic","i18n"],"parameters":[{"name":"text","in":"query","required":true,"description":"An address line, e.g. 'P.O. Box 123'","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer.","content":{"application/json":{"schema":{"type":"object","properties":{"verdict":{"type":["null","string"]},"summary":{"type":["null","string"]},"reasons":{"type":["array","null"],"items":{"type":"string"}},"input":{"type":["null","string"]},"matches":{"type":["array","null"],"items":{"type":"object","properties":{"language":{"type":["null","string"]},"pattern":{"type":["null","string"]},"matchedText":{"type":["null","string"]},"weak":{"type":["boolean","null"]}}}},"languagesCovered":{"type":["array","null"],"items":{"type":"string"}},"dataSnapshot":{"type":["null","string"]},"degraded":{"type":["boolean","null"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"asOf":{"type":["null","string"]},"disclaimer":{"type":["null","string"]}}},"example":{"verdict":"PO_BOX_WORDING_FOUND","summary":"Found PO box wording (PO Box, en).","reasons":["Heuristic: absence of a match does NOT mean the address is a street address, and a match is not proof of a PO box.","Covers English, German, French, Spanish, Portuguese, Italian, Dutch, Scandinavian, Finnish, Polish, Turkish, Russian, Arabic, Chinese, Japanese, Korean, Indonesian wording."],"input":"P.O. Box 1234","matches":[{"language":"en","pattern":"PO Box","matchedText":"PO Box","weak":false},{"language":"en","pattern":"Box number (weak)","matchedText":"Box 1234","weak":true}],"languagesCovered":["en","de","…16 more"],"dataSnapshot":"2026-10-21","degraded":false,"notChecked":["languages and spellings not on the built-in list","street names that merely contain the words (for example a road called Box Lane)","…1 more"],"source":"pattern list written for this shelf (not from the address dataset)","asOf":"2026-10-21T05:49:03.948Z","disclaimer":"Screening signal computed from the named public source. Not financial, legal or investment advice; provided as is. Verify at the source before acting."}}}},"400":{"description":"A parameter was missing or out of range."},"402":{"description":"Payment Required"},"502":{"description":"The upstream source failed or timed out."}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.0200"},"protocols":[{"x402":{"network":"eip155:8453","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/po-box-check"}},{"x402":{"network":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/po-box-check"}},{"x402":{"network":"eip155:137","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/po-box-check"}},{"x402":{"network":"eip155:42161","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/po-box-check"}}]}}},"/postal-code-check":{"get":{"operationId":"postal_code_check","summary":"Check a postal code against a country's pattern, and a state/province's prefix pattern where the data lists one.","description":"Check a postal code against a country's pattern, and a state/province's prefix pattern where the data lists one.","tags":["address","postal-code","validation","zip"],"parameters":[{"name":"country","in":"query","required":true,"description":"ISO 3166-1 alpha-2 code, e.g. US","schema":{"type":"string"}},{"name":"postal_code","in":"query","required":true,"description":"The postal or ZIP code to check","schema":{"type":"string"}},{"name":"subdivision","in":"query","required":false,"description":"Optional state/province code or name, e.g. CA","schema":{"type":"string"}}],"responses":{"200":{"description":"The answer.","content":{"application/json":{"schema":{"type":"object","properties":{"verdict":{"type":["null","string"]},"summary":{"type":["null","string"]},"reasons":{"type":["array","null"],"items":{"type":"string"}},"country":{"type":["null","string"]},"postalCodeInput":{"type":["null","string"]},"normalized":{"type":["null","string"]},"postalCodeLabel":{"type":["null","string"]},"pattern":{"type":["null","string"]},"examples":{"type":["array","null"],"items":{"type":"string"}},"snapshotDate":{"type":["null","string"]},"dataSource":{"type":["null","string"]},"attribution":{"type":["null","string"]},"formatValid":{"type":["boolean","null"]},"subdivisionsWhosePrefixMatches":{"type":["array","null"],"items":{"type":"object","properties":{"code":{"type":["null","string"]},"name":{"type":["null","string"]}}}},"subdivisionCheck":{"type":["null","object"],"properties":{"requested":{"type":["null","string"]},"matched":{"type":["null","string"]},"name":{"type":["null","string"]},"prefixPattern":{"type":["null","string"]},"prefixMatches":{"type":["boolean","null"]},"result":{"type":["null","string"]}}},"degraded":{"type":["boolean","null"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"asOf":{"type":["null","string"]},"disclaimer":{"type":["null","string"]}}},"example":{"verdict":"VALID_FORMAT","summary":"UNITED STATES: \"94043\" has a valid ZIP code format.","reasons":["The code matches the country's pattern. That is a shape check only."],"country":"US","postalCodeInput":"94043","normalized":"94043","postalCodeLabel":"ZIP code","pattern":"(\\d{5})(?:[ \\-](\\d{4}))?","examples":["95014","22162-1010"],"snapshotDate":"2026-10-21","dataSource":"https://github.com/google/libaddressinput","attribution":"Google libaddressinput / i18n address data","formatValid":true,"subdivisionsWhosePrefixMatches":[{"code":"CA","name":"California"}],"subdivisionCheck":{"requested":"CA","matched":"CA","name":"California","prefixPattern":"9[0-5]|96[01]","prefixMatches":true,"result":"code starts like this subdivision's codes"},"degraded":false,"notChecked":["that the address, street or postal code actually exists or is deliverable","the postal authority's current rules (the snapshot is dated and can be out of date)","…2 more"],"source":"Google libaddressinput i18n address data (chromium-i18n.appspot.com), bundled snapshot","asOf":"2026-10-21T05:49:04.215Z","disclaimer":"Screening signal computed from the named public source. Not financial, legal or investment advice; provided as is. Verify at the source before acting."}}}},"400":{"description":"A parameter was missing or out of range."},"402":{"description":"Payment Required"},"502":{"description":"The upstream source failed or timed out."}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.0200"},"protocols":[{"x402":{"network":"eip155:8453","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/postal-code-check"}},{"x402":{"network":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/postal-code-check"}},{"x402":{"network":"eip155:137","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/postal-code-check"}},{"x402":{"network":"eip155:42161","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/postal-code-check"}}]}}},"/postal-code-examples":{"get":{"operationId":"postal_code_examples","summary":"Sample postal codes for a country from the dataset's examples, each checked against the country's own pattern.","description":"Sample postal codes for a country from the dataset's examples, each checked against the country's own pattern.","tags":["address","postal-code","examples","test-data"],"parameters":[{"name":"country","in":"query","required":true,"description":"ISO 3166-1 alpha-2 code, e.g. NL","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum examples to return (1-50, default 10)","schema":{"type":"integer"}}],"responses":{"200":{"description":"The answer.","content":{"application/json":{"schema":{"type":"object","properties":{"verdict":{"type":["null","string"]},"summary":{"type":["null","string"]},"reasons":{"type":["array","null"],"items":{"type":"string"}},"country":{"type":["null","string"]},"postalCodeLabel":{"type":["null","string"]},"pattern":{"type":["null","string"]},"total":{"type":["null","number"]},"examples":{"type":["array","null"],"items":{"type":"object","properties":{"code":{"type":["null","string"]},"matchesCountryPattern":{"type":["boolean","null"]}}}},"snapshotDate":{"type":["null","string"]},"dataSource":{"type":["null","string"]},"attribution":{"type":["null","string"]},"degraded":{"type":["boolean","null"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"asOf":{"type":["null","string"]},"disclaimer":{"type":["null","string"]}}},"example":{"verdict":"FOUND","summary":"2 example postal codes for NETHERLANDS, e.g. 1234 AB.","reasons":["Examples are illustrative values from the dataset, not guaranteed to be assigned."],"country":"NL","postalCodeLabel":"postal code","pattern":"[1-9]\\d{3} ?(?:[A-RT-Z][A-Z]|S[BCE-RT-Z])","total":2,"examples":[{"code":"1234 AB","matchesCountryPattern":true},{"code":"2490 AA","matchesCountryPattern":true}],"snapshotDate":"2026-10-21","dataSource":"https://github.com/google/libaddressinput","attribution":"Google libaddressinput / i18n address data","degraded":false,"notChecked":["that the address, street or postal code actually exists or is deliverable","the postal authority's current rules (the snapshot is dated and can be out of date)","…2 more"],"source":"Google libaddressinput i18n address data (chromium-i18n.appspot.com), bundled snapshot","asOf":"2026-10-21T05:49:04.479Z","disclaimer":"Screening signal computed from the named public source. Not financial, legal or investment advice; provided as is. Verify at the source before acting."}}}},"400":{"description":"A parameter was missing or out of range."},"402":{"description":"Payment Required"},"502":{"description":"The upstream source failed or timed out."}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.0200"},"protocols":[{"x402":{"network":"eip155:8453","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/postal-code-examples"}},{"x402":{"network":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/postal-code-examples"}},{"x402":{"network":"eip155:137","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/postal-code-examples"}},{"x402":{"network":"eip155:42161","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/postal-code-examples"}}]}}},"/subdivisions":{"get":{"operationId":"subdivisions","summary":"Administrative divisions (states, provinces) of a country with codes, names and postal prefix patterns, from the dataset.","description":"Administrative divisions (states, provinces) of a country with codes, names and postal prefix patterns, from the dataset.","tags":["address","subdivisions","states","provinces"],"parameters":[{"name":"country","in":"query","required":true,"description":"ISO 3166-1 alpha-2 code, e.g. CA","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"Optional filter on code or name","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum rows (1-300, default 100)","schema":{"type":"integer"}}],"responses":{"200":{"description":"The answer.","content":{"application/json":{"schema":{"type":"object","properties":{"verdict":{"type":["null","string"]},"summary":{"type":["null","string"]},"reasons":{"type":["array","null"]},"country":{"type":["null","string"]},"subdivisionLabel":{"type":["null","string"]},"total":{"type":["null","number"]},"returned":{"type":["null","number"]},"subdivisions":{"type":["array","null"],"items":{"type":"object","properties":{"code":{"type":["null","string"]},"name":{"type":["null","string"]},"latinName":{},"postalPrefixPattern":{"type":["null","string"]}}}},"snapshotDate":{"type":["null","string"]},"dataSource":{"type":["null","string"]},"attribution":{"type":["null","string"]},"degraded":{"type":["boolean","null"]},"notChecked":{"type":["array","null"],"items":{"type":"string"}},"source":{"type":["null","string"]},"asOf":{"type":["null","string"]},"disclaimer":{"type":["null","string"]}}},"example":{"verdict":"FOUND","summary":"CANADA: 13 province entries.","reasons":[],"country":"CA","subdivisionLabel":"province","total":13,"returned":13,"subdivisions":[{"code":"AB","name":"Alberta","latinName":null,"postalPrefixPattern":"T"},{"code":"BC","name":"British Columbia","latinName":null,"postalPrefixPattern":"V"}],"snapshotDate":"2026-10-21","dataSource":"https://github.com/google/libaddressinput","attribution":"Google libaddressinput / i18n address data","degraded":false,"notChecked":["that the address, street or postal code actually exists or is deliverable","the postal authority's current rules (the snapshot is dated and can be out of date)","…3 more"],"source":"Google libaddressinput i18n address data (chromium-i18n.appspot.com), bundled snapshot","asOf":"2026-10-21T05:49:04.741Z","disclaimer":"Screening signal computed from the named public source. Not financial, legal or investment advice; provided as is. Verify at the source before acting."}}}},"400":{"description":"A parameter was missing or out of range."},"402":{"description":"Payment Required"},"502":{"description":"The upstream source failed or timed out."}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.0200"},"protocols":[{"x402":{"network":"eip155:8453","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/subdivisions"}},{"x402":{"network":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/subdivisions"}},{"x402":{"network":"eip155:137","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/subdivisions"}},{"x402":{"network":"eip155:42161","scheme":"exact","currency":"USDC","endpoint":"https://address-formats.x402tookit.com/subdivisions"}}]}}}}}