FAQ

This guide is for:

• New developers interested in building mapping applications using ArcGIS REST JS.
• Open source developers who want to combine ArcGIS REST JS along with their library of choice to access ArcGIS services.

The ArcGIS Maps SDK for JavaScript is Esri's flagship product for building web applications to visualize, edit, map and analyze geospatial data. It is a feature complete client side API for working with ArcGIS Location Services. The ArcGIS Maps SDK for JavaScript includes significant client side functionality including smart mapping, 3D rendering, geometric analysis and feature editing, as well as full support for working with web maps and web scenes.

However, the goal of ArcGIS REST JS is to provide a convenient and light-weight binding to the ArcGIS Location Services REST APIs for developers who need to work directly with it using JavaScript or TypeScript. This includes functional equivalents of the low-level request methods, identity management, server federation, along with additional thin wrappers to assist developers in scripting against the ArcGIS REST APIs directly in Node.js and browser applications.

This project is similar to the ArcGIS API for Python in many ways. Like the ArcGIS API for Python, this library aims to be a scripting tool that simplifies interacting with ArcGIS services. However, the ArcGIS API for Python highlights integration with dataframes and Jupyter Notebooks for visualization and sharing, whereas ArcGIS REST JS provides APIs for TypeScript or JavaScript applications running on a server, CLI, in a browser, or as a script.

ArcGIS REST JS attempts for as few tradeoffs as possible over making requests with tools like fetch. ArcGIS REST JS automatically handles proper parameter encoding for ArcGIS REST APIs, has error handling, token management and more.

Before tree shaking, all of this logic is ~8kb. Additional methods are around 1kb each or less, making the cost of adding ArcGIS REST JS to your application low.

You need either an ArcGIS Location Platform account or ArcGIS Online account to access ArcGIS Location Services. This will give you the ability to access the portal, create developer credentials, and manage your data.

You can not use an ArcGIS Enterprise account to access ArcGIS Location Services.

The table below shows the account types you can use to access each service:

You can find the official community at Esri Community.

Go to the GitHub repo, post issues and review the contributing guidelines.

Visit the Mapping and location services guide.

Go to the Glossary.

ArcGIS services are software that support an ArcGIS REST API and provides geospatial functionality or data. ArcGIS provides many types of services, such as location servicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more, data servicesData services, also known as hosted data services, are services created dynamically to store and provide access to your data in ArcGIS. Examples are feature services, vector tile services, map tile services, image services, and scene services.Learn more and spatial analysis servicesSpatial analysis services are services that perform geometry and statistical analyses on feature and raster data.Learn more.

ArcGIS REST JS has built in functionality to access the following ArcGIS services:

• ArcGIS GeoEnrichment service
• ArcGIS Routing service
• ArcGIS Geocoding service
• ArcGIS Elevation service
• ArcGIS Places service
• Vector tile service
• Map tile service
• Map service
• Feature service

If you need to work with other capabilities, such as the spatial analysis serviceA spatial analysis service, also known as a feature analysis service, is a service used to perform spatial analysis operations on feature data such as finding, comparing, summarizing, analyzing patterns, and calculating geometries.Learn more, you can do so using the generic request method from the @esri/arcgis-rest-request package.

You need either an ArcGIS Location Platform account or ArcGIS Online account to access ArcGIS Location Services. This will give you the ability to access the portal, create developer credentials, and manage your data.

You can not use an ArcGIS Enterprise account to access ArcGIS Location Services.

The table below shows the account types you can use to access each service:

ArcGIS Location Services

Yes, you need to provide an API key or implement another type of authentication to access ArcGIS Location ServicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more.

ArcGIS Enterprise services

For services that are private, yes, you need to provide authentication to access ArcGIS Enterprise services. You typically implement OAuth 2.0 to do so. Public services do not require authentication.

To learn more about the different types of authentication, go to Types of authentication.

To learn more about ArcGIS Location Services and capabilities, go to the Mapping and location services guide.

To learn more about ArcGIS Enterprise services and capabilities, go to the REST API documentation.

Data servicesData services, also known as hosted data services, are services created dynamically to store and provide access to your data in ArcGIS. Examples are feature services, vector tile services, map tile services, image services, and scene services.Learn more are services created dynamically to securely store, manage, and provide access to your data in portalArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more. Some of the types of services that can be created are:

• Feature servicesA feature service is a data service that provides access to spatial and non-spatial data in feature layers, feature layer views, and tables.Learn more
• Vector tile servicesA vector tile service is a data service that provides access to vector tile data and a style definition.Learn more
• Map tile servicesA map tile service, formerly known as image tile service, is a data service that provides access to static, pre-rendered mao tiles. The tiles are typical in PNG format. Map tiles are typically retrieved by specifying a specific level, row, and column value.Learn more
• Image servicesAn image service is a data service that can store, process, analyze, and share raster data.Learn more

Data services are typically created by importing data with the data management toolsData management tools are ArcGIS software applications and functionality in portal and ArcGIS Pro that can be used by developers to create, manage, and edit content and data such as web maps, hosted layers, and data services for their applications.Learn more. A unique URL for the service is assigned by the system when it is created.

The type of data service you use depends on the product you have, the format of your existing data, storage and output data format requirements, the size and complexity of the data, and the service functionality required.

Below is an overview of the main services and the data type each supports.

Yes, Esri offers data hosting through ArcGIS Location PlatformArcGIS Location Platform, formerly known as ArcGIS Platform, is a Platform as a Service (PaaS) product that gives developers access to location services, APIs, and tools to build mapping and spatial analysis applications. It is subscription-based and requires an ArcGIS Location Platform account.Learn more, ArcGIS OnlineArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account.Learn more and ArcGIS EnterpriseArcGIS Enterprise is a GIS mapping, analytics, data hosting, and content management product that can be hosted on-premise or in a cloud infrastructure. It includes software, applications, tools, APIs, and services for users and developers.Learn more (Portal for ArcGIS) that allow you to securely store, manage, and access your geographic data as hosted data services.

ArcGIS Location PlatformArcGIS Location Platform, formerly known as ArcGIS Platform, is a Platform as a Service (PaaS) product that gives developers access to location services, APIs, and tools to build mapping and spatial analysis applications. It is subscription-based and requires an ArcGIS Location Platform account.Learn more and ArcGIS OnlineArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account.Learn more allow you to publish your data as hosted layersA hosted layer is an item in a portal that contains the properties and settings for a hosted data service or a layer in a hosted data service.Learn more, which are hosted and managed by Esri's cloud infrastructure. This includes hosted feature layersA hosted feature layer is a hosted layer (item) in a portal that is used to manage the properties and settings of a spatially-enabled feature layer in a feature service.Learn more, vector tile layersA vector tile layer is a data layer used to access and display tiled data and its corresponding styles.Learn more, and map tile layers.

With ArcGIS EnterpriseArcGIS Enterprise is a GIS mapping, analytics, data hosting, and content management product that can be hosted on-premise or in a cloud infrastructure. It includes software, applications, tools, APIs, and services for users and developers.Learn more, you can host data services in your own portal'sArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more infrastructure and managed database. This gives you more control but requires maintaining your own servers.

You can import and host many different types of geographic data as data servicesData services, also known as hosted data services, are services created dynamically to store and provide access to your data in ArcGIS. Examples are feature services, vector tile services, map tile services, image services, and scene services.Learn more. The main requirement is that the incoming data has geometry coordinates and/or attributes (fields). The main storage formats are features, vector tiles, and map tiles. Some common file types include CSV, XLS, GeoJSON, Shapefile, and File Geodatabase files.

To learn more about supported data types, go to Portal and data services > Data services.

No, your data is your data. You retain complete ownership of your content.

The cost to access ArcGIS location servicesArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services.Learn more depends on the type of ArcGIS account you have and the service operation you use.

1. If you have an ArcGIS Location Platform accountAn ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription.Learn more, you are billed in US dollars. To determine the cost of accessing different services, go to Pricing. A free tier of access is available for some services.

2. If you have an ArcGIS Online accountAn ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization.Learn more, you are billed in creditsCredits are the currency used by ArcGIS Online Organization accounts to account for data storage and location service consumption. Credits are consumed for specific transactions, such as accessing location services, and types of storage, such as storing features, performing analytics, and using premium content.Learn more. To determine the cost of accessing different services, go to Understanding credits.

If you have ArcGIS Enterprise, there is no cost for accessing your own ArcGIS services.

To find the Esri Terms of Use, go to Terms of use.