IGetGeographyOptions

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )

Limits the number of features that are returned from the geographyQuery parameter.

Starts the results on the number of the records specified.

Integer that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers.

Specify which IDs for the standard geography layers are being queried or searched.

Specify which standard geography layers are being queried or searched.

Specify the text to query and search the standard geography layers specified.

Additional Headers to pass into the request.

Type declaration

• [key: string]: any

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

The HTTP method to send the request with.

Specifies the language you wish to receive your GeoEnrichment results.

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

Specify a specific dataset within a defined country.

Request the output geometries in a specified spatial reference system.

Additional parameters to pass in the request.

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

Return the raw response

Request the output geometry to return the center point for each feature.

Request the output geometries in the response.

Return all the subgeographic areas that are within a parent geography.

An AbortSignal object instance; allows you to abort a request and via an AbortController.

Specify the source country for the search.

Return all the subgeographic areas that are within a parent geography.

Filter the results of the subgeography features that are returned by a search term.

Suppress any ArcGIS REST JS related warnings for this request.

Define if text provided in the geographyQuery parameter should utilize fuzzy search logic.