Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request POST \
--url http://localhost:3000/api/v1/addresses/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"addressType": "<string>",
"city": "<string>",
"country": "<string>",
"formattedAddress": "<string>",
"latitude": 123,
"longitude": 123,
"name": "<string>",
"placeId": "<string>",
"postalCode": "<string>",
"state": "<string>",
"street": "<string>",
"streetNumber": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/addresses/"
payload = {
"addressType": "<string>",
"city": "<string>",
"country": "<string>",
"formattedAddress": "<string>",
"latitude": 123,
"longitude": 123,
"name": "<string>",
"placeId": "<string>",
"postalCode": "<string>",
"state": "<string>",
"street": "<string>",
"streetNumber": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
addressType: '<string>',
city: '<string>',
country: '<string>',
formattedAddress: '<string>',
latitude: 123,
longitude: 123,
name: '<string>',
placeId: '<string>',
postalCode: '<string>',
state: '<string>',
street: '<string>',
streetNumber: '<string>'
})
};
fetch('http://localhost:3000/api/v1/addresses/', 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/api/v1/addresses/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'addressType' => '<string>',
'city' => '<string>',
'country' => '<string>',
'formattedAddress' => '<string>',
'latitude' => 123,
'longitude' => 123,
'name' => '<string>',
'placeId' => '<string>',
'postalCode' => '<string>',
'state' => '<string>',
'street' => '<string>',
'streetNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/addresses/"
payload := strings.NewReader("{\n \"addressType\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"formattedAddress\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"placeId\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumber\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/addresses/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"addressType\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"formattedAddress\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"placeId\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumber\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/addresses/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"addressType\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"formattedAddress\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"placeId\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumber\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "addr_01",
"city": "Lima",
"country": "PE",
"formattedAddress": "Av. Siempre Viva 123, Lima, Peru"
}curl --request POST \
--url http://localhost:3000/api/v1/addresses/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"addressType": "<string>",
"city": "<string>",
"country": "<string>",
"formattedAddress": "<string>",
"latitude": 123,
"longitude": 123,
"name": "<string>",
"placeId": "<string>",
"postalCode": "<string>",
"state": "<string>",
"street": "<string>",
"streetNumber": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/addresses/"
payload = {
"addressType": "<string>",
"city": "<string>",
"country": "<string>",
"formattedAddress": "<string>",
"latitude": 123,
"longitude": 123,
"name": "<string>",
"placeId": "<string>",
"postalCode": "<string>",
"state": "<string>",
"street": "<string>",
"streetNumber": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
addressType: '<string>',
city: '<string>',
country: '<string>',
formattedAddress: '<string>',
latitude: 123,
longitude: 123,
name: '<string>',
placeId: '<string>',
postalCode: '<string>',
state: '<string>',
street: '<string>',
streetNumber: '<string>'
})
};
fetch('http://localhost:3000/api/v1/addresses/', 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/api/v1/addresses/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'addressType' => '<string>',
'city' => '<string>',
'country' => '<string>',
'formattedAddress' => '<string>',
'latitude' => 123,
'longitude' => 123,
'name' => '<string>',
'placeId' => '<string>',
'postalCode' => '<string>',
'state' => '<string>',
'street' => '<string>',
'streetNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/addresses/"
payload := strings.NewReader("{\n \"addressType\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"formattedAddress\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"placeId\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumber\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/addresses/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"addressType\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"formattedAddress\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"placeId\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumber\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/addresses/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"addressType\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"formattedAddress\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"name\": \"<string>\",\n \"placeId\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumber\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "addr_01",
"city": "Lima",
"country": "PE",
"formattedAddress": "Av. Siempre Viva 123, Lima, Peru"
}