local-seo
Add a location
A listing, and the grid drawn around it: grid_size 3, 5 or 7 cells a side, spacing_km apart. Each keyword at it is searched from every cell. One location on the plan.
POST
/
v1
/
projects
/
{projectId}
/
local
/
places
Add a location
curl --request POST \
--url https://api.surnex.io/v1/projects/{projectId}/local/places \
--header 'Content-Type: application/json' \
--data '
{
"listing": {
"title": "<string>",
"address": "<string>",
"cid": "<string>",
"place_id": "<string>",
"latitude": 123,
"longitude": 123
},
"name": "<string>",
"location_code": 2840,
"language_code": "en",
"grid_size": 5,
"spacing_km": 1
}
'import requests
url = "https://api.surnex.io/v1/projects/{projectId}/local/places"
payload = {
"listing": {
"title": "<string>",
"address": "<string>",
"cid": "<string>",
"place_id": "<string>",
"latitude": 123,
"longitude": 123
},
"name": "<string>",
"location_code": 2840,
"language_code": "en",
"grid_size": 5,
"spacing_km": 1
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
listing: {
title: '<string>',
address: '<string>',
cid: '<string>',
place_id: '<string>',
latitude: 123,
longitude: 123
},
name: '<string>',
location_code: 2840,
language_code: 'en',
grid_size: 5,
spacing_km: 1
})
};
fetch('https://api.surnex.io/v1/projects/{projectId}/local/places', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.surnex.io/v1/projects/{projectId}/local/places",
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([
'listing' => [
'title' => '<string>',
'address' => '<string>',
'cid' => '<string>',
'place_id' => '<string>',
'latitude' => 123,
'longitude' => 123
],
'name' => '<string>',
'location_code' => 2840,
'language_code' => 'en',
'grid_size' => 5,
'spacing_km' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "https://api.surnex.io/v1/projects/{projectId}/local/places"
payload := strings.NewReader("{\n \"listing\": {\n \"title\": \"<string>\",\n \"address\": \"<string>\",\n \"cid\": \"<string>\",\n \"place_id\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"name\": \"<string>\",\n \"location_code\": 2840,\n \"language_code\": \"en\",\n \"grid_size\": 5,\n \"spacing_km\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
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("https://api.surnex.io/v1/projects/{projectId}/local/places")
.header("Content-Type", "application/json")
.body("{\n \"listing\": {\n \"title\": \"<string>\",\n \"address\": \"<string>\",\n \"cid\": \"<string>\",\n \"place_id\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"name\": \"<string>\",\n \"location_code\": 2840,\n \"language_code\": \"en\",\n \"grid_size\": 5,\n \"spacing_km\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.surnex.io/v1/projects/{projectId}/local/places")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"listing\": {\n \"title\": \"<string>\",\n \"address\": \"<string>\",\n \"cid\": \"<string>\",\n \"place_id\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"name\": \"<string>\",\n \"location_code\": 2840,\n \"language_code\": \"en\",\n \"grid_size\": 5,\n \"spacing_km\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"business_name": "<string>",
"address": "<string>",
"cid": "<string>",
"latitude": 123,
"longitude": 123,
"location_code": 123,
"language_code": "<string>",
"grid_size": 123,
"spacing_km": 123,
"keyword_count": 123,
"created_at": "2023-11-07T05:31:56Z"
}
}{}{}Path Parameters
Body
application/json
⌘I
Add a location
curl --request POST \
--url https://api.surnex.io/v1/projects/{projectId}/local/places \
--header 'Content-Type: application/json' \
--data '
{
"listing": {
"title": "<string>",
"address": "<string>",
"cid": "<string>",
"place_id": "<string>",
"latitude": 123,
"longitude": 123
},
"name": "<string>",
"location_code": 2840,
"language_code": "en",
"grid_size": 5,
"spacing_km": 1
}
'import requests
url = "https://api.surnex.io/v1/projects/{projectId}/local/places"
payload = {
"listing": {
"title": "<string>",
"address": "<string>",
"cid": "<string>",
"place_id": "<string>",
"latitude": 123,
"longitude": 123
},
"name": "<string>",
"location_code": 2840,
"language_code": "en",
"grid_size": 5,
"spacing_km": 1
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
listing: {
title: '<string>',
address: '<string>',
cid: '<string>',
place_id: '<string>',
latitude: 123,
longitude: 123
},
name: '<string>',
location_code: 2840,
language_code: 'en',
grid_size: 5,
spacing_km: 1
})
};
fetch('https://api.surnex.io/v1/projects/{projectId}/local/places', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.surnex.io/v1/projects/{projectId}/local/places",
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([
'listing' => [
'title' => '<string>',
'address' => '<string>',
'cid' => '<string>',
'place_id' => '<string>',
'latitude' => 123,
'longitude' => 123
],
'name' => '<string>',
'location_code' => 2840,
'language_code' => 'en',
'grid_size' => 5,
'spacing_km' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "https://api.surnex.io/v1/projects/{projectId}/local/places"
payload := strings.NewReader("{\n \"listing\": {\n \"title\": \"<string>\",\n \"address\": \"<string>\",\n \"cid\": \"<string>\",\n \"place_id\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"name\": \"<string>\",\n \"location_code\": 2840,\n \"language_code\": \"en\",\n \"grid_size\": 5,\n \"spacing_km\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
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("https://api.surnex.io/v1/projects/{projectId}/local/places")
.header("Content-Type", "application/json")
.body("{\n \"listing\": {\n \"title\": \"<string>\",\n \"address\": \"<string>\",\n \"cid\": \"<string>\",\n \"place_id\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"name\": \"<string>\",\n \"location_code\": 2840,\n \"language_code\": \"en\",\n \"grid_size\": 5,\n \"spacing_km\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.surnex.io/v1/projects/{projectId}/local/places")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"listing\": {\n \"title\": \"<string>\",\n \"address\": \"<string>\",\n \"cid\": \"<string>\",\n \"place_id\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"name\": \"<string>\",\n \"location_code\": 2840,\n \"language_code\": \"en\",\n \"grid_size\": 5,\n \"spacing_km\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"business_name": "<string>",
"address": "<string>",
"cid": "<string>",
"latitude": 123,
"longitude": 123,
"location_code": 123,
"language_code": "<string>",
"grid_size": 123,
"spacing_km": 123,
"keyword_count": 123,
"created_at": "2023-11-07T05:31:56Z"
}
}{}{}