find_venue
Find Venue
Reads only.
Use this to turn a building's name, or a state and capacity range, into Ticker venue ids. Use get_venue_schedule instead for what is on at a venue you already have. Find venues and their Ticker venue ids. Give a NAME to resolve a building you can already name, or narrow the list by state, country and a capacity range to find the ones that fit, or both together. Returns city, state, country and how many upcoming events each venue holds, best name match first when a name was given and the directory's own order otherwise. This is the id resolver: call it first when a question names a building rather than an event, then pass the id it returns to get_venue_schedule or to screen_events. Venues are stored under their official name, so expand a nickname ("MSG") before searching. A venue with nothing upcoming is not returned at all. A capacity bound also drops every venue whose capacity is unknown, which is a third of them, so a capacity question returns the venues we can size and not the whole field.
Parameters
| Name | Type | Required | Default | Notes |
|---|---|---|---|---|
name | string | The venue name to look for, or part of it. Minimum two characters, e.g. "barclays", "Madison Square Garden". Optional when at least one of state, country, capacity_min or capacity_max is given. Up to 80 characters. | ||
state | string | Keep venues in this state or province, e.g. "TX". Matched against the same grouping key the venue directory orders by: the region code where the venue has one, its country code otherwise. Up to 120 characters. | ||
country | string | Keep venues in this country, by two-letter code, e.g. "US". Up to 120 characters. | ||
capacity_min | integer | Keep venues that hold at least this many people. Venues whose capacity is unknown are left out whenever either bound is given. From 0 to 1000000. | ||
capacity_max | integer | Keep venues that hold at most this many people. Venues whose capacity is unknown are left out whenever either bound is given. From 0 to 1000000. | ||
limit | integer | How many matches to return. Default 5, maximum 25. From 1 to 25. |