GET
/
v1
/
geo
/
search
import { JigsawStack } from "jigsawstack";

const jigsawstack = JigsawStack({
  apiKey: "your-api-key",
});

const result = await jigsawstack.geo.search({
  search_value: "Times square",
});
{
  "success": true,
  "data": [
    {
      "type": "poi",
      "full_address": "New York, New York, New York 10036, United States",
      "name": "Times Square",
      "place_formatted": "New York, New York 10036, United States",
      "postcode": "10036",
      "place": "New York City",
      "region": {
        "name": "New York",
        "region_code": "NY",
        "region_code_full": "US-NY"
      },
      "country": {
        "name": "United States",
        "country_code": "US",
        "country_code_alpha_3": "USA"
      },
      "language": "en",
      "geoloc": {
        "type": "Point",
        "coordinates": [-73.9851204, 40.75889]
      },
      "poi_category": ["historic site", "monument", "tourist attraction"],
      "addtional_properties": {
        "phone": "(212) 768-1560",
        "website": "https://www.timessquarenyc.org",
        "open_hours": {}
      }
    }
  ]
}

Query

search_value
string
required

The search value.

country_code
string

The ISO 3 country code to filter search results.

proximity_lat
string

The proximity latitude of the search value.

proximity_lng
string

The proximity longitude of the search value.

types
string
  • address
  • street
  • neighborhood
  • country
  • region
  • place
  • street
  • postcode
  • district
  • city
x-api-key
string
required

Your JigsawStack API key

Response

success
boolean

Indicates whether the call was successful.

import { JigsawStack } from "jigsawstack";

const jigsawstack = JigsawStack({
  apiKey: "your-api-key",
});

const result = await jigsawstack.geo.search({
  search_value: "Times square",
});
{
  "success": true,
  "data": [
    {
      "type": "poi",
      "full_address": "New York, New York, New York 10036, United States",
      "name": "Times Square",
      "place_formatted": "New York, New York 10036, United States",
      "postcode": "10036",
      "place": "New York City",
      "region": {
        "name": "New York",
        "region_code": "NY",
        "region_code_full": "US-NY"
      },
      "country": {
        "name": "United States",
        "country_code": "US",
        "country_code_alpha_3": "USA"
      },
      "language": "en",
      "geoloc": {
        "type": "Point",
        "coordinates": [-73.9851204, 40.75889]
      },
      "poi_category": ["historic site", "monument", "tourist attraction"],
      "addtional_properties": {
        "phone": "(212) 768-1560",
        "website": "https://www.timessquarenyc.org",
        "open_hours": {}
      }
    }
  ]
}