Locations
curl --request POST \
--url https://api.forestreet.com/markets/{marketId}/companies/locations \
--header 'Content-Type: application/json' \
--data '
{
"country": [
{}
],
"state": [
{}
],
"city": [
{}
],
"postcode": [
{}
],
"domain": [
{}
],
"dunsNumber": [
{}
]
}
'import requests
url = "https://api.forestreet.com/markets/{marketId}/companies/locations"
payload = {
"country": [{}],
"state": [{}],
"city": [{}],
"postcode": [{}],
"domain": [{}],
"dunsNumber": [{}]
}
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({
country: [{}],
state: [{}],
city: [{}],
postcode: [{}],
domain: [{}],
dunsNumber: [{}]
})
};
fetch('https://api.forestreet.com/markets/{marketId}/companies/locations', 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.forestreet.com/markets/{marketId}/companies/locations",
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([
'country' => [
[
]
],
'state' => [
[
]
],
'city' => [
[
]
],
'postcode' => [
[
]
],
'domain' => [
[
]
],
'dunsNumber' => [
[
]
]
]),
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.forestreet.com/markets/{marketId}/companies/locations"
payload := strings.NewReader("{\n \"country\": [\n {}\n ],\n \"state\": [\n {}\n ],\n \"city\": [\n {}\n ],\n \"postcode\": [\n {}\n ],\n \"domain\": [\n {}\n ],\n \"dunsNumber\": [\n {}\n ]\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.forestreet.com/markets/{marketId}/companies/locations")
.header("Content-Type", "application/json")
.body("{\n \"country\": [\n {}\n ],\n \"state\": [\n {}\n ],\n \"city\": [\n {}\n ],\n \"postcode\": [\n {}\n ],\n \"domain\": [\n {}\n ],\n \"dunsNumber\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.forestreet.com/markets/{marketId}/companies/locations")
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 \"country\": [\n {}\n ],\n \"state\": [\n {}\n ],\n \"city\": [\n {}\n ],\n \"postcode\": [\n {}\n ],\n \"domain\": [\n {}\n ],\n \"dunsNumber\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"meta": {
"totalItems": 9
},
"currentQuery": {
"marketId": 3994,
"filters": {
"domain": [
"jacksonsestateagents.com",
"barnardmarcus.co.uk"
]
}
},
"data": [
{
"dunsNumber": 9962094557,
"domain": "jacksonsestateagents.com",
"lat": 51.4551799,
"lng": -0.13927789999999998,
"fullAddress": "73 Abbeville Rd, London SW4 9JN",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW4 9EG",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 2964233168,
"domain": "barnardmarcus.co.uk",
"lat": 51.3932089,
"lng": -0.1137673,
"fullAddress": "4-5, Brigstock Parade, London Rd, Thornton Heath CR7 7HW",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "CR7 7JL",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 1860591409,
"domain": "barnardmarcus.co.uk",
"lat": 51.4265543,
"lng": -0.0535367,
"fullAddress": "13 Sydenham Rd, London SE26 5EX",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SE26 5EX",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 5632562326,
"domain": "barnardmarcus.co.uk",
"lat": 51.467842,
"lng": -0.067505,
"fullAddress": "152 Rye Ln, London SE15 4NB",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SE15 5DW",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 6985090932,
"domain": "jacksonsestateagents.com",
"lat": 51.4432121,
"lng": -0.1515773,
"fullAddress": "8-11 Balham Station Rd, London SW12 9SG",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW12 9SG",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 9978053212,
"domain": "jacksonsestateagents.com",
"lat": 51.4351792,
"lng": -0.1579118,
"fullAddress": "26 Tooting Bec Rd, London SW17 8BD",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW17",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 7213059966,
"domain": "jacksonsestateagents.com",
"lat": 51.4357708,
"lng": -0.1283086,
"fullAddress": "1-3, De Montfort Parade, Streatham High Rd, London SW16 1BU",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW16 1DA",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 4969286712,
"domain": "barnardmarcus.co.uk",
"lat": 51.509647369384766,
"lng": -0.09907600283622742,
"fullAddress": "Sovereign House, 361 King Street, Hammersmith, London, W6 9NA, England, GBR",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "EC4",
"companyName": "Barnard Marcus",
"isHeadquarter": true
},
{
"dunsNumber": 4127039475,
"domain": "jacksonsestateagents.com",
"lat": 51.509647369384766,
"lng": -0.09907600283622742,
"fullAddress": "115 Balham High Rd., London, SW12 9AP, England, GBR",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "EC4V 4AJ",
"companyName": "Jacksons",
"isHeadquarter": true
}
]
}
Companies
Locations
This endpoint retrieves all the locations for companies for a given market.
POST
/
markets
/
{marketId}
/
companies
/
locations
Locations
curl --request POST \
--url https://api.forestreet.com/markets/{marketId}/companies/locations \
--header 'Content-Type: application/json' \
--data '
{
"country": [
{}
],
"state": [
{}
],
"city": [
{}
],
"postcode": [
{}
],
"domain": [
{}
],
"dunsNumber": [
{}
]
}
'import requests
url = "https://api.forestreet.com/markets/{marketId}/companies/locations"
payload = {
"country": [{}],
"state": [{}],
"city": [{}],
"postcode": [{}],
"domain": [{}],
"dunsNumber": [{}]
}
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({
country: [{}],
state: [{}],
city: [{}],
postcode: [{}],
domain: [{}],
dunsNumber: [{}]
})
};
fetch('https://api.forestreet.com/markets/{marketId}/companies/locations', 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.forestreet.com/markets/{marketId}/companies/locations",
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([
'country' => [
[
]
],
'state' => [
[
]
],
'city' => [
[
]
],
'postcode' => [
[
]
],
'domain' => [
[
]
],
'dunsNumber' => [
[
]
]
]),
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.forestreet.com/markets/{marketId}/companies/locations"
payload := strings.NewReader("{\n \"country\": [\n {}\n ],\n \"state\": [\n {}\n ],\n \"city\": [\n {}\n ],\n \"postcode\": [\n {}\n ],\n \"domain\": [\n {}\n ],\n \"dunsNumber\": [\n {}\n ]\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.forestreet.com/markets/{marketId}/companies/locations")
.header("Content-Type", "application/json")
.body("{\n \"country\": [\n {}\n ],\n \"state\": [\n {}\n ],\n \"city\": [\n {}\n ],\n \"postcode\": [\n {}\n ],\n \"domain\": [\n {}\n ],\n \"dunsNumber\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.forestreet.com/markets/{marketId}/companies/locations")
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 \"country\": [\n {}\n ],\n \"state\": [\n {}\n ],\n \"city\": [\n {}\n ],\n \"postcode\": [\n {}\n ],\n \"domain\": [\n {}\n ],\n \"dunsNumber\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"meta": {
"totalItems": 9
},
"currentQuery": {
"marketId": 3994,
"filters": {
"domain": [
"jacksonsestateagents.com",
"barnardmarcus.co.uk"
]
}
},
"data": [
{
"dunsNumber": 9962094557,
"domain": "jacksonsestateagents.com",
"lat": 51.4551799,
"lng": -0.13927789999999998,
"fullAddress": "73 Abbeville Rd, London SW4 9JN",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW4 9EG",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 2964233168,
"domain": "barnardmarcus.co.uk",
"lat": 51.3932089,
"lng": -0.1137673,
"fullAddress": "4-5, Brigstock Parade, London Rd, Thornton Heath CR7 7HW",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "CR7 7JL",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 1860591409,
"domain": "barnardmarcus.co.uk",
"lat": 51.4265543,
"lng": -0.0535367,
"fullAddress": "13 Sydenham Rd, London SE26 5EX",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SE26 5EX",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 5632562326,
"domain": "barnardmarcus.co.uk",
"lat": 51.467842,
"lng": -0.067505,
"fullAddress": "152 Rye Ln, London SE15 4NB",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SE15 5DW",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 6985090932,
"domain": "jacksonsestateagents.com",
"lat": 51.4432121,
"lng": -0.1515773,
"fullAddress": "8-11 Balham Station Rd, London SW12 9SG",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW12 9SG",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 9978053212,
"domain": "jacksonsestateagents.com",
"lat": 51.4351792,
"lng": -0.1579118,
"fullAddress": "26 Tooting Bec Rd, London SW17 8BD",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW17",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 7213059966,
"domain": "jacksonsestateagents.com",
"lat": 51.4357708,
"lng": -0.1283086,
"fullAddress": "1-3, De Montfort Parade, Streatham High Rd, London SW16 1BU",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW16 1DA",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 4969286712,
"domain": "barnardmarcus.co.uk",
"lat": 51.509647369384766,
"lng": -0.09907600283622742,
"fullAddress": "Sovereign House, 361 King Street, Hammersmith, London, W6 9NA, England, GBR",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "EC4",
"companyName": "Barnard Marcus",
"isHeadquarter": true
},
{
"dunsNumber": 4127039475,
"domain": "jacksonsestateagents.com",
"lat": 51.509647369384766,
"lng": -0.09907600283622742,
"fullAddress": "115 Balham High Rd., London, SW12 9AP, England, GBR",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "EC4V 4AJ",
"companyName": "Jacksons",
"isHeadquarter": true
}
]
}
Path
string
The ID of the market whose companies you want to retrieve. This can be retrieved by searching for markets.
Body Request Object Example
{
"filters": {
"country": ["United Kingdom"],
"state": ["Greater London"],
"city": ["London"],
"postcode": ["SW4 9EG"],
"domain": ["jacksonsestateagents.com", "barnardmarcus.co.uk"],
"dunsNumber": [9962094557]
}
}
Body
array
default:""
An array of country name strings.
array
default:""
An array of state strings
array
default:""
An array of city strings
array
default:""
An array of postcode strings
array
default:""
An array of company domains
array
default:""
An array of company DUNS numbers
Response
{
"meta": {
"totalItems": 9
},
"currentQuery": {
"marketId": 3994,
"filters": {
"domain": [
"jacksonsestateagents.com",
"barnardmarcus.co.uk"
]
}
},
"data": [
{
"dunsNumber": 9962094557,
"domain": "jacksonsestateagents.com",
"lat": 51.4551799,
"lng": -0.13927789999999998,
"fullAddress": "73 Abbeville Rd, London SW4 9JN",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW4 9EG",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 2964233168,
"domain": "barnardmarcus.co.uk",
"lat": 51.3932089,
"lng": -0.1137673,
"fullAddress": "4-5, Brigstock Parade, London Rd, Thornton Heath CR7 7HW",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "CR7 7JL",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 1860591409,
"domain": "barnardmarcus.co.uk",
"lat": 51.4265543,
"lng": -0.0535367,
"fullAddress": "13 Sydenham Rd, London SE26 5EX",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SE26 5EX",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 5632562326,
"domain": "barnardmarcus.co.uk",
"lat": 51.467842,
"lng": -0.067505,
"fullAddress": "152 Rye Ln, London SE15 4NB",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SE15 5DW",
"companyName": "Barnard Marcus",
"isHeadquarter": false
},
{
"dunsNumber": 6985090932,
"domain": "jacksonsestateagents.com",
"lat": 51.4432121,
"lng": -0.1515773,
"fullAddress": "8-11 Balham Station Rd, London SW12 9SG",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW12 9SG",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 9978053212,
"domain": "jacksonsestateagents.com",
"lat": 51.4351792,
"lng": -0.1579118,
"fullAddress": "26 Tooting Bec Rd, London SW17 8BD",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW17",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 7213059966,
"domain": "jacksonsestateagents.com",
"lat": 51.4357708,
"lng": -0.1283086,
"fullAddress": "1-3, De Montfort Parade, Streatham High Rd, London SW16 1BU",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "SW16 1DA",
"companyName": "Jacksons",
"isHeadquarter": false
},
{
"dunsNumber": 4969286712,
"domain": "barnardmarcus.co.uk",
"lat": 51.509647369384766,
"lng": -0.09907600283622742,
"fullAddress": "Sovereign House, 361 King Street, Hammersmith, London, W6 9NA, England, GBR",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "EC4",
"companyName": "Barnard Marcus",
"isHeadquarter": true
},
{
"dunsNumber": 4127039475,
"domain": "jacksonsestateagents.com",
"lat": 51.509647369384766,
"lng": -0.09907600283622742,
"fullAddress": "115 Balham High Rd., London, SW12 9AP, England, GBR",
"city": "London",
"state": "Greater London",
"country": "United Kingdom",
"postcode": "EC4V 4AJ",
"companyName": "Jacksons",
"isHeadquarter": true
}
]
}
⌘I