TicketmasterClient
Classes
dataclass
EventsGetResponse(*, links: Optional[Dict[str, Any]] = None, embedded: Optional[Dict[str, Any]] = None, page: Optional[Dict[str, Any]] = None)
Response for Event search
dataclass
EventGetResponse(*, embedded: Optional[Dict[str, Any]] = None, links: Optional[Dict[str, Any]] = None, classifications: Optional[List[Dict[str, Any]]] = None, dates: Optional[Dict[str, Any]] = None, id: Optional[str] = None, images: Optional[List[Dict[str, Any]]] = None, locale: Optional[str] = None, name: Optional[str] = None, please_note: Optional[str] = None, price_ranges: Optional[List[Dict[str, Any]]] = None, promoter: Optional[Dict[str, Any]] = None, sales: Optional[Dict[str, Any]] = None, test: Optional[bool] = None, type_: Optional[str] = None, url: Optional[str] = None)
Response for Get event details
Attributes
class-attribute
instance-attribute
The identifier.
class-attribute
instance-attribute
The locale.
class-attribute
instance-attribute
The name.
class-attribute
instance-attribute
please_note: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pleaseNote'})
The please note.
class-attribute
instance-attribute
Whether test.
class-attribute
instance-attribute
The type.
dataclass
EventImagesGetResponse(*, type_: Optional[str] = None, id: Optional[str] = None, images: Optional[List[Dict[str, Any]]] = None, links: Optional[Dict[str, Any]] = None)
Response for Get event images
dataclass
AttractionsGetResponse(*, links: Optional[Dict[str, Any]] = None, embedded: Optional[Dict[str, Any]] = None, page: Optional[Dict[str, Any]] = None)
Response for Attraction search
dataclass
AttractionGetResponse(*, name: Optional[str] = None, type_: Optional[str] = None, id: Optional[str] = None, test: Optional[bool] = None, locale: Optional[str] = None, images: Optional[List[Dict[str, Any]]] = None, classifications: Optional[List[Dict[str, Any]]] = None, links: Optional[Dict[str, Any]] = None)
Response for Get attraction details
Attributes
class-attribute
instance-attribute
The name.
class-attribute
instance-attribute
The type.
class-attribute
instance-attribute
The identifier.
class-attribute
instance-attribute
Whether test.
dataclass
ClassificationsGetResponse(*, links: Optional[Dict[str, Any]] = None, embedded: Optional[Dict[str, Any]] = None, page: Optional[Dict[str, Any]] = None)
Response for Classification search
dataclass
ClassificationGetResponse(*, links: Optional[Dict[str, Any]] = None, segment: Optional[Dict[str, Any]] = None)
Response for Get classification details
dataclass
dataclass
dataclass
SubGenreGetResponse(*, links: Optional[Dict[str, Any]] = None, id: Optional[str] = None, name: Optional[str] = None, locale: Optional[str] = None)
Response for Get sub-genre details
Attributes
class-attribute
instance-attribute
The identifier.
class-attribute
instance-attribute
The name.
dataclass
VenuesGetResponse(*, embedded: Optional[Dict[str, Any]] = None, links: Optional[Dict[str, Any]] = None, page: Optional[Dict[str, Any]] = None)
Response for Venue search
dataclass
VenueGetResponse(*, name: Optional[str] = None, type_: Optional[str] = None, id: Optional[str] = None, test: Optional[bool] = None, locale: Optional[str] = None, postal_code: Optional[str] = None, timezone: Optional[str] = None, city: Optional[Dict[str, Any]] = None, state: Optional[Dict[str, Any]] = None, country: Optional[Dict[str, Any]] = None, address: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None, markets: Optional[List[Dict[str, Any]]] = None, links: Optional[Dict[str, Any]] = None)
Response for Get venue details
Attributes
class-attribute
instance-attribute
The name.
class-attribute
instance-attribute
The type.
class-attribute
instance-attribute
The identifier.
class-attribute
instance-attribute
Whether test.
class-attribute
instance-attribute
The locale.
dataclass
SuggestionsGetResponse(*, links: Optional[Dict[str, Any]] = None, embedded: Optional[Dict[str, Any]] = None)
Response for Find suggestions
TicketmasterClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for ticketmaster connector.
Initialize a TicketmasterClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
events_get(*, size: Optional[int] = None, id: Optional[str] = None, keyword: Optional[str] = None, attraction_id: Optional[str] = None, venue_id: Optional[str] = None, postal_code: Optional[str] = None, latlong: Optional[str] = None, radius: Optional[str] = None, unit: Optional[str] = None, source: Optional[str] = None, locale: Optional[str] = None, market_id: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, include_t_b_a: Optional[str] = None, include_t_b_d: Optional[str] = None, include_test: Optional[str] = None, page: Optional[str] = None, sort: Optional[str] = None, onsale_start_date_time: Optional[str] = None, onsale_end_date_time: Optional[str] = None, city: Optional[List[str]] = None, country_code: Optional[str] = None, state_code: Optional[str] = None, classification_name: Optional[List[str]] = None, classification_id: Optional[List[str]] = None, dma_id: Optional[str] = None, local_start_date_time: Optional[List[str]] = None, local_start_end_date_time: Optional[List[str]] = None, start_end_date_time: Optional[List[str]] = None, public_visibility_start_date_time: Optional[List[str]] = None, pre_sale_date_time: Optional[List[str]] = None, onsale_on_start_date: Optional[str] = None, onsale_on_after_start_date: Optional[str] = None, collection_id: Optional[List[str]] = None, segment_id: Optional[List[str]] = None, segment_name: Optional[List[str]] = None, include_family: Optional[str] = None, promoter_id: Optional[str] = None, genre_id: Optional[List[str]] = None, sub_genre_id: Optional[List[str]] = None, type_id: Optional[List[str]] = None, sub_type_id: Optional[List[str]] = None, geo_point: Optional[str] = None, preferred_country: Optional[str] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Event search
Find events and filter your search by location, date, availability, and much more.
Swagger operation ID: EventsGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
size
|
Optional[int]
|
The page size of the response. |
None
|
id
|
Optional[str]
|
The filter for entities by their identifier. |
None
|
keyword
|
Optional[str]
|
The keyword to search on. |
None
|
attraction_id
|
Optional[str]
|
The filter by attraction identifier. |
None
|
venue_id
|
Optional[str]
|
The filter by venue identifier. |
None
|
postal_code
|
Optional[str]
|
The filter by postal code or zipcode. |
None
|
latlong
|
Optional[str]
|
The filter for events by latitude and longitude. This filter is deprecated and may be removed in a future release, please use geoPoint instead. |
None
|
radius
|
Optional[str]
|
The radius of the area in which we want to search for events. |
None
|
unit
|
Optional[str]
|
The unit of the radius. |
None
|
source
|
Optional[str]
|
The filter for entities by their primary source name or publishing source name. |
None
|
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
market_id
|
Optional[str]
|
The filter by market identifier. |
None
|
start_date_time
|
Optional[str]
|
The filter with a start date after this date. |
None
|
end_date_time
|
Optional[str]
|
The filter with a start date before this date. |
None
|
include_t_b_a
|
Optional[str]
|
Indicates whether to include events with date to be announced (TBA). |
None
|
include_t_b_d
|
Optional[str]
|
Indicates whether to include events with a date to be defined (TBD). |
None
|
include_test
|
Optional[str]
|
Indicates whether to include entities flagged as test in the response. |
None
|
page
|
Optional[str]
|
The page number. |
None
|
sort
|
Optional[str]
|
The sorting order of the search result. |
None
|
onsale_start_date_time
|
Optional[str]
|
The filter with onsale start date after this date. |
None
|
onsale_end_date_time
|
Optional[str]
|
The filter with onsale end date before this date. |
None
|
city
|
Optional[List[str]]
|
The filter by city. |
None
|
country_code
|
Optional[str]
|
The filter by country code. |
None
|
state_code
|
Optional[str]
|
The filter by state code. |
None
|
classification_name
|
Optional[List[str]]
|
The filter by classification name: name of any segment, genre, sub-genre, type, sub-type. |
None
|
classification_id
|
Optional[List[str]]
|
The filter by classification identifier: identifier of any segment, genre, sub-genre, type, sub-type. |
None
|
dma_id
|
Optional[str]
|
The filter by DMA identifier. |
None
|
local_start_date_time
|
Optional[List[str]]
|
The filter with event local start date time within this range. |
None
|
local_start_end_date_time
|
Optional[List[str]]
|
The filter for events where event local start and end date overlap this range. |
None
|
start_end_date_time
|
Optional[List[str]]
|
The filter for events where event start and end date overlap this range. |
None
|
public_visibility_start_date_time
|
Optional[List[str]]
|
The filter for events with public visibility starting. |
None
|
pre_sale_date_time
|
Optional[List[str]]
|
The filter for events with a presale start and end that intersects with this range. |
None
|
onsale_on_start_date
|
Optional[str]
|
The filter with onsale start date on this date. |
None
|
onsale_on_after_start_date
|
Optional[str]
|
The filter with onsale range within this date. |
None
|
collection_id
|
Optional[List[str]]
|
The filter by collection identifier. |
None
|
segment_id
|
Optional[List[str]]
|
The filter by segment identifier. |
None
|
segment_name
|
Optional[List[str]]
|
The filter by segment name. |
None
|
include_family
|
Optional[str]
|
The filter by classification that are family-friendly. |
None
|
promoter_id
|
Optional[str]
|
The filter by promoter identifier. |
None
|
genre_id
|
Optional[List[str]]
|
The filter by genre identifier. |
None
|
sub_genre_id
|
Optional[List[str]]
|
The filter by sub-genre identifier. |
None
|
type_id
|
Optional[List[str]]
|
The filter by type identifier. |
None
|
sub_type_id
|
Optional[List[str]]
|
The filter by sub-type identifier. |
None
|
geo_point
|
Optional[str]
|
The filter for events by geoHash. |
None
|
preferred_country
|
Optional[str]
|
The popularity boost by country, default is us. |
None
|
include_spellcheck
|
Optional[str]
|
Indicates whether to include spell check suggestions in the response. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
event_get(id: str, *, locale: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get event details
Get details for a specific event using the unique identifier for the event. This includes the venue and location, the attraction(s), and the Ticketmaster Website URL for purchasing tickets for the event
Swagger operation ID: EventGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier for the event. |
required |
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
event_images_get(id: str, *, locale: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get event images
Get images for a specific event using the unique identifier for the event.
Swagger operation ID: EventImagesGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier for the event. |
required |
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
attractions_get(*, id: Optional[str] = None, keyword: Optional[str] = None, source: Optional[str] = None, locale: Optional[str] = None, include_test: Optional[str] = None, size: Optional[str] = None, page: Optional[str] = None, sort: Optional[str] = None, classification_name: Optional[List[str]] = None, classification_id: Optional[List[str]] = None, include_family: Optional[str] = None, segment_id: Optional[List[str]] = None, genre_id: Optional[List[str]] = None, sub_genre_id: Optional[List[str]] = None, type_id: Optional[List[str]] = None, sub_type_id: Optional[List[str]] = None, country_code: Optional[str] = None, preferred_country: Optional[str] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Attraction search
Find attractions (artists, sports, packages, plays and so on) and filter your search by name, and much more.
Swagger operation ID: AttractionsGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
Optional[str]
|
The filter for entities by their identifier. |
None
|
keyword
|
Optional[str]
|
The keyword to search on. |
None
|
source
|
Optional[str]
|
The filter for entities by their primary source name or publishing source name. |
None
|
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
include_test
|
Optional[str]
|
Indicates whether to include entities flagged as test in the response. |
None
|
size
|
Optional[str]
|
The page size of the response. |
None
|
page
|
Optional[str]
|
The page number. |
None
|
sort
|
Optional[str]
|
The sorting order of the search result. |
None
|
classification_name
|
Optional[List[str]]
|
The filter for attractions by classification name. |
None
|
classification_id
|
Optional[List[str]]
|
The filter for attractions by classification identifier. |
None
|
include_family
|
Optional[str]
|
The filter by classification that are family-friendly. |
None
|
segment_id
|
Optional[List[str]]
|
The filter for attractions by segment identifier. |
None
|
genre_id
|
Optional[List[str]]
|
The filter for attractions by genre identifier. |
None
|
sub_genre_id
|
Optional[List[str]]
|
The filter for attractions by sub-genre identifier. |
None
|
type_id
|
Optional[List[str]]
|
The filter for attractions by type identifier. |
None
|
sub_type_id
|
Optional[List[str]]
|
The filter for attractions by sub-type identifier. |
None
|
country_code
|
Optional[str]
|
The filter for attractions by country code. |
None
|
preferred_country
|
Optional[str]
|
The popularity boost by country, default is us. |
None
|
include_spellcheck
|
Optional[str]
|
Indicates whether to include spell check suggestions in the response. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
attraction_get(id: str, *, locale: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get attraction details
Get details for a specific attraction using the unique identifier for the attraction.
Swagger operation ID: AttractionGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier for the attraction. |
required |
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
classifications_get(*, id: Optional[str] = None, keyword: Optional[str] = None, source: Optional[str] = None, locale: Optional[str] = None, include_test: Optional[str] = None, size: Optional[str] = None, page: Optional[str] = None, sort: Optional[str] = None, country_code: Optional[str] = None, preferred_country: Optional[str] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Classification search
Find classifications and filter your search by name, and much more. Classifications help define the nature of attractions and events.
Swagger operation ID: ClassificationsGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
Optional[str]
|
The filter for entities by their identifier. |
None
|
keyword
|
Optional[str]
|
The keyword to search on. |
None
|
source
|
Optional[str]
|
The filter for entities by their primary source name or publishing source name. |
None
|
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
include_test
|
Optional[str]
|
Indicates whether to include entities flagged as test in the response. |
None
|
size
|
Optional[str]
|
The page size of the response. |
None
|
page
|
Optional[str]
|
The page number. |
None
|
sort
|
Optional[str]
|
The sorting order of the search result. |
None
|
country_code
|
Optional[str]
|
The filter for classifications by country code. |
None
|
preferred_country
|
Optional[str]
|
The popularity boost by country, default is us. |
None
|
include_spellcheck
|
Optional[str]
|
Indicates whether to include spell check suggestions in the response. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
classification_get(id: str, *, locale: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get classification details
Get details for a specific segment, genre, or sub-genre using its unique identifier.
Swagger operation ID: ClassificationGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier for the classification. |
required |
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
genre_get(id: str, *, locale: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get genre details
Get details for a specific genre using its unique identifier.
Swagger operation ID: GenreGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier for the genre. |
required |
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
segment_get(id: str, *, locale: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get segment details
Get details for a specific segment using its unique identifier.
Swagger operation ID: SegmentGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier for the segment. |
required |
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
sub_genre_get(id: str, *, locale: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get sub-genre details
Get details for a specific sub-genre using its unique identifier.
Swagger operation ID: SubGenreGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier for the sub-genre. |
required |
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
venues_get(*, id: Optional[str] = None, keyword: Optional[str] = None, latlong: Optional[str] = None, radius: Optional[str] = None, unit: Optional[str] = None, source: Optional[str] = None, locale: Optional[str] = None, include_test: Optional[str] = None, size: Optional[str] = None, page: Optional[str] = None, sort: Optional[str] = None, country_code: Optional[str] = None, state_code: Optional[str] = None, geo_point: Optional[str] = None, preferred_country: Optional[str] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Venue search
Find venues and filter your search by name, and much more.
Swagger operation ID: VenuesGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
Optional[str]
|
The filter for entities by their identifier. |
None
|
keyword
|
Optional[str]
|
The keyword to search on. |
None
|
latlong
|
Optional[str]
|
The filter for venues by latitude and longitude. This filter is deprecated and may be removed in a future release, please use geoPoint instead. |
None
|
radius
|
Optional[str]
|
The radius of the area in which we want to search for venues. |
None
|
unit
|
Optional[str]
|
The unit of the radius. |
None
|
source
|
Optional[str]
|
The filter for entities by their primary source name or publishing source name. |
None
|
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
include_test
|
Optional[str]
|
Indicates whether to include entities flagged as test in the response. |
None
|
size
|
Optional[str]
|
The page size of the response. |
None
|
page
|
Optional[str]
|
The page number. |
None
|
sort
|
Optional[str]
|
The sorting order of the search result. |
None
|
country_code
|
Optional[str]
|
The filter for venues by country code. |
None
|
state_code
|
Optional[str]
|
The filter by state / province code. |
None
|
geo_point
|
Optional[str]
|
The filter for venues by geoHash. |
None
|
preferred_country
|
Optional[str]
|
The popularity boost by country, default is us. |
None
|
include_spellcheck
|
Optional[str]
|
Indicates whether to include spell check suggestions in the response. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
venue_get(id: str, *, locale: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get venue details
Get details for a specific venue using the unique identifier for the venue.
Swagger operation ID: VenueGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier for the venue. |
required |
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
suggestions_get(*, keyword: Optional[str] = None, latlong: Optional[str] = None, radius: Optional[str] = None, unit: Optional[str] = None, source: Optional[str] = None, locale: Optional[str] = None, include_t_b_a: Optional[str] = None, include_t_b_d: Optional[str] = None, include_test: Optional[str] = None, size: Optional[str] = None, country_code: Optional[str] = None, segment_id: Optional[List[str]] = None, geo_point: Optional[str] = None, resource: Optional[List[str]] = None, preferred_country: Optional[str] = None, start_end_date_time: Optional[List[str]] = None, local_start_end_date_time: Optional[List[str]] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Find suggestions
Find search suggestions and filter your suggestions by location, source, etc.
Swagger operation ID: SuggestionsGet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
keyword
|
Optional[str]
|
The keyword to search on. |
None
|
latlong
|
Optional[str]
|
The filter for events by latitude and longitude. This filter is deprecated and may be removed in a future release, please use geoPoint instead. |
None
|
radius
|
Optional[str]
|
The radius of the area in which we want to search for events. |
None
|
unit
|
Optional[str]
|
The unit of the radius. |
None
|
source
|
Optional[str]
|
The filter for entities by their primary source name or publishing source name. |
None
|
locale
|
Optional[str]
|
The locale in ISO code format. Multiple comma-separated values can be provided. |
None
|
include_t_b_a
|
Optional[str]
|
Indicates whether to include events with date to be announced (TBA). Defaults to no if date parameter sent, yes otherwise. |
None
|
include_t_b_d
|
Optional[str]
|
Indicates whether to include events with a date to be defined (TBD). Defaults to no if date parameter sent, yes otherwise. |
None
|
include_test
|
Optional[str]
|
Indicates whether to include entities flagged as test in the response. |
None
|
size
|
Optional[str]
|
Size of every entity returned in the response. |
None
|
country_code
|
Optional[str]
|
The filter suggestions by country code. |
None
|
segment_id
|
Optional[List[str]]
|
The filter suggestions by segment identifier. |
None
|
geo_point
|
Optional[str]
|
The filter for events by geoHash. |
None
|
resource
|
Optional[List[str]]
|
Which resources to include in the suggest response, defaults to all resources. |
None
|
preferred_country
|
Optional[str]
|
The popularity boost by country, default is us. |
None
|
start_end_date_time
|
Optional[List[str]]
|
The filter for events where event start and end date overlap this range. |
None
|
local_start_end_date_time
|
Optional[List[str]]
|
The filter for events where event local start and end date overlap this range. |
None
|
include_spellcheck
|
Optional[str]
|
Indicates whether to include spell check suggestions in the response. |
None
|
domain
|
Optional[List[str]]
|
The filter for entities based on domains they are available on. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |