Documentation / Venues
List venues
GET /v1/venuesFree key and upPaged, 50 a page
Arenas by part of the name or city, or by country.
GET
https://api.icehockeyapi.com/v1/venueshttps://api.icehockeyapi.com/v1/venues?per_page=3curl "https://api.icehockeyapi.com/v1/venues?per_page=3" \ -H "X-API-Key: YOUR_KEY"
200 OKExample answer from the data, 12 Oct
{
"data": [
{
"id": "vn_z3aeycdq",
"name": "1st Mariner Arena",
"city": null,
"country": null
},
{
"id": "vn_sw570grp",
"name": "1st Summit Arena",
"city": null,
"country": "North America"
},
{
"id": "vn_teghn2q1",
"name": "A3 Arena",
"city": null,
"country": "Sweden"
}
],
"meta": {
"count": 3,
"next_cursor": "eyJvIjozLCJuIjozfQ",
"page": 1,
"per_page": 3,
"total": 1122,
"total_pages": 374,
"next_page": 2,
"prev_page": null,
"plan": "Complete"
}
}Run works once the API is live; the code above works now.
Parameters
| Name | In | Type | What it does |
|---|---|---|---|
q | query | string | Part of the name or city |
country | query | string | A country. |
page | query | int | The page, from 1. |
per_page | query | int | Records a page, default 50, at most 200. |
cursor | query | string | meta.next_cursor from the previous answer. |
Returns
| Field | Type |
|---|---|
id | string |
name | string |
city | null |
country | null |