POST
/
markets
/
{marketId}
/
companies
/
locations
curl --request POST \
  --url https://api.forestreet.com/markets/{marketId}/companies/locations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "country": [
    {}
  ],
  "state": [
    {}
  ],
  "city": [
    {}
  ],
  "postcode": [
    {}
  ],
  "domain": [
    {}
  ],
  "dunsNumber": [
    {}
  ]
}'
{
  "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

marketId
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

country
array
default: ""

An array of country name strings.

state
array
default: ""

An array of state strings

city
array
default: ""

An array of city strings

postcode
array
default: ""

An array of postcode strings

domain
array
default: ""

An array of company domains

dunsNumber
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
      }
  ]
}