---
title: /solveClosestFacility
uid: closestFacility-service-direct
description: "Find directions using the global route service available with ArcGIS Location Services."
context:
requestType: "direct"
---
import Token from "../../../shared/routing/snippets/request-parameters/_Token.mdx"
import CFServiceDescription from "../../../shared/routing/snippets/_closestFacility-service.mdx"
import Incidents from "../../../shared/routing/snippets/request-parameters/_CF-incidents.mdx"
import Facilities from "../../../shared/routing/snippets/request-parameters/_CF-facilities.mdx"
import Cutoff from "../../../shared/routing/snippets/request-parameters/_CF-defaultCutoff.mdx"
import FacilityCount from "../../../shared/routing/snippets/request-parameters/_CF-TargetFacilityCount.mdx"
import TravelDirection from "../../../shared/routing/snippets/request-parameters/_CF-TravelDirection.mdx"
import Impedance from "../../../shared/routing/snippets/request-parameters/_Impedance-JDR-OnE.mdx"
import MeasurementUnits from "../../../shared/routing/snippets/request-parameters/_MeasurementUnits-JR-OnE.mdx"
import AttributeParameterValues from "../../../shared/routing/snippets/request-parameters/_AttributeParameterValues-JDR-OnE.mdx"
import TravelModes from "../../../shared/routing/snippets/request-parameters/_TravelMode.mdx"
import AnalysisRegion from "../../../shared/routing/snippets/request-parameters/_AnalysisRegion-JR-OnE.mdx"
import Context from "../../../shared/routing/snippets/request-parameters/_Context.mdx"
import DirectionsLanguage from "../../../shared/routing/snippets/request-parameters/_DirectionsLanguage-JDR-OnE.mdx"
import DistanceUnits from "../../../shared/routing/snippets/request-parameters/_DistanceUnits.mdx"
import LineBarriers from "../../../shared/routing/snippets/request-parameters/_LineBarriers.mdx"
import LocateSettings from "../../../shared/routing/snippets/request-parameters/_LocateSettings.mdx"
import OutputFormat from "../../../shared/routing/snippets/request-parameters/_OutputFormat-JR-OnE.mdx"
import PointBarriers from "../../../shared/routing/snippets/request-parameters/_PointBarriers.mdx"
import PolygonBarriers from "../../../shared/routing/snippets/request-parameters/_PolygonBarriers.mdx"
import SaveOutputNALayer from "../../../shared/routing/snippets/request-parameters/_SaveOutputNALayer-JR-OnE.mdx"
import SaveRouteData from "../../../shared/routing/snippets/request-parameters/_SaveRouteData-JR-OnE.mdx"
import TimeUnits from "../../../shared/routing/snippets/request-parameters/_TimeUnits.mdx"
import DirectionsStyleName from "../../../shared/routing/snippets/request-parameters/_DirectionsStyleName-JDR-OnE.mdx"
import DirectionsDistanceUnits from "../../../shared/routing/snippets/request-parameters/_DirectionsDistanceUnits-JDR-OnE.mdx"
import UseTimeWindows from "../../../shared/routing/snippets/request-parameters/_UseTimeWindows-JDR-OnE.mdx"
import PopulateDirectionsRoute from "../../../shared/routing/snippets/request-parameters/_PopulateDirections-JDR-OnE.mdx"
import UTurnAtJunctions from "../../../shared/routing/snippets/request-parameters/_UTurnAtJunctions.mdx"
import UseHierarchy from "../../../shared/routing/snippets/request-parameters/_CF-useHierarchy.mdx"
import Restrictions from "../../../shared/routing/snippets/request-parameters/_Restrictions-JDR-OnE.mdx"
import RtLineSimplificationTol from "../../../shared/routing/snippets/request-parameters/_RouteLineSimplificationTolerance-JR-OnE.mdx"
import Overrides from "../../../shared/routing/snippets/request-parameters/_Overrides-JDR-OnE.mdx"
import RouteShape from "../../../shared/routing/snippets/request-parameters/_RouteShape-JR-OnE.mdx"
import DistanceImpedance from "../../../shared/routing/snippets/request-parameters/_DistanceImpedance-JR-OnE.mdx"
import TimeImpedance from "../../../shared/routing/snippets/request-parameters/_TimeImpedance-JR-OnE.mdx"
import IgnoreInvalidLocations from "../../../shared/routing/snippets/request-parameters/_IgnoreInvalidLocations-JDR-OnE.mdx"
import TimeOfDay from "../../../shared/routing/snippets/request-parameters/_Direct-timeOfDay.mdx"
import TimeZoneForTimeOfDay from "../../../shared/routing/snippets/request-parameters/_TimeZoneForTimeOfDay-JR-OnE.mdx"
import LineBarrier from "../../../shared/routing/snippets/request-parameters/_LineBarriers.mdx"
import PolygonBarrier from "../../../shared/routing/snippets/request-parameters/_PolygonBarriers.mdx"
import PointBarrier from "../../../shared/routing/snippets/request-parameters/_PointBarriers.mdx"
import CFUsageLimits from "../../../shared/routing/snippets/request-parameters/_CF-UsageLimits.mdx"
import AccumulateAttrNames from "../../../shared/routing/snippets/request-parameters/_AccumulateAttributeNames-DR-OnE.mdx"
import DirectionsOutputType from "../../../shared/routing/snippets/request-parameters/_DirectionsOutputType.mdx"
import ImpedanceAttrName from "../../../shared/routing/snippets/request-parameters/_Impedance-JDR-OnE.mdx"
import DirectionsTimeAttrName from "../../../shared/routing/snippets/request-parameters/_DirectionsTimeAttrName.mdx"
import OutputLine from "../../../shared/routing/snippets/request-parameters/_RouteShape-JR-OnE.mdx"
import TargetFacilityCount from "../../../shared/routing/snippets/request-parameters/_CF-TargetFacilityCount.mdx"
import DefaultCutoff from "../../../shared/routing/snippets/request-parameters/_CF-defaultCutoff.mdx"
import ReturnBarriers from "../../../shared/routing/snippets/request-parameters/_returnBarriers.mdx"
import ReturnPolygonBarriers from "../../../shared/routing/snippets/request-parameters/_returnPolygonBarriers.mdx"
import ReturnPolylineBarriers from "../../../shared/routing/snippets/request-parameters/_returnPolylineBarriers.mdx"
import ReturnTraversedEdges from "../../../shared/routing/snippets/request-parameters/_returnTraversedEdges.mdx"
import ReturnTraversedJunctions from "../../../shared/routing/snippets/request-parameters/_returnTraversedJunctions.mdx"
import ReturnTraversedTurns from "../../../shared/routing/snippets/request-parameters/_returnTraversedTurns.mdx"
import ReturnZ from "../../../shared/routing/snippets/request-parameters/_returnZ.mdx"
import OutputGeometryPrecision from "../../../shared/routing/snippets/request-parameters/_RouteLineSimplificationTolerance-JR-OnE.mdx"
import OutputGeometryPrecisionUnits from "../../../shared/routing/snippets/request-parameters/_OutputGeometryPrecisionUnits.mdx"
import GeometryPrecision from "../../../shared/routing/snippets/request-parameters/_GeometryPrecision.mdx"
import GeometryPrecisionM from "../../../shared/routing/snippets/request-parameters/_GeometryPrecisionM.mdx"
import GeometryPrecisionZ from "../../../shared/routing/snippets/request-parameters/_GeometryPrecisionZ.mdx"
import PreserveObjectID from "../../../shared/routing/snippets/request-parameters/_PreserveObjectID.mdx"
import ReturnEmptyResults from "../../../shared/routing/snippets/request-parameters/_ReturnEmptyResults.mdx"
import LocateSetting from "../../../shared/routing/snippets/request-parameters/_LocateSettings.mdx"
import Contxt from "../../../shared/routing/snippets/request-parameters/_Context.mdx"
import ReturnFacility from "../../../shared/routing/snippets/request-parameters/_CF-returnFacilities.mdx"
import ReturnIncidents from "../../../shared/routing/snippets/request-parameters/_CF-returnIncidents.mdx"
import TimeOfDayUTC from "../../../shared/routing/snippets/request-parameters/_Direct-timeOfDayIsUTC.mdx"
import RestrictUTurns from "../../../shared/routing/snippets/request-parameters/_UTurnAtJunctions.mdx"
import ConfigureLimits from "../../../shared/routing/snippets/request-parameters/_configureLimits.mdx"
import OutputRoute from "../../../shared/routing/snippets/output-parameters/_CF-outputRoutes.mdx"
import OutputFacilities from "../../../shared/routing/snippets/output-parameters/_CF-outputCFandFacilities.mdx"
import OutputIncidents from "../../../shared/routing/snippets/output-parameters/_CF-outputIncidents.mdx"
import Directions from "../../../shared/routing/snippets/output-parameters/_outputDirections.mdx"
import ResultFile from "../../../shared/routing/snippets/output-parameters/_resultFile.mdx"
import OutputNetworkAnalysisLayer from "../../../shared/routing/snippets/output-parameters/_outputNetworkAnalysisLayer.mdx"
import OutputRouteData from "../../../shared/routing/snippets/output-parameters/_outRouteData.mdx"
import CostUsage from "../../../shared/routing/snippets/output-parameters/_UsageCost.mdx"
import Direction from "../../../shared/routing/snippets/output-parameters/_outputDirections.mdx"
import DirectionLine from "../../../shared/routing/snippets/output-parameters/_outputDirectionLines.mdx"
import DirectionPoint from "../../../shared/routing/snippets/output-parameters/_outputDirectionPoints.mdx"
import OutputBarriers from "../../../shared/routing/snippets/output-parameters/_barriers.mdx"
import OutputPolylineBarriers from "../../../shared/routing/snippets/output-parameters/_polylineBarriers.mdx"
import OutputPolygonBarriers from "../../../shared/routing/snippets/output-parameters/_polygonBarriers.mdx"
import TraversedEdges from "../../../shared/routing/snippets/output-parameters/_traversedEdges.mdx"
import TraversedJunctions from "../../../shared/routing/snippets/output-parameters/_traversedJunctions.mdx"
import TraversedTurns from "../../../shared/routing/snippets/output-parameters/_traversedTurns.mdx"
import SolveSucceeded from "../../../shared/routing/snippets/output-parameters/_SolveSucceeded.mdx"
import UsageCost from "../../../shared/routing/snippets/output-parameters/_UsageCost.mdx"
import SharedContent from "../../../shared/content/_required-params"
import ParamMetadata from "../../../shared/components/param-metatdata"
Publish using publish routing services
Publish using ArcGIS Pro
If you publish routing services using [configure routing services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-routing-services.htm) dialog box from ArcGIS Enterprise portal website, or publish using [publish routing services](https://enterprise.arcgis.com/en/server/latest/develop/windows/publishing-routing-services.htm) command line utility, use the following endpoint to access the /solveClosestFacility direct request. The `{{folderName}}` represents the folder in which the services are being published.
{`GET https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{folderName}}/NetworkAnalysis/NAServer/ClosestFacility/solveClosestFacility`}
{`POST https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{folderName}}/NetworkAnalysis/NAServer/ClosestFacility/solveClosestFacility`}
If you publish routing services using [ArcGIS Pro](https://pro.arcgis.com/en/pro-app/latest/help/analysis/networks/publish-standard-routing-services.htm), use the following endpoint to access the /solveClosestFacility direct request. The `{{serviceName}}` represents the name of the routing services published from ArcGIS Pro. The `{{layerName}}` is the closest facility layer's name in the map used to publish the routing service.
{`GET https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{serviceName}}/NAServer/{{layerName}}/solveClosestFacility`}
{`POST https://{{machineName}}/{{serverWebAdaptorName}}/rest/services/{{serviceName}}/NAServer/{{layerName}}/solveClosestFacility`}
## Parameters
[f](#f)
string
The request response format, either `json` or `pjson`
[token](#token)
string
An access token with the [required privileges](#token).
[incidents](#incidents)
locations | feature | layer
One or more locations from which the nearby locations are searched.
[facilities](#facilities)
locations | feature | layer
One or more locations that are searched for when finding the closest location.
[returnCFRoutes](#returncfroutes)
string
`false`
Return routes.
[travelMode](#travelmode)
object
The mode of transportation for the analysis provided as a JSON object.
[defaultTargetFacilityCount](#defaulttargetfacilitycount)
string
The number of closest facilities to find per incident.
[travelDirection](#traveldirection)
string
`esriNATravelDirectionToFacility`
Search for the closest facility as measured from the incident to the facility or from the facility to the incident.
[defaultCutoff](#defaultcutoff)
number
`null`
The travel time or travel distance value at which to stop searching for facilities for a given incident.
[timeOfDay](#timeofday)
string
The time and date to depart from or arrive at incidents or facilities.
[timeOfDayIsUTC](#timeofdayisutc)
boolean
`false`
The time zone or zones of the `timeOfDay` parameter.
[timeOfDayUsage](#timeofdayusage)
string
`esriNATimeOfDayUseAsStartTime`
Specifies whether the `timeOfDay` parameter value represents the arrival or departure time for the routes.
[restrictUTurns](#restrictuturns)
string
`esriNFSBAtDeadEndsAndIntersections`
Restricts or allows a route to make U-turns at junctions.
[useHierarchy](#usehierarchy)
boolean
`true`
Hierarchy used when finding the shortest paths.
[impedanceAttributeName](#impedanceattributename)
string
`TravelTime`
Type of impedance.
[accumulateAttributeNames](#accumulateattributenames)
string
`Miles,Kilometers`
Accumulates values other than the value set in the `impedanceAttributeName` parameter.
[restrictionAttributeNames](#restrictionattributenames)
string
The restrictions that should be honored.
[attributeParameterValues](#attributeparametervalues)
[object]
Additional values required by an attribute or restriction.
[barriers](#barriers)
locations | feature | layer
One or more points that act as temporary restrictions, additional time, or distance.
[polylineBarriers](#polylinebarriers)
feature | layer
One ore more lines that prohibit travel anywhere the lines intersect the streets.
[polygonBarriers](#polygonbarriers)
feature | layer
Polygons that either prohibit travel or proportionately scale the time or distance required to travel on the streets.
[returnDirections](#returndirections)
boolean
`false`
Generates the driving directions for each route.
[directionsLanguage](#directionslanguage)
string
`en`
The language used when generating driving directions.
[directionsOutputType](#directionsoutputtypes)
string
`esriDOTStandard`
The content and length of the driving directions. Used if `returnDirections=true`.
[directionsStyleName](#directionsstylename)
string
`NA Desktop`
The formatting style for the directions. Used if `returnDirections=true`.
[directionsLengthUnits](#directionslengthunits)
string
`esriNAUMiles`
The units to display the travel distance in driving directions. Used if`returnDirections=true`.
[directionsTimeAttributeName](#directionstimeattributename)
string
`TravelTime`
The time-based impedance attribute to display the duration of a maneuver.
[outputLines](#outputlines)
string
`esriNAOutputLineTrueShape`
The type of route features that are returned.
[returnFacilities](#returnfacilities)
boolean
`true`
Returns facilities.
[returnIncidents](#returnincidents)
boolean
`true`
Returns incidents.
[returnBarriers](#returnbarriers)
boolean
`false`
Returns barriers.
[returnPolylineBarriers](#returnpolylinebarriers)
boolean
`false`
Returns polyline barriers.
[returnPolygonBarriers](#returnpolygonbarriers)
boolean
`false`
Returns polygon barriers.
[returnTraversedEdges](#returntraversededges)
boolean
`false`
Returns traversed edges.
[returnTraversedJunctions](#returntraversedjunctions)
boolean
`false`
Returns traversed junctions.
[returnTraversedTurns](#returntraversedturns)
boolean
`false`
Returns traversed turns.
[returnZ](#returnz)
string
Include the z-values for the returned geometries if supported by the underlying network.
[ignoreInvalidLocations](#ignoreinvalidlocations)
boolean
`true`
Ignores invalid input locations.
[context](#context)
string
Additional settings that affect task operation
[outputGeometryPrecision](#outputgeometryprecision)
number
`10`
Simplifies route geometry.
[outputGeometryPrecisionUnits](#outputgeometryprecisionunits)
string
`esriMeters`
The units for the value in the `outputGeometryPrecision` parameter.
[geometryPrecision](#geometryprecision)
integer
The number of decimal places in the response geometries. Applies to x and y values only.
[geometryPrecisionM](#geometryprecisionm)
string
The number of decimal places in the response geometries. Applies to m-values only.
[geometryPrecisionZ](#geometryprecisionz)
string
The number of decimal places in the response geometries. Applies to z-values only.
[overrides](#overrides)
string
For internal use only.
[preserveObjectID](#preserveobjectid)
boolean
`false`
Preserves the object IDs from input locations when the input locations are returned as output.
[returnEmptyResults](#returnemptyresults)
boolean
`false`
Returns empty results instead of the error property when a request fails.
[locateSettings](#locatesettings)
object
Determines how input data are located.
All the default parameter values mentioned above are assuming that the routing service is published with default settings. If you publish routing services using [ArcGIS Pro](https://pro.arcgis.com/en/pro-app/latest/help/analysis/networks/publish-standard-routing-services.htm#ESRI_SECTION1_61BF401948C74301AF09F7D5D0E6FA35), you can change the default on the network analysis layer before publishing the service. If you publish routing services using [configure routing services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-routing-services.htm) dialog box from ArcGIS Enterprise portal website, or publish using [publish routing services](https://enterprise.arcgis.com/en/server/latest/develop/windows/publishing-routing-services.htm) command line utility, the default values can be changed through the publish routing services [configuration file](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-routing-service-config-file.htm), and you can apply the configuration file while publishing the routing services.
## Required parameters
### f
### token
### incidents
### facilities
## Optional parameters
### returnCFRoutes
Specify whether the request will return routes.
- `true`—Routes are returned. The routes are available in the [`routes`](#routes) property of the JSON response. The shape of the routes depends on the value for the `outputLines` parameter.
- `false`—Routes are not returned.
To return the best routes between the incident and the closest facilities, specify `true` for this parameter. If you also want the request to return the point features representing the closest facilities from the incidents, specify the `returnFacilities` parameter as `true`.
If you don't want to return routes because the application has to display only the driving directions between the stops, you can set the `returnDirections` parameter to `true` and the `returnCFRoutes` parameter to `false`. In this case, returning the routes will not provide any additional information and will increase the overall response size.
### travelMode
### travelDirection
### defaultTargetFacilityCount
### defaultCutoff
### timeOfDay
### timeOfDayIsUTC
### timeOfDayUsage
{/* type:enumdefault:`esriNATimeOfDayUseAsStartTime`
*/}
**Allowed values:** `esriNATimeOfDayUseAsStartTime`, `esriNATimeOfDayUseAsEndTime`
The `timeOfDayUsage` parameter value represents the arrival or departure time for the routes. This parameter can be specified using the following values:
- `esriNATimeOfDayUseAsStartTime`—The request finds the best route considering the `timeOfDay` parameter value as the departure time from the facility or incident.
- `esriNATimeOfDayUseAsEndTime`—The request considers the `timeOfDay` parameter value as the arrival time at the facility or incident. This value is useful if you want to know what time to depart from a location so that you arrive at the destination at the time specified in `timeOfDay`.
The parameter value is ignored if the `timeOfDay` parameter value is `none`.
### useHierarchy
### restrictUTurns
### impedanceAttributeName
### accumulateAttributeNames
### restrictionAttributeNames
### attributeParameterValues
### barriers
### polylineBarriers
### polygonBarriers
### returnDirections
### directionsLanguage
### directionsOutputType
### directionsStyleName
### directionsLengthUnits
### directionsTimeAttributeName
### outputLines
### returnFacilities
### returnIncidents
### returnBarriers
### returnPolylineBarriers
### returnPolygonBarriers
### returnTraversedEdges
### returnTraversedJunctions
### returnTraversedTurns
### returnZ
### ignoreInvalidLocations
### outSR
### outputGeometryPrecision
### outputGeometryPrecisionUnits
### geometryPrecision
### geometryPrecisionM
### geometryPrecisionZ
### overrides
### preserveObjectID
### returnEmptyResults
### locateSettings
## Response objects
The JSON response from the closest facility request is based on the following syntax. The actual properties returned in the response depend upon the request parameters. For example, the routes property is returned only if the `returnCFRoutes` parameter is set to `true` . If a request fails, the JSON response only contains the error property.
For a list of error codes and details, go to [Direct request error codes](/naserver-error-codes)
The examples in the subsequent section illustrate the response returned with specific request parameters.
On successful completion, the request returns the best route and travel directions between the incident and the chosen facility and the status indicating whether the analysis was successful using the following response objects:
### routes
### facilities
### incidents
### barriers
### polylineBarriers
### polygonBarriers
### traversedEdges
### traversedJunctions
### traversedTurns
### directions
### directionPoints
### directionLines
## Examples
To build client application [see API reference examples](DEVSITE/documentation/mapping-and-location-services/routing-and-directions/closest-facility-routing/#direct-find-closest-grocery-stores)
Below is an example of the request on how to find the closest facility near an incident.
If you copy and paste the request URL from the examples into a web browser, you need to replace `` with a valid token. See [Security and authentication](DEVSITE/documentation/security-and-authentication/) to learn more.
### Find closest facility fire stations
This example shows how to find the two fire stations that can provide the quickest response to a fire at a given incident location within three minutes. You will also generate routes and driving directions for the firefighters.
Specify the four fire stations in the area as the `facilities` parameter. Use the JSON structure to specify the facilities parameter, as you want to specify the name of the fire station that can be used by the request when generating driving directions for the routes from the fire stations. The geometries are in the default spatial reference WGS84. Therefore, the spatialReference property is not specified.
Specify the longitude and latitude value for the fire location as the `incidents` parameter.
Since you need to find the two closest fire stations, specify `2` as the value for the `defaultTargetFacilityCount` parameter. To model the fire engines traveling from the stations to the fire (incident), specify `esriNATravelDirectionFromFacility` as the value for the `travelDirection` parameter. You need to search for fire stations that are within three minutes of the fire, so specify `3` as the value for the `defaultCutoff` parameter. Any fire stations outside the cutoff time are ignored by the request.
Because you need to generate driving directions and report the distance information within the directions in miles, specify the `returnDirections` parameter as `true` and the `directionsLengthUnits` parameter as `esriNAUMiles`. To get the route geometries, specify the `returnCFRoutes` parameter as `true`. Specify `102100` as the value for the `outSR` parameter so that the output routes are returned in the Web Mercator spatial reference and can be displayed on top of an ArcGIS Online basemap.
Request
Response
The response contains two route features representing the best route to travel from the two closest fire stations to the incident. The response includes the `routes` and `directions` properties because the `returnCFRoutes` and `returnDirections` parameters are set to `true` in the request.
Because the response is quite verbose, the repeated elements within the response are abbreviated for clarity.
## Service limits