AddressFormat
# AddressFormat API Turn structured address fields into a perfectly formatted shipping label — for any of 35 countries, with the right local conventions baked in. Every country formats addresses differently. The Netherlands puts the postcode before the city. France requires the city in uppercase. The UK puts the postcode on its own line. Japan reverses the entire order and uses prefectures.…
AddressFormat endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST |
Format Address /v1/format |
Format a single address into a country-conformant shipping label. |
| POST |
Format Batch /v1/format/batch |
Format up to 1000 addresses in a single request. Each address is validated and formatted independently — errors on individual addresses don't fail the whole batch. |
| GET |
List Countries /v1/countries |
Get all 35 supported countries with their metadata: required fields, postcode regex, label format, and an example address. Use this to dynamically build country-specific checkout… |
| GET |
Get Country Metadata /v1/countries/{code} |
et metadata for a single country: required address fields, postcode regex for client-side validation, label format template, and an example address. |
| GET |
Health Check /health |
Returns API status and version. Useful for uptime monitoring. Does not count against your quota and does not require authentication. |
AddressFormat pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | 50 / minute |
|
| PRO | $9.99 / month | 500 / minute |
|
| ULTRA | $32.99 / month | 500 / minute |
|