{"id":3452,"date":"2023-12-22T18:27:00","date_gmt":"2023-12-22T18:27:00","guid":{"rendered":"https:\/\/developers.maplink.global\/?p=3452"},"modified":"2025-08-01T12:37:21","modified_gmt":"2025-08-01T12:37:21","slug":"response-structure-geocode-api","status":"publish","type":"post","link":"https:\/\/developers.maplink.global\/en\/response-structure-geocode-api\/","title":{"rendered":"Response Structure \u2013 Geocode API"},"content":{"rendered":"\n<p>For all endpoints,\u00a0<a href=\"https:\/\/developers.maplink.global\/en\/geocode-api\/\" data-type=\"post\" data-id=\"3137\">Geocode<\/a>,\u00a0<a href=\"https:\/\/developers.maplink.global\/en\/suggestions-api\/\" data-type=\"post\" data-id=\"3158\">Suggestions<\/a>,\u00a0<a href=\"https:\/\/developers.maplink.global\/en\/reverse-geocode-api\/\" data-type=\"post\" data-id=\"3151\">Reverse<\/a> and\u00a0<a href=\"https:\/\/developers.maplink.global\/en\/multi-geocode-api\/\" data-type=\"post\" data-id=\"2784\">Multi Geocode<\/a>, the response format will follow the structure below:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>found<\/code>&nbsp;\u2013 Number of records returned.<\/li>\n\n\n\n<li><code>results<\/code>&nbsp;\u2013 Array of objects with all the results found:\n<ul class=\"wp-block-list\">\n<li><code>id<\/code>&nbsp;\u2013 Identifier of the address entered in the request;<\/li>\n\n\n\n<li><code>address<\/code>&nbsp;\u2013 Object with address information:\n<ul class=\"wp-block-list\">\n<li><code>road<\/code>&nbsp;\u2013 Name of the road;<\/li>\n\n\n\n<li><code>number<\/code>&nbsp;\u2013 Address number in string format;<\/li>\n\n\n\n<li><code>district<\/code>&nbsp;\u2013 District;<\/li>\n\n\n\n<li><code>zipCode<\/code>&nbsp;\u2013 Zipcode;<\/li>\n\n\n\n<li><code>city<\/code>&nbsp;\u2013 City;<\/li>\n\n\n\n<li><code>state<\/code>&nbsp;\u2013 Object with state data:\n<ul class=\"wp-block-list\">\n<li><code>name<\/code>&nbsp;\u2013 State name;<\/li>\n\n\n\n<li><code>code<\/code>&nbsp;\u2013 State acronym;<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><code>mainLocation<\/code>&nbsp;\u2013 Object with the geographic coordinates of the point:\n<ul class=\"wp-block-list\">\n<li><code>lat<\/code>&nbsp;\u2013 Latitude;<\/li>\n\n\n\n<li><code>lon<\/code>&nbsp;\u2013 Longitude;<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><code>numberAsInteger<\/code>&nbsp;\u2013 Address number, but returned as an integer instead of a string;<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><code>type<\/code>&nbsp;\u2013 &nbsp;Indicates the type of data returned. Possible values are:&nbsp;<code>ROAD<\/code>,&nbsp;<code>CITY<\/code>&nbsp;and&nbsp;<code>STATE<\/code>;<\/li>\n\n\n\n<li><code>precision<\/code>&nbsp;\u2013 Indicates the confidence level of the returned data. Possible values are:\n<ul class=\"wp-block-list\">\n<li><code>NUMBER_EXACT<\/code>&nbsp;\u2013 Indicates that the returned coordinates refer to the exact point that was requested;<\/li>\n\n\n\n<li><code>NUMBER_HIGH_PRECISION<\/code>&nbsp;\u2013 Indicates that the returned coordinates refer to the requested point, but we do not have the exact location and the coordinates were interpolated, with a possible distance margin of up to 20 meters;<\/li>\n\n\n\n<li><code>NUMBER_MEDIUM_PRECISION<\/code>&nbsp;\u2013 Indicates that the returned coordinates refer to the requested point, but we do not have the exact location and the coordinates were interpolated, with a possible distance margin of up to 100 meters;<\/li>\n\n\n\n<li><code>NUMBER_LOW_PRECISION<\/code>&nbsp;\u2013 Indicates that the returned coordinates refer to the requested point, but we do not have the exact location and the coordinates were interpolated, with a possible margin of distance of up to 1000 meters;<\/li>\n\n\n\n<li><code>ROAD_CENTROID<\/code>&nbsp;\u2013 Indicates that the returned coordinates refer to the centroid of the requested street;<\/li>\n\n\n\n<li><code>CITY_CENTROID<\/code>&nbsp;\u2013 Indicates that the returned coordinates refer to the centroid of the city;<\/li>\n\n\n\n<li><code>STATE_CENTROID<\/code>&nbsp;\u2013 Indicates that the returned coordinates refer to the centroid of the state.<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><code>score<\/code>&nbsp;\u2013 Numerical score representing the degree of textual correspondence between the address provided in the request and the address returned by the geocoding process;<\/li>\n\n\n\n<li><code>label<\/code>&nbsp;\u2013 Complete address found used in the geocoding process.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p>Response example:<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"json\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">{\n    \"results\": [\n        {\n            \"id\": \"6684353bf0662a1541ff635d\",\n            \"address\": {\n                \"road\": \"ALAMEDA CAMPINAS\",\n                \"number\": \"579\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01404000\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.566287789653508,\n                    \"lon\": -46.6537028592172\n                },\n                \"numberAsInteger\": 579\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA CAMPINAS, 01404000, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 98.81773828023887,\n            \"precision\": \"NUMBER_MEDIUM_PRECISION\"\n        },\n        {\n            \"id\": \"6684353bf0662a1541ff637b\",\n            \"address\": {\n                \"road\": \"ALAMEDA CAMPINAS\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01404001\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.56880844109,\n                    \"lon\": -46.65604091167\n                }\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA CAMPINAS, 01404001, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 92.9419580012093,\n            \"precision\": \"ROAD_CENTROID\"\n        },\n        {\n            \"id\": \"6684353bf0662a1541ff637c\",\n            \"address\": {\n                \"road\": \"ALAMEDA CAMPINAS\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01404003\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.5727482959,\n                    \"lon\": -46.65984093151\n                }\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA CAMPINAS, 01404003, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 92.9419580012093,\n            \"precision\": \"ROAD_CENTROID\"\n        },\n        {\n            \"id\": \"6684353bf0662a1541ff63b9\",\n            \"address\": {\n                \"road\": \"ALAMEDA CAMPINAS\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01404002\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.57150846699,\n                    \"lon\": -46.65863824537\n                }\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA CAMPINAS, 01404002, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 92.9419580012093,\n            \"precision\": \"ROAD_CENTROID\"\n        },\n        {\n            \"id\": \"6684353bf0662a1541ff6385\",\n            \"address\": {\n                \"road\": \"ALAMEDA CAMPINAS\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01404100\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.56631144908,\n                    \"lon\": -46.65360036597\n                }\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA CAMPINAS, 01404100, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 92.78814049548771,\n            \"precision\": \"ROAD_CENTROID\"\n        },\n        {\n            \"id\": \"6684353bf0662a1541ff63a2\",\n            \"address\": {\n                \"road\": \"ALAMEDA CAMPINAS\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01404200\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.56714829171,\n                    \"lon\": -46.65440337412\n                }\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA CAMPINAS, 01404200, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 92.78814049548771,\n            \"precision\": \"ROAD_CENTROID\"\n        },\n        {\n            \"id\": \"6684353bf0662a1541ff63a3\",\n            \"address\": {\n                \"road\": \"ALAMEDA CAMPINAS 150\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01404900\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.56343039334,\n                    \"lon\": -46.6507807755\n                }\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA CAMPINAS 150, 01404900, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 91.48049238291864,\n            \"precision\": \"ROAD_CENTROID\"\n        },\n        {\n            \"id\": \"6684344df0662a1541f5baee\",\n            \"address\": {\n                \"road\": \"RUA HAITI\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01404010\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.571433,\n                    \"lon\": -46.6607828\n                }\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"RUA HAITI, 01404010, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 84.24055564325018,\n            \"precision\": \"ROAD_CENTROID\"\n        },\n        {\n            \"id\": \"6684342ef0662a1541f41a70\",\n            \"address\": {\n                \"road\": \"ALAMEDA LORENA\",\n                \"number\": \"579\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01424000\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.56994038386821,\n                    \"lon\": -46.65933806789288\n                },\n                \"numberAsInteger\": 579\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA LORENA, 01424000, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 84.15016434701576,\n            \"precision\": \"NUMBER_MEDIUM_PRECISION\"\n        },\n        {\n            \"id\": \"66843453f0662a1541f60988\",\n            \"address\": {\n                \"road\": \"ALAMEDA CASA BRANCA\",\n                \"number\": \"579\",\n                \"district\": \"JARDIM PAULISTA\",\n                \"zipCode\": \"01408000\",\n                \"city\": \"S\u00c3O PAULO\",\n                \"state\": {\n                    \"name\": \"S\u00c3O PAULO\",\n                    \"code\": \"SP\"\n                },\n                \"mainLocation\": {\n                    \"lat\": -23.565856915927288,\n                    \"lon\": -46.659742464053295\n                },\n                \"numberAsInteger\": 579\n            },\n            \"type\": \"ROAD\",\n            \"label\": \"ALAMEDA CASA BRANCA, 01408000, JARDIM PAULISTA, S\u00c3O PAULO, SP\",\n            \"score\": 84.01280084636662,\n            \"precision\": \"NUMBER_MEDIUM_PRECISION\"\n        }\n    ],\n    \"found\": 10\n}<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>For all endpoints,\u00a0Geocode,\u00a0Suggestions,\u00a0Reverse and\u00a0Multi Geocode, the response format will follow the structure below: Response example:<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[168],"tags":[],"class_list":["post-3452","post","type-post","status-publish","format-standard","hentry","category-geocode-en"],"acf":[],"_links":{"self":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/3452","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\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/comments?post=3452"}],"version-history":[{"count":3,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/3452\/revisions"}],"predecessor-version":[{"id":3459,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/posts\/3452\/revisions\/3459"}],"wp:attachment":[{"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/media?parent=3452"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/categories?post=3452"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developers.maplink.global\/en\/wp-json\/wp\/v2\/tags?post=3452"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}