Search Venue
get
Search Venue
Resource URL
https://api.stubcloudprod.com/ partners/search/venues/v3/
Query Parameters
Name | Values | Description |
---|---|---|
id |
venue id to search |
|
q |
search by keyword |
|
name |
search by Venue name |
|
title |
search by the title of the venue |
|
address |
search by venue address (address1 only) |
|
city |
search by city in which venue is located |
|
state |
search by the name of the state in which venue is located |
|
country |
search by the name of the country in which venue is located |
|
postalCode |
search by the zipcode in which venue is located |
|
status |
The status of the venue. Valid statuses are: Active, Inactive, Deleted, Draft, Review, Closed, Restricted |
|
point |
spatial search by lat-lon and radius, data type is String, lat-long is concated using comma, e.g. point=34.7452778,-92.3275 |
|
radius |
spatial search by lat-lon and radius, data type is double. e.g. 20 or 32.1869 |
|
unit |
radius units, supported values: mi, km |
|
geoId |
one or more ancestor geo ids to search |
|
geoName |
oone or more ancestor geo name to search |
|
categoryId |
one or more ancestor category ids to search |
|
categoryName |
one of more ancestor category names to search |
|
start |
return results starting from the specified index. |
|
rows |
max results to return, max=500. |
|
sourceId |
Venue Provider. Supported values -1-All, 0-Unified,1-StubHub,2-Zvents,3-MediaNet,4-AMG |
|
hidden |
If need to include hidden venues, value will be true of false. true means include hidden venues |
|
sort |
**Optional Parameter**. A pair of space-separated tokens that specifies how the venues are sorted. - First token identifies property of the venue for sorting. For the first token, you can specify any one of the following properties: `name`, `distance`, `popularity`, `createdDate` , `eventCount` - Second token specifies the direction of the sort. For the second token, you can specify one of the following types - `asc` for ascending order, `desc` for descending order Syntax: `property asc` or `property desc` If you do not provide this parameter. the default is the listings are sorted by name in ascending order (`sort=name asc`) You can also sort multiple fields with a statement like this: `sort=name asc, popularity desc` Examples: - Single Value Sort: `sort=name desc` to sort the venue in their descending order of name. - Multiple Values Sort: `sort=name asc, popularity desc, eventCount asc` In this example, the parameters are sorted in the following order: - By name (in ascending order); - If any venue have the same name, then they are sorted by popularity (in descending order); - If any venue are identical in both name and popularity, then they are sorted by the eventCount (in ascending order). |
|
fieldList |
The list of fields to be displayed in the response. This parameter can be used if you would like to fetch only a subset of the default response. Allowed values are: numFound, id, status, name, description, url, location, timezone, address, geos, categories, distance, displayAttributes, popularities, eventCount, score, createdDate, catalogAttributes, aliasMatch |
Header Parameters
Name | Values | Description |
---|---|---|
Authorization
(required) |
To generate an access token, use the [generateToken API](https://developer.stubhub.com/oauth/apis/post/accesstoken). Note that you will need to add a 'Bearer ' prefix to your access token. Otherwise, you'll get an 'Invalid Access Token' error |
|
Accept
(required) |
application/json |
Request Body
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Response Error Details
-
HTTP CodeError CodeDescription
-
404404
Resource Not Found. If the requested entity is not available, this status is returned.
-
401401
Not authorized to access the listing
-
403403
Forbidden
-
400400
Bad request
Resource Summary |
|
Security |
|
Content Type |
application/json |
Category |
Search Venue |
Working...