API Reference / API Parameters / insideBoundingBox

Jan. 14, 2021

insideBoundingBox

Type: list of floats

Engine default: null

Parameter syntax

'insideBoundingBox' => [
  [
    point1_lat,
    point1_lng,
    point2_lat,
    point2_lng
  ],
  [ ... ] // you can search in multiple rectangles
]

insideBoundingBox: [
  [
   point1_lat,
   point1_lng,
   point2_lat,
   point2_lng
  ],
  [ ... ] # you can search in multiple rectangles
]

insideBoundingBox: [
  [
    point1_lat,
    point1_lng,
    point2_lat,
    point2_lng
  ],
  [ ... ] // you can search in multiple rectangles
]

'insideBoundingBox': [
   [
     point1_lat,
     point1_lng,
     point2_lat,
     point2_lng
   ],
   [ ... ] # you can search in multiple rectangles
 ]

insideBoundingBox = [
  BoundingBox(
    point1: Point(latitude: point1_lat, longitude: point1_lng),
    point2: Point(latitude: point2_lat, longitude: point2_lng)
  ),
  BoundingBox( // you can search in multiple rectangles
    ...
  )
]

insideBoundingBox {
    +BoundingBox(
        Point(latitude, longitude),
        Point(latitude, longitude)
    )
    +...
}

.setInsideBoundingBox(
  new GeoRect(
    new LatLng(point1_lat, point1_lng),
    new LatLng(point2_lat, point2_lng)
  ),
  new GeoRect( // you can search in multiple rectangles
    ...
  )
)

index.Search<T>(new Query("query")
{
  InsideBoundingBox = new List<List<float>>
  {
      new List<float>
      {
          point1_lat,
          point1_lng,
          point2_lat,
          point2_lng
      },
      new List<float>
      {
          ...  // you can search in multiple rectangles
      }
  }
});

.setInsideBoundingBox(
  Arrays.asList(
    Arrays.asList(point1_lat,point1_lng,point2_lat, point2_lng)
    ... // you can search in multiple rectangles
  )
)

opt.InsideBoundingBox([][4]float64{
  {point1_lat, point1_lng, point2_lat, point2_lng},
  { ... }, // you can search in multiple rectangles
})

insideBoundingBox = Some(Seq(
  InsideBoundingBox(
    point1_lat,
    point1_lng,
    point2_lat,
    point2_lng
  ),
  InsideBoundingBox(
    ... // you can search in multiple rectangles
  )
))

Can be used in these methods:
search, browseObjects, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, delete_by, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, delete_by, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, deleteBy, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, deleteObjectBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, browseAsync, deleteByAsync, searchForFacetValues Search, Browse, DeleteBy, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, DeleteBy, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, delete by, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Search inside a rectangular area (in geo coordinates).

The rectangle is defined by two diagonally opposite points (hereafter p1 and p2), hence by 4 floats: p1Lat, p1Lng, p2Lat, p2Lng.

For example: insideBoundingBox = [ 47.3165, 4.9665, 47.3424, 5.0201 ]

Usage notes:

You may specify multiple bounding boxes, in which case the search will use the union (OR) of the rectangles. To do this, pass either:
- more than 4 values (must be a multiple of 4: 8, 12…); example: 47.3165,4.9665,47.3424,5.0201,40.9234,2.1185,38.6430,1.9916; or
- an list of lists of floats (each inner array must contain exactly 4 values); example: [[47.3165, 4.9665, 47.3424, 5.0201], [40.9234, 2.1185, 38.6430, 1.9916]].
aroundLatLng and aroundLatLngViaIP will be ignored if used along with this parameter.
Be careful when your coordinates cross over the 180^th meridian.

Examples

Search inside a rectangular area

Copy

1
2
3
4
5
6
7
8
9
10
$boundingBox = [
  46.650828100116044, // p1Lat
  7.123046875, // p1Lng
  45.17210966999772, // p2Lat
  1.009765625 // p2Lng
];

$results = $index->search('query', [
  'insideBoundingBox' => [$boundingBox]
]);

1
2
3
4
5
6
7
8
9
10
bounding_box = [
  46.650828100116044, # p1Lat
  7.123046875, # p1Lng
  45.17210966999772, # p2Lat
  1.009765625 # p2Lng
]

results = index.search('query', {
  insideBoundingBox: [bounding_box]
})

1
2
3
4
5
6
7
8
9
10
11
12
const boundingBox = [
  46.650828100116044, // p1Lat
  7.123046875, // p1Lng
  45.17210966999772, // p2Lat
  1.009765625 // p2Lng
];

index.search('query', {
  insideBoundingBox: [boundingBox]
}).then(({ hits }) => {
  console.log(hits);
});

1
2
3
4
5
6
7
8
9
10
bounding_box = [
    46.650828100116044, # p1Lat
    7.123046875,        # p1Lng
    45.17210966999772,  # p2Lat
    1.009765625         # p2Lng
]

results = index.search('query', {
    'insideBoundingBox': [bounding_box]
})

1
2
3
4
5
6
7
8
9
10
11
let query = Query("query")
  .set(\.insideBoundingBox, to: [
    BoundingBox(point1: (46.650828100116044, 7.123046875),
                point2: (45.17210966999772, 1.009765625))
  ])

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
index.search(
  new Query("query")
    .setInsideBoundingBox(
      new GeoRect(
        new LatLng(46.650828100116044, 7.123046875),
        new LatLng(45.17210966999772, 1.009765625)
      )
    )
);

1
2
3
4
5
6
7
8
9
10
11
12
13
index.Search<T>(new Query("query")
{
    InsideBoundingBox = new List<List<float>>
    {
        new List<float>
        {
            46.650828100116044f,
            7.123046875f,
            45.17210966999772f,
            1.009765625f
        }
    }
});

1
2
3
4
5
6
index.search(
    new Query("query")
        .setInsideBoundingBox(
            Arrays.asList(
                Arrays.asList(
                    46.650828100116044f, 7.123046875f, 45.17210966999772f, 1.009765625f))));

1
2
3
4
5
6
7
8
9
10
11
res, err := index.Search(
  "query",
  opt.InsideBoundingBox([][4]float64{
    {
      46.650828100116044, // p1Lat
      7.123046875,        // p1Lng
      45.17210966999772,  // p2Lat
      1.009765625,        // p2Lng
    },
  }),
)

1
2
3
4
5
6
7
8
9
10
11
12
13
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    insideBoundingBox = Some(Seq(
      InsideBoundingBox(
        46.650828100116044,
        7.123046875,
        45.17210966999772,
        1.009765625
      )
    ))
  )
}

1
2
3
4
5
6
7
8
9
10
val query = query("query") {
    insideBoundingBox {
        +BoundingBox(
            Point(46.650828100116044f, 7.123046875f),
            Point(45.17210966999772f, 1.009765625f)
        )
    }
}

index.search(query)

Search inside multiple rectangular areas

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
$boundingBox1 = [
  46.650828100116044, // p1Lat
  7.123046875, // p1Lng
  45.17210966999772, // p2Lat
  1.009765625, // p2Lng
];

$boundingBox2 = [
  49.62625916704081, // p1Lat
  4.6181640625 // p1Lng
  47.715070300900194 // p2Lat
  0.482421875 // p2Lng
];

$results = $index->search('query', [
  'insideBoundingBox' => [
    $boundingBox1,
    $boundingBox2
  ]
]);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
bounding_box1 = [
  46.650828100116044, # p1Lat
  7.123046875, # p1Lng
  45.17210966999772, # p2Lat
  1.009765625, # p2Lng
]

bounding_box2 = [
  49.62625916704081, # p1_lat
  4.6181640625 # p1Lng
  47.715070300900194 # p2Lat
  0.482421875 # p2Lng
]

results = index.search('query', {
  insideBoundingBox: [
    bounding_box1,
    bounding_box2
  ]
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
const bounding_box1 = [
  46.650828100116044, // p1Lat
  7.123046875,        // p1Lng
  45.17210966999772,  // p2Lat
  1.009765625         // p2Lng
];

const bounding_box2 = [
  49.62625916704081,  // p1Lat
  4.6181640625,       // p1Lng
  47.715070300900194, // p2Lat
  0.482421875         // p2Lng
];

index.search('query', {
  insideBoundingBox: [
    bounding_box1,
    bounding_box2
  ]
}).then(({ hits }) => {
  console.log(hits);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
bounding_box1 = [
    46.650828100116044, # p1Lat
    7.123046875,        # p1Lng
    45.17210966999772,  # p2Lat
    1.009765625         # p2Lng
]

bounding_box2 = [
    49.62625916704081,  # p1Lat
    4.6181640625,       # p1Lng
    47.715070300900194, # p2Lat
    0.482421875         # p2Lng
]

results = index.search('query', {
    'insideBoundingBox': [
        bounding_box1,
        bounding_box2
    ]
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
let boundingBox1 = BoundingBox(
  point1: (46.650828100116044, 7.123046875),
  point2: (45.17210966999772, 1.009765625)
)

let boundingBox2 = BoundingBox(
  point1: (49.62625916704081, 4.6181640625),
  point2: (47.715070300900194, 0.482421875)
)

let query = Query("query")
  .set(\.insideBoundingBox, to: [boundingBox1, boundingBox2])

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
index.search(
  new Query("query")
    .setInsideBoundingBox(
      new GeoRect(
        new LatLng(46.650828100116044, 7.123046875),
        new LatLng(45.17210966999772, 1.009765625)
      ),
      new GeoRect(
        new LatLng(49.62625916704081, 4.6181640625),
        new LatLng(47.715070300900194, 0.482421875)
      )
    )
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
index.Search<T>(new Query("query")
{
    InsideBoundingBox = new List<List<float>>
    {
        new List<float>
        {
            46.650828100116044f,
            7.123046875f,
            45.17210966999772f,
            1.009765625f
        },
        new List<float>
        {
            49.62625916704081f,
            4.6181640625f,
            47.715070300900194f,
            0.482421875f
        }
    }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
index.search(
    new Query("query")
        .setInsideBoundingBox(
            Arrays.asList(
                Arrays.asList(
                    46.650828100116044f,
                    7.123046875f,
                    45.17210966999772f,
                    1.009765625f),
                Arrays.asList(
                    49.62625916704081f,
                    4.6181640625f,
                    47.715070300900194f,
                    0.482421875f))));

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
res, err := index.Search(
    "query",
    opt.InsideBoundingBox([][4]float64{
      {
        46.650828100116044, // p1Lat
        7.123046875,        // p1Lng
        45.17210966999772,  // p2Lat
        1.009765625,        // p2Lng
      },
      {
        49.62625916704081,  // p1Lat
        4.6181640625,       // p1Lng
        47.715070300900194, // p2Lat
        0.482421875,        // p2Lng
      },
    }),
  )

1
2
3
4
5
6
7
8
9
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    insideBoundingBox = Some(Seq(
      InsideBoundingBox(46.650828100116044, 7.123046875, 45.17210966999772, 1.009765625),
      InsideBoundingBox(49.62625916704081, 4.6181640625, 47.715070300900194, 0.482421875)
    ))
  )
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
val query = query("query") {
    insideBoundingBox {
        +BoundingBox(
            Point(latitude = 46.650828100116044f, longitude = 7.123046875f),
            Point(latitude = 45.17210966999772f, longitude = 1.009765625f)
        )
        +BoundingBox(
            Point(latitude = 49.62625916704081f, longitude = 4.6181640625f),
            Point(latitude = 47.715070300900194f, longitude = 0.482421875f)
        )
    }
}

index.search(query)

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

insideBoundingBox

About this parameter

Usage notes:

Examples

Search inside a rectangular area

Search inside multiple rectangular areas

Did you find this page helpful?

On this page