Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url http://localhost:3000/v2/entities/{id}/address \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/entities/{id}/address"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/entities/{id}/address', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/entities/{id}/address",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/entities/{id}/address"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/entities/{id}/address")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/entities/{id}/address")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"sourceDataset": "<string>",
"evidence": [
{
"sourceDataset": "<string>",
"matchStatus": "match",
"matchedFields": [
"addressMain"
],
"divergentFields": [
"addressMain"
],
"observedAt": "<string>",
"fullAddress": "<string>",
"addressMain": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
}
],
"media": {
"images": [
{
"url": "<string>",
"name": "<string>",
"width": 123,
"height": 123,
"attributionName": "<string>",
"attributionUrl": "<string>"
}
],
"map": {
"imageDataUrl": "<string>",
"query": "<string>",
"externalUrl": "<string>"
},
"streetView": {
"images": [
{
"imageDataUrl": "<string>",
"panoId": "<string>",
"latitude": 123,
"longitude": 123,
"heading": 123,
"pitch": 123,
"fov": 123
}
],
"query": "<string>"
}
},
"relatedAddresses": [
{
"relationType": "google_maps",
"relevance": 50,
"sourceDataset": "<string>",
"sourceLabel": "<string>",
"fullAddress": "<string>",
"media": {
"images": [
{
"url": "<string>",
"name": "<string>",
"width": 123,
"height": 123,
"attributionName": "<string>",
"attributionUrl": "<string>"
}
],
"map": {
"imageDataUrl": "<string>",
"query": "<string>",
"externalUrl": "<string>"
},
"streetView": {
"images": [
{
"imageDataUrl": "<string>",
"panoId": "<string>",
"latitude": 123,
"longitude": 123,
"heading": 123,
"pitch": 123,
"fov": 123
}
],
"query": "<string>"
}
},
"entityName": "<string>",
"entityDocument": "<string>",
"typology": "<string>",
"addressMain": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"latitude": 123,
"longitude": 123,
"businessPresence": {
"status": "matched",
"confidence": 50,
"candidateCount": 1,
"reviews": [
{
"name": "<string>",
"authorName": "<string>",
"authorPhotoUrl": "<string>",
"rating": 123,
"text": "<string>",
"relativePublishTime": "<string>",
"publishTime": "<string>"
}
],
"candidates": [
{
"confidence": 50,
"nameStatus": "match",
"addressStatus": "match",
"sameOfficialStreetAndNumber": true,
"selected": true,
"placeId": "<string>",
"name": "<string>",
"address": "<string>",
"latitude": 123,
"longitude": 123,
"googleMapsUrl": "<string>",
"primaryTypeLabel": "<string>",
"businessStatus": "<string>",
"rating": 123,
"userRatingCount": 123,
"distanceMeters": 123
}
],
"comparisons": [
{
"field": "name",
"status": "match",
"officialValue": "<string>",
"publicValue": "<string>"
}
],
"signals": [
{
"code": "BUSINESS_IDENTITY_CONFIRMED",
"severity": "positive"
}
],
"placeId": "<string>",
"name": "<string>",
"address": "<string>",
"distanceMeters": 123,
"googleMapsUrl": "<string>",
"primaryType": "<string>",
"primaryTypeLabel": "<string>",
"businessStatus": "<string>",
"phone": "<string>",
"website": "<string>",
"rating": 123,
"userRatingCount": 123,
"openNow": true,
"pureServiceAreaBusiness": true
}
}
],
"label": "<string>",
"fullAddress": "<string>",
"typology": "<string>",
"addressMain": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"latitude": 123,
"longitude": 123,
"origin": "<string>",
"originDetail": "<string>",
"addressType": "<string>",
"isActive": true,
"isMain": true,
"businessPresence": {
"status": "matched",
"confidence": 50,
"candidateCount": 1,
"reviews": [
{
"name": "<string>",
"authorName": "<string>",
"authorPhotoUrl": "<string>",
"rating": 123,
"text": "<string>",
"relativePublishTime": "<string>",
"publishTime": "<string>"
}
],
"candidates": [
{
"confidence": 50,
"nameStatus": "match",
"addressStatus": "match",
"sameOfficialStreetAndNumber": true,
"selected": true,
"placeId": "<string>",
"name": "<string>",
"address": "<string>",
"latitude": 123,
"longitude": 123,
"googleMapsUrl": "<string>",
"primaryTypeLabel": "<string>",
"businessStatus": "<string>",
"rating": 123,
"userRatingCount": 123,
"distanceMeters": 123
}
],
"comparisons": [
{
"field": "name",
"status": "match",
"officialValue": "<string>",
"publicValue": "<string>"
}
],
"signals": [
{
"code": "BUSINESS_IDENTITY_CONFIRMED",
"severity": "positive"
}
],
"placeId": "<string>",
"name": "<string>",
"address": "<string>",
"distanceMeters": 123,
"googleMapsUrl": "<string>",
"primaryType": "<string>",
"primaryTypeLabel": "<string>",
"businessStatus": "<string>",
"phone": "<string>",
"website": "<string>",
"rating": 123,
"userRatingCount": 123,
"openNow": true,
"pureServiceAreaBusiness": true
}
}
],
"has_more": true,
"metadata": {
"status": "NOT_QUERIED",
"provenance": {
"datasets": [
{
"datasetSlug": "<string>",
"requirement": "required",
"visible": true,
"onRefresh": true,
"sourcePriority": 123,
"status": "NOT_QUERIED",
"queryId": "<string>",
"observedAt": "<string>",
"recordedAt": "<string>",
"errorCode": "upstream_error"
}
]
},
"summary": "<string>"
},
"next_cursor": "<string>",
"type": "<string>"
}curl --request GET \
--url http://localhost:3000/v2/entities/{id}/address \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/entities/{id}/address"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/entities/{id}/address', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/entities/{id}/address",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/entities/{id}/address"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/entities/{id}/address")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/entities/{id}/address")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"sourceDataset": "<string>",
"evidence": [
{
"sourceDataset": "<string>",
"matchStatus": "match",
"matchedFields": [
"addressMain"
],
"divergentFields": [
"addressMain"
],
"observedAt": "<string>",
"fullAddress": "<string>",
"addressMain": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
}
],
"media": {
"images": [
{
"url": "<string>",
"name": "<string>",
"width": 123,
"height": 123,
"attributionName": "<string>",
"attributionUrl": "<string>"
}
],
"map": {
"imageDataUrl": "<string>",
"query": "<string>",
"externalUrl": "<string>"
},
"streetView": {
"images": [
{
"imageDataUrl": "<string>",
"panoId": "<string>",
"latitude": 123,
"longitude": 123,
"heading": 123,
"pitch": 123,
"fov": 123
}
],
"query": "<string>"
}
},
"relatedAddresses": [
{
"relationType": "google_maps",
"relevance": 50,
"sourceDataset": "<string>",
"sourceLabel": "<string>",
"fullAddress": "<string>",
"media": {
"images": [
{
"url": "<string>",
"name": "<string>",
"width": 123,
"height": 123,
"attributionName": "<string>",
"attributionUrl": "<string>"
}
],
"map": {
"imageDataUrl": "<string>",
"query": "<string>",
"externalUrl": "<string>"
},
"streetView": {
"images": [
{
"imageDataUrl": "<string>",
"panoId": "<string>",
"latitude": 123,
"longitude": 123,
"heading": 123,
"pitch": 123,
"fov": 123
}
],
"query": "<string>"
}
},
"entityName": "<string>",
"entityDocument": "<string>",
"typology": "<string>",
"addressMain": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"latitude": 123,
"longitude": 123,
"businessPresence": {
"status": "matched",
"confidence": 50,
"candidateCount": 1,
"reviews": [
{
"name": "<string>",
"authorName": "<string>",
"authorPhotoUrl": "<string>",
"rating": 123,
"text": "<string>",
"relativePublishTime": "<string>",
"publishTime": "<string>"
}
],
"candidates": [
{
"confidence": 50,
"nameStatus": "match",
"addressStatus": "match",
"sameOfficialStreetAndNumber": true,
"selected": true,
"placeId": "<string>",
"name": "<string>",
"address": "<string>",
"latitude": 123,
"longitude": 123,
"googleMapsUrl": "<string>",
"primaryTypeLabel": "<string>",
"businessStatus": "<string>",
"rating": 123,
"userRatingCount": 123,
"distanceMeters": 123
}
],
"comparisons": [
{
"field": "name",
"status": "match",
"officialValue": "<string>",
"publicValue": "<string>"
}
],
"signals": [
{
"code": "BUSINESS_IDENTITY_CONFIRMED",
"severity": "positive"
}
],
"placeId": "<string>",
"name": "<string>",
"address": "<string>",
"distanceMeters": 123,
"googleMapsUrl": "<string>",
"primaryType": "<string>",
"primaryTypeLabel": "<string>",
"businessStatus": "<string>",
"phone": "<string>",
"website": "<string>",
"rating": 123,
"userRatingCount": 123,
"openNow": true,
"pureServiceAreaBusiness": true
}
}
],
"label": "<string>",
"fullAddress": "<string>",
"typology": "<string>",
"addressMain": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"latitude": 123,
"longitude": 123,
"origin": "<string>",
"originDetail": "<string>",
"addressType": "<string>",
"isActive": true,
"isMain": true,
"businessPresence": {
"status": "matched",
"confidence": 50,
"candidateCount": 1,
"reviews": [
{
"name": "<string>",
"authorName": "<string>",
"authorPhotoUrl": "<string>",
"rating": 123,
"text": "<string>",
"relativePublishTime": "<string>",
"publishTime": "<string>"
}
],
"candidates": [
{
"confidence": 50,
"nameStatus": "match",
"addressStatus": "match",
"sameOfficialStreetAndNumber": true,
"selected": true,
"placeId": "<string>",
"name": "<string>",
"address": "<string>",
"latitude": 123,
"longitude": 123,
"googleMapsUrl": "<string>",
"primaryTypeLabel": "<string>",
"businessStatus": "<string>",
"rating": 123,
"userRatingCount": 123,
"distanceMeters": 123
}
],
"comparisons": [
{
"field": "name",
"status": "match",
"officialValue": "<string>",
"publicValue": "<string>"
}
],
"signals": [
{
"code": "BUSINESS_IDENTITY_CONFIRMED",
"severity": "positive"
}
],
"placeId": "<string>",
"name": "<string>",
"address": "<string>",
"distanceMeters": 123,
"googleMapsUrl": "<string>",
"primaryType": "<string>",
"primaryTypeLabel": "<string>",
"businessStatus": "<string>",
"phone": "<string>",
"website": "<string>",
"rating": 123,
"userRatingCount": 123,
"openNow": true,
"pureServiceAreaBusiness": true
}
}
],
"has_more": true,
"metadata": {
"status": "NOT_QUERIED",
"provenance": {
"datasets": [
{
"datasetSlug": "<string>",
"requirement": "required",
"visible": true,
"onRefresh": true,
"sourcePriority": 123,
"status": "NOT_QUERIED",
"queryId": "<string>",
"observedAt": "<string>",
"recordedAt": "<string>",
"errorCode": "upstream_error"
}
]
},
"summary": "<string>"
},
"next_cursor": "<string>",
"type": "<string>"
}OAuth2 Authorization Code flow
CPF, CNPJ, or company id (cmp_*)
Comma-separated optional response fields. Supports "summary.short", "summary.long", and "summary.mdx". Without summary.* the metadata.summary field is omitted.
Object type identifier
Array of results for current page
Show child attributes
Whether more results exist beyond this page
Show child attributes
Opaque cursor for next page. null if no more results.
Type of results (Notion-compatible)