{"id":4369,"date":"2026-11-12T19:25:44","date_gmt":"2026-11-12T19:25:44","guid":{"rendered":"https:\/\/developers.maplink.global\/?p=4369"},"modified":"2026-11-12T19:56:57","modified_gmt":"2026-11-12T19:56:57","slug":"parameter-list","status":"publish","type":"post","link":"https:\/\/developers.maplink.global\/en\/parameter-list\/","title":{"rendered":"Parameter list"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\"><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Address input formats<\/li>\n\n\n\n<li>Required parameters<\/li>\n\n\n\n<li>Optional parameters<\/li>\n\n\n\n<li>Request examples<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">Address input formats<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">The address can be sent in two ways:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Label<\/strong> \u2013 A single text with the address components separated by commas, in the order <code>road<\/code>, <code>number<\/code>, <code>district<\/code>, <code>zipcode<\/code>, <code>city<\/code>, <code>state<\/code>;<\/li>\n\n\n\n<li><strong>Structured<\/strong> \u2013 Each address component sent in a separate parameter.<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Both formats can be sent in the same request. In that case, the structured parameters take precedence and the <code>label<\/code> is ignored:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><th>Parameters in the body<\/th><th>Format used<\/th><\/tr><tr><td><code>label<\/code> only<\/td><td>Label<\/td><\/tr><tr><td>Structured parameters, without <code>label<\/code><\/td><td>Structured<\/td><\/tr><tr><td><code>label<\/code> + structured parameters<\/td><td>Structured (the <code>label<\/code> is ignored)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Required parameters<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">The required parameters depend on the address input format.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Structured format<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>road<\/code> \u2013 Text with the street name. It may contain the number and the complement, which are split in the response. Limit of 150 characters;<\/li>\n\n\n\n<li><code>zipcode<\/code> \u2013 Text with the address ZIP code (CEP). Accepts the ZIP code with or without a hyphen (example: <code>01310-200<\/code> or <code>01310200<\/code>). After the hyphen is removed, it must contain exactly 8 digits;<\/li>\n\n\n\n<li><code>city<\/code> \u2013 Text with the city name.<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Label format<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>label<\/code> \u2013 Text with the full address, with the components separated by commas in the order <code>road, number, district, zipcode, city, state<\/code>. The street, ZIP code and city must be filled in the <code>label<\/code>.\n<ul class=\"wp-block-list\">\n<li>All five separating commas must be present, even when a component is empty. Example: <code>\"av paulista,1578,,01310200,sao paulo,\"<\/code>;<\/li>\n\n\n\n<li>If any comma is missing, the error <code>Structure error on label field<\/code> is returned. This validation runs before the ZIP code format validation.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p class=\"wp-block-paragraph\"><strong>Note:<\/strong> requests without <code>road<\/code>, <code>zipcode <\/code>or <code>city<\/code> are rejected with a 400 error.<\/p>\n<\/blockquote>\n\n\n\n<h3 class=\"wp-block-heading\">Optional parameters<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>number<\/code> \u2013 Text with the building number. It may be sent empty or contain a complement after the number (example: <code>\"654 bloco 3\"<\/code>); in that case, the text after the number is returned in <code>complement<\/code>. If not sent, the number is identified in <code>road<\/code>;<\/li>\n\n\n\n<li><code>district<\/code> \u2013 Text with the district (neighborhood) name;<\/li>\n\n\n\n<li><code>state<\/code> \u2013 Text with the state abbreviation (UF).<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">Request examples<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Example with the label format<\/strong><\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">{\n  \"label\": \"r da cantarera 306 box 12,,centro,01024-000,sao paulo,SP\"\n}<\/pre>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Example with the structured format<\/strong><\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">{\n  \"road\": \"r da cantarera 306 box 12\",\n  \"number\": \"\",\n  \"zipcode\": \"01024-000\",\n  \"district\": \"centro\",\n  \"city\": \"sao paulo\",\n  \"state\": \"SP\"\n}<\/pre>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Example with label and structured parameters<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">In this case, only the structured parameters are used:<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">{\n  \"label\": \"r da cantarera 306 box 12,,centro,01024-000,sao paulo,SP\",\n  \"road\": \"r da cantarera 306 box 12\",\n  \"number\": \"\",\n  \"zipcode\": \"01024-000\",\n  \"district\": \"centro\",\n  \"city\": \"sao paulo\",\n  \"state\": \"SP\"\n}<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Address input formats The address can be sent in two ways: Both formats can be sent in the same request. In that case, the structured parameters take precedence and the label is ignored: Parameters in the body Format used label only Label Structured parameters, without label Structured label + structured parameters Structured (the label is [&hellip;]<\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[175,33],"tags":[],"class_list":["post-4369","post","type-post","status-publish","format-standard","hentry","category-address-analyzer-en","category-uncategorized"],"acf":[],"_links":{"self":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/4369","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/comments?post=4369"}],"version-history":[{"count":5,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/4369\/revisions"}],"predecessor-version":[{"id":4436,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/4369\/revisions\/4436"}],"wp:attachment":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/media?parent=4369"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/categories?post=4369"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/tags?post=4369"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}