> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /filter/byradius

```
URL: http://<db.host>:<db.port>/filter/byradius
```

Calculates which objects from a table lie within a circle with the given radius
and center point (i.e. circular NAI). The operation is synchronous, meaning
that a response will not be returned until all the objects are fully available.
The response payload provides the count of the resulting set. A new resultant
set (view) which satisfies the input circular NAI restriction specification is
also created if a input parameter *view\_name* is passed in as part of the
request.

For track data, all track points that lie within the circle plus one point on
either side of the circle (if the track goes beyond the circle) will be
included in the result.

## Input Parameter Description

<ParamField body="table_name" type="string">
  Name of the table on which the filter by radius operation will be performed, in \[schema\_name.]table\_name format, using standard [name resolution rules](../../concepts/tables/#table-name-resolution). Must be an existing table.
</ParamField>

<ParamField body="view_name" type="string">
  If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard [name resolution rules](../../concepts/tables/#table-name-resolution) and meeting [table naming criteria](../../concepts/tables/#table-naming-criteria). Must not be an already existing table or view.

  The default value is ''.
</ParamField>

<ParamField body="x_column_name" type="string">
  Name of the column to be used for the x-coordinate (the longitude) of the center.
</ParamField>

<ParamField body="x_center" type="double">
  Value of the longitude of the center. Must be within \[-180.0, 180.0].

  The minimum allowed value is -180. The maximum allowed value is 180.
</ParamField>

<ParamField body="y_column_name" type="string">
  Name of the column to be used for the y-coordinate-the latitude-of the center.
</ParamField>

<ParamField body="y_center" type="double">
  Value of the latitude of the center. Must be within \[-90.0, 90.0].

  The minimum allowed value is -90. The maximum allowed value is 90.
</ParamField>

<ParamField body="radius" type="double">
  The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km.

  The minimum allowed value is 0. The maximum allowed value is MAX\_INT.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).

  <Expandable title="options">
    <ParamField body="create_temp_table">
      If *true*, a unique temporary table name will be generated in the sys\_temp schema and used in place of input parameter *view\_name*. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in *qualified\_view\_name*.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="collection_name">
      \[DEPRECATED--please specify the containing schema for the view as part of input parameter *view\_name* and use [/create/schema](/content/api/rest/create_schema_rest) to create the schema if non-existent]  Name of a schema which is to contain the newly created view. If the schema is non-existent, it will be automatically created.
    </ParamField>
  </Expandable>
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'filter\_by\_radius\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /filter/byradius endpoint:

  <Expandable title="data_str">
    <ResponseField name="count" type="long">
      The number of records passing the radius filter.
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.

      The default value is an empty map ( \{} ).

      <Expandable title="info">
        <ResponseField name="qualified_view_name">
          The fully qualified name of the view (i.e. including the schema).
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>