The Hub Search API lets you programmatically query, search and filter content published on an ArcGIS Hub such as datasets, maps and apps. It follows the OGC API – Records standard. You can search for content of various Hub resource types. Content in ArcGIS Hub is organized as catalogs, collections and items.
Use-cases
Some of the broad use-cases of the Search API are as follows:
- Search for content across a Hub site using keywords, tags, or item type.
- Find information about a site’s catalog and collections.
- Write precise queries using - filter expressions, e.g. type='Feature Service' AND access=public
- Get statistics via aggregations.
- Discover related items that match specified filters.
Endpoints
The Search API includes the following endpoints:
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/search/v1 | Provides links to the API definition, the conformance statements, and metadata about the coverage data in this dataset. |
| GET | /conformance | Returns the conformance specifications the API meets. |
| GET | /catalog | Provides information about the site and its catalog of organized resources and collections. |
| GET | /collections | Lists the collections described in the site's catalog. |
| GET | /collections/{collection | Retrieves the collection from a site's catalog with a provided ID/key. |
| GET | /collections/{collection | Lists the minimal item properties expected to be returned when searching for items in the specified collection. |
| GET | /collections/{collection | Returns requested aggregations from the specified site catalog collection. |
| GET | /collections/{collection | Returns items from the specified site catalog collection that match specified filters. |
| GET | /collections/{collection | Fetches a single item by ID. |
| GET | /collections/{collection | Returns related items to record from the specified site catalog collection that match specified filters. |
| GET | /collections/{collection | Returns connected items to record from the specified site catalog collection that match specified filters. |
Authentication
Endpoints require an ArcGIS login token to search private items. To learn more about authentication, see Authentication.