Get the API
The ArcGIS API for JavaScript is available to developers in several ways. The most common way is to use the CDN version. See below for more info and alternatives. Note: The code for the ArcGIS API for JavaScript cannot be modified.
CDN (hosted version)
The recommended approach for accessing the API is to use the hosted version. Reference the API from our CDN (content delivery network) and you are ready to get started.
<link rel="stylesheet" href="https://js.arcgis.com/4.18/esri/themes/light/main.css">
<script src="https://js.arcgis.com/4.18/"></script>
Benefits to working with the hosted version of the API:
- Delivered via a content delivery network (CDN). CDN's are a collection of geographically distributed web servers that deliver content efficiently.
- The servers are load balanced and monitored 24/7.
- No need to download and re-install the API when new versions are released. You just need to modify the script tag in your application to point to the new version.
Using npm for custom builds
The ArcGIS API for JavaScript is also available using npm (a JavaScript package manager).
npm install @arcgis/core
You can install the API locally when using JavaScript frameworks such as React and Angular, as well as with module bundlers such as webpack or rollup.js.
For more information here are several guides:
Host the CDN build locally
In some cases, you may need to use a locally hosted version of the CDN, for example, if you are in a restricted network environment with no internet access. You can also download and install the SDK which includes the Guide, API reference, Sample Code, and documentation. The SDK available for download is a snapshot of the help from the release date of the ArcGIS API for JavaScript version 4.18 and will not include any sample updates, documentation fixes etc.
To download the ArcGIS API for JavaScript and SDK navigate to the ArcGIS API for JavaScript download page and log-in with your Esri global account.
Web server hosting configuration
Whether you use npm to create a custom build or download a pre-built version of the API, note that a web server supporting HTTPS
requires the web server to use a web server certificate.
The web server hosting configuration for a custom build of the ArcGIS API for JavaScript will need the following MIME/type
registration.
extension | MIME/type | Description |
---|---|---|
.ttf | application/octet-stream | True Type Fonts |
.wasm | application/wasm | WebAssembly |
.woff | application/font-woff | Web Open Font Format |
.woff2 | application/font-woff2 | WOFF File Format 2.0 |
.wsv | application/octet-stream | Supports SceneView 's stars visualization |