---
title: stack es search-mvt cli command
description: Search a vector tile. 
url: https://docs-v3-preview.elastic.dev/elastic/cli/pull/415/cli/stack/es/search-mvt
---

# stack es search-mvt cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es search-mvt \
  --index <index> \
  --field <field> \
  --zoom <zoom> \
  --x <x> \
  --y <y> \
  [options]
```

Search a vector tile.

## Options

<definitions>
  <definition term="--index string required">
    A list of indices, data streams, or aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. To search a remote cluster, use the `<cluster>:<target>` syntax.
    **Repeatable:** pass `--index` multiple times to supply more than one value
  </definition>
  <definition term="--field string required">
    A field that contains the geospatial data to return. It must be a `geo_point` or `geo_shape` field. The field must have doc values enabled. It cannot be a nested field. NOTE: Vector tiles do not natively support geometry collections. For `geometrycollection` values in a `geo_shape` field, the API returns a hits layer feature for each element of the collection. This behavior may change in a future release.
  </definition>
  <definition term="--zoom number required">
    The zoom level of the vector tile to search. It accepts `0` to `29`.
  </definition>
  <definition term="--x number required">
    The X coordinate for the vector tile to search.
  </definition>
  <definition term="--y number required">
    The Y coordinate for the vector tile to search.
  </definition>
  <definition term="--aggs string">
    Sub-aggregations for the geotile_grid. It supports the following aggregation types: - `avg` - `boxplot` - `cardinality` - `extended stats` - `max` - `median absolute deviation` - `min` - `percentile` - `percentile-rank` - `stats` - `sum` - `value count` The aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.
  </definition>
  <definition term="--buffer number">
    The size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile.
  </definition>
  <definition term="--[no-]exact-bounds">
    If `false`, the meta layer's feature is the bounding box of the tile. If `true`, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. The aggregation runs on <field> values that intersect the `<zoom>/<x>/<y>` tile with `wrap_longitude` set to `false`. The resulting bounding box may be larger than the vector tile.
  </definition>
  <definition term="--extent number">
    The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.
  </definition>
  <definition term="--fields string">
    The fields to return in the `hits` layer. It supports wildcards (`*`). This parameter does not support fields with array values. Fields with array values may return inconsistent results.
    **Repeatable:** pass `--fields` multiple times to supply more than one value
  </definition>
  <definition term="--grid-agg string">
    The aggregation used to create a grid for the `field`.
  </definition>
  <definition term="--grid-precision number">
    Additional zoom levels available through the aggs layer. For example, if `<zoom>` is `7` and `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results don't include the aggs layer.
  </definition>
  <definition term="--grid-type string">
    Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a `geotile_grid` cell. If `grid, each feature is a polygon of the cells bounding box. If `point`, each feature is a Point that is the centroid of the cell.
  </definition>
  <definition term="--query string">
    The query DSL used to filter documents for the search.
  </definition>
  <definition term="--runtime-mappings string">
    Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.
  </definition>
  <definition term="--size number">
    The maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don't include the hits layer.
  </definition>
  <definition term="--sort string">
    Sort the features in the hits layer. By default, the API calculates a bounding box for each feature. It sorts features based on this box's diagonal length, from longest to shortest.
    **Repeatable:** pass `--sort` multiple times to supply more than one value
  </definition>
  <definition term="--[no-]track-total-hits">
    The number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.
  </definition>
  <definition term="--[no-]with-labels">
    If `true`, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * `Point` and `MultiPoint` features will have one of the points selected. * `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * `LineString` features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag `_mvt_label_position`.
  </definition>
</definitions>


## stack Options

<definitions>
  <definition term="--input-file string">
    path to a JSON file to use as command input
  </definition>
</definitions>


## Global Options

<definitions>
  <definition term="-V --[no-]version">
    Print the Elastic CLI version
  </definition>
  <definition term="--config-file string">
    path to a config file (default: ~/.elasticrc.yml)
  </definition>
  <definition term="--use-context string">
    override the active context from the config file
  </definition>
  <definition term="--command-profile string">
    restrict available commands to a deployment profile (serverless, stack, default)
  </definition>
  <definition term="--[no-]json">
    output as JSON
  </definition>
  <definition term="--output-fields string">
    comma-separated list of fields to include in output (dot-notation supported)
  </definition>
  <definition term="--output-template string">
    Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
  </definition>
  <definition term="--[no-]dry-run">
    validate all inputs and exit without performing any action (preview changes without applying them)
  </definition>
</definitions>