Query a feature layer (SQL)

A feature layer can contain a large number of features. To access a subset of the features, you can execute a SQL or spatial query, or both at the same time. You can also return the attributes, geometry, or both attributes and geometry for each record. SQL and spatial queries are useful when a feature layer is very large and you just want to access a subset of the data.

In this tutorial, you access and query a hosted feature layer with a SQL where clause and only return the first record.

Prerequisites

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Create a new pen

  1. If you are using the CDN libraries, to get started.

Get an access token

You need an access token with the correct privileges to access the resources used in this tutorial.

  1. Go to the Create an API key tutorial and create an API key with the following privilege(s):

    • Privileges:
    • Item access
      • Note: If you are using your own custom data layer for this tutorial, you need to grant the API key credentials access to the layer item. Learn more in Item access privileges.
  2. Copy the API key access token to your clipboard when prompted.

  3. In CodePen, update the accessToken variable to use your access token.

    Use dark colors for code blocksCopy
    1
    2
    3
    4
    
    const accessToken = "YOUR_ACCESS_TOKEN";
    
    const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);

To learn about the other types of authentication available, go to Types of authentication.

Make the request

Copy and paste the code below, following the steps to make a request to the feature service.

  1. Reference the ArcGIS REST JS libraries either through CDN, ES Modules, or Node JS.

    1. Set the accessToken with an API key access token from API key credentials.
  2. Define the parameters needed for the request.

  3. Call the feature service and handle the results.

CDNCDNES ModulesNode JS
Expand
Use dark colors for code blocks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
    <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4.0.0/dist/bundled/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-feature-service@4.0.0/dist/bundled/feature-service.umd.js"></script>
    <script>
      /* when including ArcGIS REST JS all exports are available
    from the same arcgisRest global */

      const accessToken = "YOUR_ACCESS_TOKEN";

      const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);

      arcgisRest
        .queryFeatures({
          url: "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/LA_County_Parcels/FeatureServer/0",
          where: "UseType = 'Residential'",
          resultRecordCount: 1,
          authentication
        })
        .then((response) => {
          console.log(response.features);
          document.getElementById("result").textContent = JSON.stringify(response.features, null, 2);
        });

    </script>
Expand

Result

Below is the response from the service:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
[
  {
    "attributes": {
      "OBJECTID": 52,
      "AIN": "2004001003",
      "APN": "2004-001-003",
      "SitusHouseNo": "8321",
      "SitusFraction": " ",
      "SitusDirection": " ",
      "SitusUnit": " ",
      "SitusStreet": "FAUST AVE",
      "SitusAddress": "8321 FAUST AVE",
      "SitusCity": "LOS ANGELES CA",
      "SitusZIP": "91304-3327",
      "SitusFullAddress": "8321 FAUST AVE LOS ANGELES CA 91304",
      "TaxRateArea": "00016",
      "TaxRateCity": "LOS ANGELES",
      "AgencyClassNo": null,
      "AgencyName": null,
      "AgencyType": null,
      "UseCode": "0101",
      "UseCode_2": "01",
      "UseType": "Residential",
      "UseDescription": "Single",
      "DesignType1": "0131",
      "YearBuilt1": "1973",
      "EffectiveYear1": "1973",
      "Units1": 1,
      "Bedrooms1": 4,
      "Bathrooms1": 3,

What's next?

Learn how to use additional ArcGIS location services in these tutorials:

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.