listings: Listings Search

URL:: https://[root]/content/listings
Methods:: GET
Child Resources:: Listing

Example usage

URL for Listings Search:

Use dark colors for code blocksCopy
https://www.arcgis.com/sharing/rest/content/listings?q=park

Description

This operation searches for marketplace listings. The searches are performed against a high performance index that indexes the most popular fields of a listing. See the Search reference page for information on the fields and the syntax of the query.

By default, this search spans all public listings in the marketplace. However, if you're logged in as a vendor org admin and you specify the mylistings=true parameter, it then searches all public and private listings in your organization.

Request parameters

Parameter	Details
`[Common Parameters]`	For a complete listing, see Common parameters.
`q`	Description: The query string to use to search. See Search reference. Example: Use dark colors for code blocksCopy `1 q=redlands+map`
`mylistings`	Description: If `true` and you are logged in as a vendor org admin, it searches all public and private listings in your organization. Note that if `mylistings=true`, the `q` parameter is optional. Values: `false` (default) \| `true`
`start`	Description: The number of the first entry in the result set response. The index number is 1-based. The default value of `start` is `1`. (i.e., the first search result). The `start` parameter, along with the `num` parameter, can be used to paginate the search results. Example: Use dark colors for code blocksCopy `1 start=11 //Returns result #11 as the first entry in the response.`
`num`	Description: The maximum number of results to be included in the result set response. The default value is `10`, and the maximum allowed value is `100`. The `start` parameter, along with the `num` parameter, can be used to paginate the search results. Note that the actual number of returned results may be less than `num`. This happens when the number of results remaining after `start` is less than `num`. Example: Use dark colors for code blocksCopy `1 num=50 //Returns a max of 50 results in the response.`
`sortField`	Description: The field to sort by. You can also sort by multiple fields (comma separated) for listings, sort field names are case-insensitive. Supported sort field names are `title`, `created`, `listingpublisheddate`, `type`, `owner`, `avgrating`, `numratings`, `numcomments`, and `numviews`.
`sortOrder`	Description: Describes whether the order returns in ascending or descending order. Default is ascending. Values: `asc` \| `desc`

Response properties

Property	Details
`q`	Description: The query string searched.
`total`	Description: The total number of results found for the whole query. The number of query results is limited to 10000.
`start`	Description: The number of the first entry in the result set for this response. The index number is 1-based.
`num`	Description: The number of results included in the result set for this response.
`nextStart`	Description: The next entry index if the current result set doesn't contain all results.
`listings`	Description: A JSON array of listing objects. See the response properties of a listing.

JSON Response syntax

Use dark colors for code blocksCopy
{
  "query": "<query string>",
  "total": <total number of results>,
  "start": <results in first set>,
  "num": <number of results per page>,
  "nextStart": <result number of next page>,
  "listings": [
    {<listing1>},
    {<listing2>}
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "query": "test",
  "total": 1,
  "start": 1,
  "num": 1,
  "nextStart": -1,
  "listings": [
    {
      "itemId": "c23d34bea01946f0ba1f530dda4c142e",
      "licenseType": "free",
      "priceDesc": "Free",
      "creditsPerTransaction": 0,
      "listingAccess": "public",
      "trialSupported": false,
      "type": "Feature Service",
      "typeKeywords": [
        "Feature Service",
        "Hosted Service"
      ],
      "title": "Test Title",
      "description": "Test Description",
      "tags": [
        "test",
        "tag"
      ],
      "snippet": "Test Snippet",
      "thumbnail": "thumbnail/usa_counties.jpg",
      "appCategories": [],
      "industries": [],
      "languages": [],
      "largeThumbnail": "largethumbnail/pic.png",
      "banner": "banner/banner_data.jpg",
      "screenshots": ["screenshots/ss1.jpg"],
      "owner": "esri",
      "created": 1369959407000,
      "avgRating": 3.75,
      "numComments": 2,
      "numRatings": 7,
      "listingPublishedDate": 1503949100000,
      "vendor": {
        "id": "VLx4vrvwONglS8iz",
        "name": "Test Vendor Name",
        "description": "Test Vendor Description",
        "thumbnail": "thumbnail.png"
      }
    }
  ]
}